/*
 * Copyright (c) 2005-2016 Vincent Vandenschrick. All rights reserved.
 *
 *  This file is part of the Jspresso framework.
 *
 *  Jspresso is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Jspresso is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with Jspresso.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.jspresso.framework.application.backend.session.basic;

import java.security.Principal;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.TimeZone;

import javax.security.auth.Subject;

import org.jspresso.framework.security.SecurityHelper;
import org.jspresso.framework.util.gui.EClientType;
import org.jspresso.framework.application.backend.session.IApplicationSession;
import org.jspresso.framework.security.UserPrincipal;

/**
 * Basic implementation of an application session.
 *
 * @author Vincent Vandenschrick
 */
public class BasicApplicationSession implements IApplicationSession {

  private final Map<String, Object> customValues;
  private       Locale              locale;
  private       TimeZone            timeZone;
  private       Subject             subject;
  private       EClientType         clientType;
  private       String              clientPlatformName;
  private       String              clientPlatformVersion;

  /**
   * Constructs a new {@code BasicApplicationSession} instance.
   */
  public BasicApplicationSession() {
    customValues = new HashMap<>();
    clientType = EClientType.UNDEFINED;
  }

  /**
   * {@inheritDoc}
   *
   * @param key
   *     the key
   * @return the custom value
   */
  @Override
  public Object getCustomValue(String key) {
    return customValues.get(key);
  }

  /**
   * Gets the locale.
   *
   * @return the locale.
   */
  @Override
  public Locale getLocale() {
    return locale;
  }

  /**
   * {@inheritDoc}
   *
   * @return the principal
   */
  @Override
  public UserPrincipal getPrincipal() {
    if (subject != null) {
      for (Principal principal : subject.getPrincipals()) {
        if (principal instanceof UserPrincipal) {
          return (UserPrincipal) principal;
        }
      }
    }
    return null;
  }

  /**
   * Gets the owner.
   *
   * @return the owner.
   */
  @Override
  public Subject getSubject() {
    return subject;
  }

  /**
   * {@inheritDoc}
   *
   * @param key
   *     the key
   * @param value
   *     the value
   */
  @Override
  public void putCustomValue(String key, Object value) {
    customValues.put(key, value);
  }

  /**
   * Sets the locale.
   *
   * @param locale
   *     the locale to set.
   */
  @Override
  public void setLocale(Locale locale) {
    this.locale = locale;
  }

  /**
   * Sets the owner.
   *
   * @param subject
   *     the owner to set.
   */
  @Override
  public void setSubject(Subject subject) {
    this.subject = subject;
  }

  /**
   * Gets the customValues.
   *
   * @return the customValues.
   */
  @Override
  public Map<String, Object> getCustomValues() {
    // return a defensive copy
    return new HashMap<>(customValues);
  }

  /**
   * Gets the timeZone.
   *
   * @return the timeZone.
   */
  public TimeZone getTimeZone() {
    return timeZone;
  }

  /**
   * Sets the timeZone.
   *
   * @param timeZone
   *     the timeZone to set.
   */
  public void setTimeZone(TimeZone timeZone) {
    this.timeZone = timeZone;
  }

  /**
   * {@inheritDoc}
   *
   * @return the id
   */
  @Override
  public String getId() {
    return Integer.toHexString(hashCode());
  }

  /**
   * {@inheritDoc}
   *
   * @return the username
   */
  @Override
  public String getUsername() {
    if (getPrincipal() != null) {
      return getPrincipal().getName();
    }
    return SecurityHelper.ANONYMOUS_USER_NAME;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void clear() {
    customValues.clear();
    locale = null;
    timeZone = null;
    subject = null;
    clientType = EClientType.UNDEFINED;
  }

  /**
   * Gets client type.
   *
   * @return the client type
   */
  @Override
  public EClientType getClientType() {
    return clientType;
  }

  /**
   * Sets client type.
   *
   * @param clientType
   *     the client type
   */
  @Override
  public void setClientType(EClientType clientType) {
    this.clientType = clientType;
  }

  /**
   * Gets client platform name.
   *
   * @return the client platform name
   */
  public String getClientPlatformName() {
    return clientPlatformName;
  }

  /**
   * Sets client platform name.
   *
   * @param clientPlatformName
   *     the client platform name
   */
  @Override
  public void setClientPlatformName(String clientPlatformName) {
    this.clientPlatformName = clientPlatformName;
  }

  /**
   * Gets client platform version.
   *
   * @return the client platform version
   */
  @Override
  public String getClientPlatformVersion() {
    return clientPlatformVersion;
  }

  /**
   * Sets client platform version.
   *
   * @param clientPlatformVersion
   *     the client platform version
   */
  @Override
  public void setClientPlatformVersion(String clientPlatformVersion) {
    this.clientPlatformVersion = clientPlatformVersion;
  }
}