WebSession.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: WebSession.java
 * Description: Class for handling session variables in the web
 */

/**
 * @file WebSession.java
 *
 * @brief Class for handling session variables in the web
 */

package cz.vutbr.fit.knot.annotations.web;

import cz.vutbr.fit.knot.annotations.app.Constants;
import cz.vutbr.fit.knot.annotations.documentCloner.DocClonerServer;
import cz.vutbr.fit.knot.annotations.entity.AnnotType;
import cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr;
import cz.vutbr.fit.knot.annotations.entity.DefaultSettings;
import cz.vutbr.fit.knot.annotations.entity.DrupAuthServer;
import cz.vutbr.fit.knot.annotations.entity.ServerSetting;
import cz.vutbr.fit.knot.annotations.entity.Settings;
import cz.vutbr.fit.knot.annotations.entity.TypeAttrOnto;
import cz.vutbr.fit.knot.annotations.entity.User;
import cz.vutbr.fit.knot.annotations.entity.UserGroup;
import cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope;
import cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.SubscribedItem;
import java.util.Iterator;

/**
 * Class for handling session variables in the web
 *
 * @brief Class for handling session variables in the web
 * @author idytrych
 */
public class WebSession {
  /**
   * Logged in user
   */
  private User loggedUser = null;

  /**
   * Edited user group
   */
  private UserGroup editedUG = null;
  /**
   * Edited user
   */
  private User editedUser = null;
  /**
   * Edited type of annotation
   */
  private AnnotType editedAT = null;
  /**
   * Edited attribute of type of annotation
   */
  private AnnotTypeAttr editedATA = null;
  /**
   * Edited attribute from ontology
   */
  private TypeAttrOnto editedTAO = null;
  /**
   * Selected type of annotation
   */
  private AnnotType selectedAT = null;
  /**
   * Selected user group
   */
  private UserGroup selectedUG = null;
  /**
   * Backup of form data
   */
  private Object formBackup = null;
  /**
   * Backup of second level form data
   */
  private Object secondFormBackup = null;
  /**
   * Identification of page from which user came
   */
  String cameFrom = null;
  /**
   * Edited Story Space
   */
  private StoryScope editedStoryScope = null;
  /**
   * Edited Subscription
   */
  private SubscribedItem editedSubscription = null;
  /**
   * Annotation type address
   */
  private String annotationTypeAddress = null;
  /**
   * Come from
   */
  private String comeFrom = null;
  /**
   * Save user login
   */
  private String saveUserLogin = null;
  /**
   * Save source URI
   */
  private String saveSourceUri = null;
  /**
   * Save subscription type
   */
  private Integer saveSubscriptionType = null;
  
  /**
   * Edited user setting
   */
  private Settings editedSetting = null;
  
  /**
   * Edited default setting for user
   */
  private DefaultSettings editedDefaultSetting = null;
  
  /**
   * Saved value of user settings
   */
  private String savedValue = null;
  
  /**
   * Saved name of user settings
   */
  private String savedName = null;
  
  /**
   * New value of annotation type for user settings
   */
  private String newAnnotType = null;
  
  /**
   * Saved document cloner approved server
   */
  private DocClonerServer actualClonerServer = null;
  
  /**
   * Saved document drupal authorization approved server
   */
  private DrupAuthServer actualDrupAuthServer = null;
  
  /**
   * Edited setting for server
   */
  private ServerSetting actualServerSetting = null;
  
  /**
   * Constructor
   */
  public WebSession() {
  }

  /**
   * Returns whether user is logged in
   *
   * @return If user is logged in, returns true, false otherwise
   */
  public boolean isLoggedIn() {
    return loggedUser != null;
  }

  /**
   * Returns whether user is an administrator
   *
   * @return If user is administrator, returns true, false otherwise
   */
  public boolean isAdmin() {
    boolean adm = false;
    for (Iterator<UserGroup> gIT = loggedUser.getGroups().iterator(); gIT.hasNext();) {
      UserGroup ug = gIT.next();
      if (ug.getName().equalsIgnoreCase(Constants.ADMIN_GROUP)) {
        adm = true;
        break;
      }
    }
    return adm;
  }  // isAdmin()

  /**
   * Sets that user is not logged in
   */
  public void setNotLoggedIn() {
    this.loggedUser = null;
  }

  /** Gets logged in user
   *
   * @return Returns logged in user
   */
  public User getLoggedUser() {
    return loggedUser;
  }

  /**
   * Sets logged in user
   *
   * @param loggedUser Logged in user
   */
  public void setLoggedUser(User loggedUser) {
    this.loggedUser = loggedUser;
  }

  
  /**
   * Gets edited user group
   * 
   * @return Returns edited user group
   */
  public UserGroup getEditedUG() {
    return editedUG;
  }

  /**
   * Sets edited user group
   *
   * @param editedUG Edited user group
   */
  public void setEditedUG(UserGroup editedUG) {
    this.editedUG = editedUG;
  }

  /**
   * Gets edited user
   *
   * @return Returns edited user
   */
  public User getEditedUser() {
    return editedUser;
  }

  /**
   * Sets edited user
   *
   * @param editedUser Edited user
   */
  public void setEditedUser(User editedUser) {
    this.editedUser = editedUser;
  }

  /**
   * Gets edited type of annotation
   *
   * @return Returns edited type of annotation
   */
  public AnnotType getEditedAT() {
    return editedAT;
  }

  /**
   * Sets edited type of annotation
   *
   * @param editedAT Edited type of annotation
   */
  public void setEditedAT(AnnotType editedAT) {
    this.editedAT = editedAT;
  }

  /**
   * Gets attribute of edited type of annotation
   *
   * @return Returns edited attribute of type of annotation
   */
  public AnnotTypeAttr getEditedATA() {
    return editedATA;
  }

  /**
   * Sets edited attribute of type of annotation
   *
   * @param editedATA Edited attribute of type of annotation
   */
  public void setEditedATA(AnnotTypeAttr editedATA) {
    this.editedATA = editedATA;
  }

  /**
   * Gets edited attribute from ontology
   * 
   * @return Returns edited attribute from ontology
   */
  public TypeAttrOnto getEditedTAO() {
    return editedTAO;
  }

  /**
   * Sets edited attribute from ontology
   *
   * @param editedTAO Edited attribute from ontology
   */
  public void setEditedTAO(TypeAttrOnto editedTAO) {
    this.editedTAO = editedTAO;
  }
  
  /**
   * Gets identification of page from which user came
   *
   * @return Returns identification of page from which user came
   */
  public String getCameFrom() {
    return cameFrom;
  }

  /**
   * Sets identification of page from which user came
   * 
   * @param cameFrom Identification of page from which user came
   */
  public void setCameFrom(String cameFrom) {
    this.cameFrom = cameFrom;
  }

  /**
   * Gets selected type of annotation
   * 
   * @return Returns selected type of annotation
   */
  public AnnotType getSelectedAT() {
    return selectedAT;
  }

  /**
   * Sets selected type of annotation
   *
   * @param selectedAT Selected type of annotation
   */
  public void setSelectedAT(AnnotType selectedAT) {
    this.selectedAT = selectedAT;
  }

  /**
   * Gets selected user group
   * 
   * @return Returns selected user group
   */
  public UserGroup getSelectedUG() {
    return selectedUG;
  }

  /**
   * Sets selected user group
   *
   * @param selectedUG Selected user group
   */
  public void setSelectedUG(UserGroup selectedUG) {
    this.selectedUG = selectedUG;
  }

  /**
   * Gets backup of form data
   * 
   * @return Returns backup of form data
   */
  public Object getFormBackup() {
    return formBackup;
  }

  /**
   * Sets backup of form data
   *
   * @param formBackup Backup of form data
   */
  public void setFormBackup(Object formBackup) {
    this.formBackup = formBackup;
  }
  
  /**
   * Gets backup of second level form data
   * 
   * @return Returns backup of second level form data
   */
  public Object getSecondFormBackup() {
    return secondFormBackup;
  }

  /**
   * Sets backup of second level form data
   *
   * @param secondFormBackup Backup of second level form data
   */
  public void setSecondFormBackup(Object secondFormBackup) {
    this.secondFormBackup = secondFormBackup;
  }
  
  /**
   * Gets edited StoryScope
   * 
   * @return Returns edited StoryScope
   */
  public StoryScope getEditedStoryScope(){
    return editedStoryScope;
  }
  
  /**
   * Set edited StoryScope
   * 
   * @param editedStoryScope Edited StoryScope
   */
  public void setEditedStoryScope(StoryScope editedStoryScope){
    this.editedStoryScope = editedStoryScope;
  }
  
  /**
   * Gets edited subscription
   * 
   * @return Return edited subscription
   */
  public SubscribedItem getEditedSubscription(){
    return editedSubscription;
  }
  
  /**
   * Sets edited subscription
   * 
   * @param editedSubscription Edited subscription
   */
  public void setEditedSubscription(SubscribedItem editedSubscription){
    this.editedSubscription = editedSubscription;
  }

  /**
   * Gets annotation type address
   * 
   * @return Annotation type address
   */
  public String getAnnotationTypeAddress() {
    return annotationTypeAddress;
  }

  /**
   * Sets annotation type address
   * 
   * @param annotationTypeAddress Annotation type address
   */
  public void setAnnotationTypeAddress(String annotationTypeAddress) {
    this.annotationTypeAddress = annotationTypeAddress;
  }

  /**
   * Gets come from
   * 
   * @return Come from
   */
  public String getComeFrom() {
    return comeFrom;
  }

  /**
   * Sets ome from
   * 
   * @param comeFrom Come from
   */
  public void setComeFrom(String comeFrom) {
    this.comeFrom = comeFrom;
  }

  /**
   * Gets save source URI
   * 
   * @return Save source URI
   */
  public String getSaveSourceUri() {
    return saveSourceUri;
  }

  /**
   * Sets save source URI
   * 
   * @param saveSourceUri Save source URI
   */
  public void setSaveSourceUri(String saveSourceUri) {
    this.saveSourceUri = saveSourceUri;
  }

  /**
   * Gets save subscription type
   * 
   * @return Save subscription type
   */
  public Integer getSaveSubscriptionType() {
    return saveSubscriptionType;
  }
  
  /**
   * Sets save subscription type
   * 
   * @param saveSubscriptionType Save subscription type
   */
  public void setSaveSubscriptionType(Integer saveSubscriptionType) {
    this.saveSubscriptionType = saveSubscriptionType;
  }

  /**
   * Gets save user login
   * 
   * @return Save user login
   */
  public String getSaveUserLogin() {
    return saveUserLogin;
  }

  /**
   * Sets save user login
   * 
   * @param saveUserLogin Save user login
   */
  public void setSaveUserLogin(String saveUserLogin) {
    this.saveUserLogin = saveUserLogin;
  }

  /**
   * Gets edited user setting
   * 
   * @return Returns edited user setting
   */
  public Settings getEditedSetting() {
    return editedSetting;
  }

  /**
   * Sets edited user setting
   *
   * @param editedSetting Edited user setting
   */
  public void setEditedSetting(Settings editedSetting) {
    this.editedSetting = editedSetting;
  }

  /**
   * Gets edited default setting for user
   * 
   * @return Returns edited default setting for user
   */
  public DefaultSettings getEditedDefaultSetting() {
    return editedDefaultSetting;
  }

  /**
   * Sets edited default setting for user
   *
   * @param editedDefaultSetting Edited default setting for user
   */
  public void setEditedDefaultSetting(DefaultSettings editedDefaultSetting) {
    this.editedDefaultSetting = editedDefaultSetting;
  }

  /**
   * Gets saved value of user settings
   * 
   * @return Returns saved value of user settings
   */
  public String getSavedValue() {
    return savedValue;
  }

  /**
   * Sets value of user settings for save
   *
   * @param savedValue value of user settings for save
   */
  public void setSavedValue(String savedValue) {
    this.savedValue = savedValue;
  }

  /**
   * Gets saved name of user settings
   * 
   * @return Returns saved name of user settings
   */
  public String getSavedName() {
    return savedName;
  }

  /**
   * Sets name of user settings for save
   *
   * @param savedName name of user settings for save
   */
  public void setSavedName(String savedName) {
    this.savedName = savedName;
  }

  /**
   * Gets new value of annotation type for user settings
   * 
   * @return Returns new value of annotation type for user settings
   */
  public String getNewAnnotType() {
    return newAnnotType;
  }

  /**
   * Sets new value of annotation type for user settings
   *
   * @param newAnnotType new value of annotation type for user settings
   */
  public void setNewAnnotType(String newAnnotType) {
    this.newAnnotType = newAnnotType;
  }

  /**
   * Gets actual document cloner approved server
   *
   * @return value of actual document cloner approved server
   */
  public DocClonerServer getActualClonerServer() {
    return actualClonerServer;
  }

  /**
   * Sets actual document cloner approved server
   *
   * @param actualClonerServer new value of actual document cloner approved server
   */
  public void setActualClonerServer(DocClonerServer actualClonerServer) {
    this.actualClonerServer = actualClonerServer;
  }

  /**
   * Gets actual drupal authorization approved server
   *
   * @return value of actual drupal authorization approved server
   */
  public DrupAuthServer getActualDrupAuthServer() {
    return actualDrupAuthServer;
  }

  /**
   * Sets actual drupal authorization approved server
   *
   * @param actualDrupAuthServer new value of actual drupal authorization approved server
   */
  public void setActualDrupAuthServer(DrupAuthServer actualDrupAuthServer) {
    this.actualDrupAuthServer = actualDrupAuthServer;
  }

  /**
   * Gets actual edited setting for server
   *
   * @return value of actual edited setting for server
   */
  public ServerSetting getActualServerSetting() {
    return actualServerSetting;
  }

  /**
   * Sets actual edited setting for server
   *
   * @param actualServerSetting new value of actual edited setting for server
   */
  public void setActualServerSetting(ServerSetting actualServerSetting) {
    this.actualServerSetting = actualServerSetting;
  }

}  // public class WebSession