RequestInfo.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: RequestInfo.java
 * Description: Class for representing processed informations about client request
 */

/**
 * @file RequestInfo.java
 *
 * @brief Processed informations about client request
 */

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

import cz.vutbr.fit.knot.annotations.app.Constants;
import cz.vutbr.fit.knot.annotations.app.Localisation;
import cz.vutbr.fit.knot.annotations.app.TextModification;
import cz.vutbr.fit.knot.annotations.entity.AnnotDocument;
import cz.vutbr.fit.knot.annotations.entity.Annotation;
import cz.vutbr.fit.knot.annotations.entity.Settings;
import cz.vutbr.fit.knot.annotations.entity.Subscription;
import cz.vutbr.fit.knot.annotations.entity.User;
import cz.vutbr.fit.knot.annotations.entity.UserGroup;
import cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion;
import java.util.ArrayList;
import org.w3c.dom.Document;

/**
 * Class for representing processed informations about client request
 *
 * @brief Processed informations about client request
 * @author idytrych
 */
public class RequestInfo {
  /**
   * Informations for comet handlers
   * - All informations, which can be relevant for comet handlers are here.
   */
  private Flier flier = null;
  /**
   * Indicator whether flier can be sent to comet handlers (no serious error ocurred)
   */
  private boolean canNotify = true;
  /** String with request from client (raw POST data) */
  private String requestString = "";
  /** Parsed XML document with client request */
  private Document requestDocument;
  /** String with error messages for client */
  private String errors = "";
  /** List of numbers of occurred errors */
  private ArrayList<Integer> errorList;
  /** String with warning messages for client */
  private String warnings = "";
  /** Session to which this request pertains */
  private EditorSession session = null;
  /** Sessions to which this comet request pertains */
  private ArrayList<EditorSession> cometSessionList = null;
  /** String with replies for the client */
  private String ReplyText = "";
  /** User, which is logging in */
  private User loggedIn = null;
  /** Logout indicator */
  private boolean logout = false;
  /** Version of protocol which will be used in this connection */
  private String connectWPV = null;
  /** Disconnect indicator */
  private boolean disconnect = false;
  /** Indicator of change in requested suggestions */
  private Boolean suggFragmentChanged = false;
  /** Array of refused suggestions */
  private ArrayList<SuggestionLogEntry> refusedSuggestions;
  /** Original array of refused suggestions */
  private ArrayList<SuggestionLogEntry> origRefusedSuggestions;
  /** Array of confirmed suggestions */
  private ArrayList<SuggestionLogEntry> confirmedSuggestions;
  /** Array of suggestions for which alternatives was requested */
  private ArrayList<Suggestion> alternativesRequestedFor;
  /** Array with parameters of settings */
  private ArrayList<Settings> settings;
  /** Informations about synchronized document */
  private AnnotDocument syncDocumentData = null;
  /** In case of successful synchronization, here will be synchronized document */
  private AnnotDocument syncDocument = null;
  /** Indicator of synchronization new (yet unknown) document */
  private boolean newDocument = false;
  /** Indicator of synchronization with linearization */
  private boolean syncLinearized = false;
  /** Indicator of forced synchronization (overwriting of document) */
  private boolean syncWithOverwrite = false;
  /** Informations about resynchronized document */
  private String resyncDocContent = null;
  /** Array of annotations to be reloaded */
  private ArrayList<Annotation> reloadAnnotations;
  /** Indicator of reloading all annotations */
  private boolean reloadAll = false;
  /** Queried annotation types (list of strings with filters) */
  private ArrayList<String> queryTypes;
  /** Queried persons (list of strings with filters) */
  private ArrayList<String> queryPersons;
  /** Queried user groups (list of strings with filters) */
  private ArrayList<String> queryUserGroups;
  /** Queried persons with user groups (list of strings with filters) */
  private ArrayList<String> queryPersonsWG;
  /** Queried user groups with persons (list of strings with filters) */
  private ArrayList<String> queryUserGroupsWP;
  /** Indicator of change in document */
  private boolean documentChanged = false;
  /** List of groups to which is user trying to join */
  private ArrayList<UserGroup> joinedGroups;
  /** List of groups to be leaved */
  private ArrayList<UserGroup> leavedGroups;
  /** Indicator whether is only one message sent that was session */
  private boolean sessionOnly = false;
  /** URI of user group in which are queried attributes from ontology */
  private String queryTypeAttOnto = null;
  /** New text modifications to be applied to synschronized document */
  private ArrayList<TextModification> textModifications;
  /** Number of last modification stands for ID of last applied modification */
  private int lastModificationNumber;
  /** Set to true if user wnats all entity types */
  private boolean getEntityTypes;
  /** Request for controlled dictionary entity */
  private EntityRequest entityRequest;
  /** Version of document before changes */
  private String oldDocumentVersion;
  /** Queried persons attribues for protocol version 2.0 */
  private ArrayList<String> usersQueryV2;
  /** Queried persons restrictions for protocol version 2.0 */
  private boolean[] usersRestrictionsV2;
  /** Queried users groups attribues for protocol version 2.0 */
  private ArrayList<String> groupsQueryV2;
  /** Queried user group persons (if parameter withUsers = true) restrictions for protocol version 2.0 */
  private boolean[] usersGroupRestrictionsV2;
  /** List of just subscribed subscriptions */
  private ArrayList<Subscription> subscribeList = null;
  /** List of just unsubscribed subscriptions */
  private ArrayList<Subscription> unsubscribeList = null;
  /** Array of updated user subscriptions */
  private ArrayList<Subscription> updatedSubscriptions;
  /** Array of subscriptions before update */
  private ArrayList<Subscription> beforeUpdatedSubscriptions;
  /** Array of deleted user subscriptions */
  private ArrayList<Subscription> deletedSubscriptions;
  /** Array of added user subscriptions */
  private ArrayList<Subscription> newSubscriptions;
  /** Array with parameters of subscription query */
  private ArrayList<String> subscriptionQuery;
  /** Minimal confidence used to filtrate suggestions */
  private Integer minConfidence;
  /** Information about request for autoconfirm suggestions */
  private boolean autoconfirmRequested;
  /** List of automatically confirmed suggestions */
  private ArrayList<SuggestionLogEntry> autoconfirmedSuggestions;

  /**
   * Constructor which initializes variables
   */
  public RequestInfo() {
    refusedSuggestions = new ArrayList<SuggestionLogEntry>();
    origRefusedSuggestions = new ArrayList<SuggestionLogEntry>();
    confirmedSuggestions = new ArrayList<SuggestionLogEntry>();
    alternativesRequestedFor = new ArrayList<Suggestion>();
    reloadAnnotations = new ArrayList<Annotation>();
    queryTypes = new ArrayList<String>();
    queryPersons = new ArrayList<String>();
    queryUserGroups = new ArrayList<String>();
    queryPersonsWG = new ArrayList<String>();
    queryUserGroupsWP = new ArrayList<String>();
    errorList = new ArrayList<Integer>();
    joinedGroups = new ArrayList<UserGroup>();
    leavedGroups = new ArrayList<UserGroup>();
    textModifications = new ArrayList<TextModification>();
    this.subscribeList = new ArrayList<Subscription>();
    this.unsubscribeList = new ArrayList<Subscription>();
    updatedSubscriptions = new ArrayList<Subscription>();
    deletedSubscriptions = new ArrayList<Subscription>();
    newSubscriptions = new ArrayList<Subscription>();
    beforeUpdatedSubscriptions = new ArrayList<Subscription>();
    settings = null;
    entityRequest = null;
    usersQueryV2 = null;
    usersRestrictionsV2 = null;
    groupsQueryV2 = null;
    usersGroupRestrictionsV2 = null;
    subscriptionQuery = null;
    autoconfirmedSuggestions = new ArrayList<SuggestionLogEntry>();
  }

  /**
   * Gets string with error messages for client
   *
   * @return Returns string with error messages for client
   */
  public String getErrors() {
    return errors;
  }

  /**
   * Sets string with error messages for client
   *
   * @param errors String with error messages for client
   */
  public void setErrors(String errors) {
    this.errors = errors;
  }

  /**
   * Gets list of numbers of occurred errors
   *
   * @return Returns list of numbers of occurred errors
   */
  public ArrayList<Integer> getErrorList() {
    return errorList;
  }

  /**
   * Method for adding custom errors to string which is sent to client.
   * Error message must be in XML.
   *
   * @param error String with error for client (in XML)
   */
  public void addError(String error) {
    this.errors = this.errors + error;
  }

  /**
   * Method for adding error to string which is sent to client.
   * Numbers of errors are specified in class Constants.
   *
   * @param version Version of protocol used (LOD)
   * @param lNum Number (id) of language
   * @param error Number of error
   */
  public void addError(int version, int lNum, int error) {
    addError(version, lNum, error,"");
  }

  /**
   * Method for adding error to string which is sent to client.
   * Numbers of errors are specified in class Constants.
   *
   * @param version Version of protocol used (LOD)
   * @param lNum Number (id) of language
   * @param error Number of error
   * @param info Additional informations in XML
   */
  public void addError(int version, int lNum, int error, String info) {
    addError(version, lNum, error, info, "");
  } 

  /**
   * Method for adding error to string which is sent to client.
   * This variant of function is intended for use in case of error, which is
   * not specified in Constants, or in case of customized (more detailed) error
   * message.
   *
   * @param version Version of protocol used (LOD)
   * @param lNum Number (id) of language
   * @param error Number of error
   * @param info Additional informations in XML
   * @param text Custom error message
   */
  public void addError(int version, int lNum, int error, String info, String text) {
    this.errorList.add(error);
    this.errors = this.errors + createErrorMsg(version, lNum, error, info, text);
  }

  /**
   * Function for creating error message to be sent to client. Numbers
   * of errors and strings with error messages are specified in class Constants.
   *
   * @param version Version of protocol used (LOD)
   * @param lNum Number (id) of language
   * @param error Number of error
   * @return Returns error message in XML
   */
  public static String createErrorMsg(int version, int lNum, int error) {
    return createErrorMsg(version, lNum, error, "");
  }

  /**
   * Function for creating error message to be sent to client. Numbers
   * of errors and strings with error messages are specified in class Constants.
   *
   * @param version Version of protocol used (LOD)
   * @param lNum Number (id) of language
   * @param error Number of error
   * @param info Additional informations in XML
   * @return Returns error message in XML
   */
  public static String createErrorMsg(int version, int lNum, int error, String info) {
    return createErrorMsg(version, lNum, error, info, "");
  }

  /**
   * Function for creating error message to be sent to client. Numbers
   * of errors and strings with error messages are specified in class Constants.
   *
   * @param version Version of protocol used (LOD)
   * @param lNum Number (id) of language
   * @param error Number of error
   * @param info Additional informations in XML
   * @param text Custom error message
   * @return Returns error message in XML
   */
  public static String createErrorMsg(int version, int lNum, int error, String info, String text) {
    if (version < Constants.PROTOCOL_LOD_V2) {
      return createErrorMsg1(lNum, error, info, text);
    } else {
      return createErrorMsg2(lNum, error, info, text);
    }
  }
  
  /**
   * Function for creating error message to be sent to client. Numbers
   * of errors and strings with error messages are specified in class Constants.
   * This method is for protocol version 1.x
   *
   * @param lNum Number (id) of language
   * @param error Number of error
   * @param info Additional informations in XML
   * @param text Custom error message
   * @return Returns error message in XML
   */
  public static String createErrorMsg1(int lNum, int error, String info, String text) {
    String errText;
    int errNum = error;
    if (error >= 0 && error < Localisation.getNumOfErrors()) {
      errText = Localisation.getErrMessage(lNum, errNum);
    } else {
      errText = Localisation.getUnknownErrMessage(lNum);
      errNum = Localisation.ERROR_100_UNKNOWN_ERROR;
    }

    if (text.length() > 0) {
      errText = text;
    }

    return "<error number=\"" + errNum + "\">"
      + "<message><![CDATA[\n"
      + errText + "\n"
      + "]]></message>\n"
      + info
      + "</error>\n";
  }
  
  /**
   * Function for creating error message to be sent to client. Numbers
   * of errors and strings with error messages are specified in class Constants.
   * This method is for protocol version 2.x
   * 
   * @param lNum Number (id) of language
   * @param error Number of error
   * @param info Additional informations in XML
   * @param text Custom error message
   * @return Returns error message in XML
   */
  public static String createErrorMsg2(int lNum, int error, String info, String text) {
    String errText;
    int errNum = error;
    if (error >= 0 && error < Localisation.getNumOfErrors()) {
      errText = Localisation.getErrMessage2(lNum, errNum);
    } else {
      errText = Localisation.getUnknownErrMessage2(lNum);
      errNum = Localisation.ERROR_100_UNKNOWN_ERROR;
    }

    if (text.length() > 0) {
      errText = text;
    }
    
    String errCode = Localisation.getErrCode(errNum);

    return "<error code=\"" + errCode + "\">"
      + "<message><![CDATA[\n"
      + errText + "\n"
      + "]]></message>\n"
      + info
      + "</error>\n";
  }  // createErrorMsg2()

  /**
   * Geting of string with warning messages for client
   *
   * @return Returns string with warning messages for client
   */
  public String getWarnings() {
    return warnings;
  }

  /**
   * Sets string with warning messages for client
   *
   * @param warnings String with warning messages for client
   */
  public void setWarnings(String warnings) {
    this.warnings = warnings;
  }

  /**
   * Method for adding warning to string which is sent to client.
   *
   * @param warning String with warning for client (in XML)
   */
  public void addWarning(String warning) {
    this.warnings = this.warnings + warning;
  }

  /**
   * Method for adding warning to string which is sent to client.
   * Numbers of warnings are specified in class Constants.
   *
   * @param version Version of protocol used (LOD)
   * @param lNum Number (id) of language
   * @param warning Number of error
   */
  public void addWarning(int version, int lNum, int warning) {
    addWarning(version, lNum, warning, "");
  }

  /**
   * Method for adding warning to string which is sent to client.
   * Numbers of warnings are specified in class Constants.
   *
   * @param version Version of protocol used (LOD)
   * @param lNum Number (id) of language
   * @param warning Number of error
   * @param annotation URI of affected annotation
   */
  public void addWarning(int version, int lNum, int warning, String annotation) {
    if (version < Constants.PROTOCOL_LOD_V2) {
      addWarning(lNum, warning, annotation, "");
    } else {
      String context = "";
      if (!annotation.isEmpty()) {
        context = "<annotation uri=\"" + annotation + "\"/>";
      }
      addWarning2(lNum, warning, context, "");
    }
  }
  
  /**
   * Method for adding warning to string which is sent to client.
   * This variant of function is intended for use in case of warning, which
   * is not specified in Constants, or in case of customized (more detailed)
   * warning message.
   *
   * @param lNum Number (id) of language
   * @param warning Number of error
   * @param annotation URI of affected annotation
   * @param text Custom warning message
   */
  public void addWarning(int lNum, int warning, String annotation, String text) {
    String wText;
    int wNum = warning;
    if (warning > 0 && warning < Localisation.getNumOfWarnings()) {
      wText = Localisation.getWarningMessage(lNum, warning);
    } else {
      wText = Localisation.getUnknownWarningMessage(lNum);
      wNum = 100;
    }

    if (text.length() > 0)
      wText = text;

    String anAt = "";
    if (annotation.length() > 0) {
      anAt = " annotation=\"" + annotation + "\"";
    }

    this.errors = this.errors + "<warning number=\"" + wNum + "\"" + anAt + ">"
      + "<![CDATA["
      + wText + "\n"
      + "]]>"
      + "</warning>";
  }

  /**
   * Geting of flier
   * Flier contains all informations, which can be relevant for comet handlers.
   *
   * @return Returns flier (informations for comet handlers)
   */
  public Flier getFlier() {
    return flier;
  }

  /**
   * Method for adding warning to string which is sent to client.
   * This variant of function is intended for use in case of warning, which
   * is not specified in Constants, or in case of customized (more detailed)
   * warning message.
   * It is intended for protocol version 2.0
   *
   * @param lNum Number (id) of language
   * @param warning Number of error
   * @param info Additional informations in XML
   * @param text Custom warning message
   */
  public void addWarning2(int lNum, int warning, String info, String text) {
    String wText;
    int wNum = warning;
    if (warning > 0 && warning < Localisation.getNumOfWarnings()) {
      wText = Localisation.getWarningMessage2(lNum, warning);
    } else {
      wText = Localisation.getUnknownWarningMessage2(lNum);
      wNum = Localisation.WARNING_100_UNKNOWN;
    }

    if (text.length() > 0) {
      wText = text;
    }

    String wCode = Localisation.getWarningCode(wNum);

    this.errors = this.errors + "<warning code=\"" + wCode + "\">"
      + "<message><![CDATA["
      + wText + "\n"
      + "]]></message>\n"
      + info
      + "</warning>";
  }  // addWarning2
  
  /**
   * Setting of flier
   * Flier contains all informations, which can be relevant for comet handlers.
   *
   * @param flier Flier with informations for comet handlers
   */
  public void setFlier(Flier flier) {
    this.flier = flier;
  }

  /**
   * Geting of session in which this request originated
   *
   * @return Returns Session in which this request originated
   */
  public EditorSession getSession() {
    return session;
  }

  /**
   * Sets the session in which this request originated
   *
   * @param session Session in which this request originated
   */
  public void setSession(EditorSession session) {
    this.session = session;
    if(session != null && session.getSyncDocument() != null){
      this.oldDocumentVersion = session.getSyncDocument().getContent();
    }
  }
  
  /**
   * Geting list of sessions in which this comet request originated
   *
   * @return Returns list of sessions in which this comet request originated
   */
  public ArrayList<EditorSession> getCometSessionList() {
    return cometSessionList;
  }

  /**
   * Sets the list of sessions in which this comet request originated
   *
   * @param sessionList List of sessions in which this comet request originated
   */
  public void setCometSessionList(ArrayList<EditorSession> sessionList) {
    this.cometSessionList = sessionList;
  }

  /**
   * Gets of replies for the client
   * Reply text contains replies to messages from client (errors and warnings
   * are in separate strings).
   *
   * @return Returns string with replies for the client
   */
  public String getReplyText() {
    return ReplyText;
  }

  /**
   * Sets the string with replies for the client
   *
   * @param ReplyText string with replies for the client
   */
  public void setReplyText(String ReplyText) {
    this.ReplyText = ReplyText;
  }

  /**
   * Appends new response message to responses for client.
   *
   * @param text Response message in XML.
   */
  public void appendToReply(String text) {
    this.ReplyText = this.ReplyText.concat(text);
  }

  /**
   * Returns whether fragment to which is annotations suggesting is changed
   *
   * @return If fragment is changed, returns true, false otherwise
   */
  public Boolean isSuggFragmentChanged() {
    return suggFragmentChanged;
  }

  /**
   * Sets whether fragment to which is annotations suggesting is changed
   *
   * @param suggFragmentChanged If fragment is changed, true, false otherwise
   */
  public void setSuggFragmentChanged(Boolean suggFragmentChanged) {
    this.suggFragmentChanged = suggFragmentChanged;
  }

  /**
   * Gets list of refused annotation suggestions
   * 
   * @return Returns list of refused annotation suggestions
   */
  public ArrayList<SuggestionLogEntry> getRefusedSuggestions() {
    return refusedSuggestions;
  }

  /**
   * Sets list of refused annotation suggestions
   * 
   * @param refusedSuggestions List of refused annotation suggestions
   */
  public void setRefusedSuggestions(ArrayList<SuggestionLogEntry> refusedSuggestions) {
    this.refusedSuggestions = refusedSuggestions;
  }

  /**
   * Adds refused annotation suggestion to the list
   * 
   * @param refusedSuggestion Refused annotation suggestion
   */
  public void addRefusedSuggestion(SuggestionLogEntry refusedSuggestion) {
    this.refusedSuggestions.add(refusedSuggestion);
  }

  /**
   * Gets original list of refused annotation suggestions
   * 
   * @return Returns original list of refused annotation suggestions
   */
  public ArrayList<SuggestionLogEntry> getOrigRefusedSuggestions() {
    return origRefusedSuggestions;
  }

  /**
   * Sets original list of refused annotation suggestions
   * 
   * @param origRefusedSuggestions Original list of refused annotation suggestions
   */
  public void setOrigRefusedSuggestions(ArrayList<SuggestionLogEntry> origRefusedSuggestions) {
    this.origRefusedSuggestions = origRefusedSuggestions;
  }
  
  /**
   * Gets list of confirmed annotation suggestions
   * 
   * @return Returns list of confirmed annotation suggestions
   */
  public ArrayList<SuggestionLogEntry> getConfirmedSuggestions() {
    return confirmedSuggestions;
  }
  
  /**
   * Clears list of confirmed annotation suggestions.
   */
  public void clearConfirmedSuggestions() {
    if(confirmedSuggestions != null){
      confirmedSuggestions.clear();
    }
  }

  /**
   * Sets list of confirmed annotation suggestions
   * 
   * @param confirmedSuggestions List of confirmed annotation suggestions
   */
  public void setConfirmedSuggestions(ArrayList<SuggestionLogEntry> confirmedSuggestions) {
    this.confirmedSuggestions = confirmedSuggestions;
  }

  /**
   * Adds confirmed annotation suggestion to the list
   * 
   * @param confirmedSuggestion Confirmed annotation suggestion
   */
  public void addConfirmedSuggestion(SuggestionLogEntry confirmedSuggestion) {
    this.confirmedSuggestions.add(confirmedSuggestion);
  }

  /**
   * Gets array of suggestions for which alternatives was requested
   * 
   * @return Returns array of suggestions for which alternatives was requested
   */
  public ArrayList<Suggestion> getAlternativesRequestedFor() {
    return alternativesRequestedFor;
  }

  /**
   * Sets array of suggestions for which alternatives was requested
   * 
   * @param alternativesRequestedFor Array of suggestions for which alternatives was requested
   */
  public void setAlternativesRequestedFor(ArrayList<Suggestion> alternativesRequestedFor) {
    this.alternativesRequestedFor = alternativesRequestedFor;
  }

  /**
   * Adds suggestion into array of suggestions for which alternatives was requested
   * 
   * @param sug Suggestion to add
   */
  public void addSugToAlternativesRequestedFor(Suggestion sug) {
    this.alternativesRequestedFor.add(sug);
  }
  
  /**
   * Gets list of params of user settings
   * 
   * @return Returns list of params of user settings
   */
  public ArrayList<Settings> getSettings() {
    return settings;
  }

  /**
   * Sets list of params of user settings
   * 
   * @param settings List of params of user settings
   */
  public void setSettings(ArrayList<Settings> settings) {
    this.settings = settings;
  }

  /**
   * Gets data of synchronized document (data from user request)
   * 
   * @return Returns data of synchronized document (data from user request)
   */
  public AnnotDocument getSyncDocumentData() {
    return syncDocumentData;
  }

  /**
   * Sets data of synchronized document (data from user request)
   * 
   * @param syncDocumentData Data of synchronized document (data from user request)
   */
  public void setSyncDocumentData(AnnotDocument syncDocumentData) {
    this.syncDocumentData = syncDocumentData;
  }

  /**
   * Gets synchronized document. This is set by server module in the case
   * of successfull synchronization.
   * 
   * @return Returns synchronized document
   */
  public AnnotDocument getSyncDocument() {
    return syncDocument;
  }

  /**
   * Sets synchronized document. This is set by server module in the case 
   * of successfull synchronization.
   * 
   * @param syncDocument Synchronized document
   */
  public void setSyncDocument(AnnotDocument syncDocument) {
    this.syncDocument = syncDocument;
  }

  /**
   * Gets information about whether synchronization is with linearization
   * 
   * @return If synchronization is with linearization, returns true, false otherwise
   */
  public boolean isSyncLinearized() {
    return syncLinearized;
  }

  /**
   * Sets information about whether synchronization is with linearization
   * 
   * @param syncLinearized If synchronization is with linearization, true, false otherwise
   */
  public void setSyncLinearized(boolean syncLinearized) {
    this.syncLinearized = syncLinearized;
  }

  /**
   * Gets information about whether synchronization is forced (overwrite document)
   * 
   * @return If synchronization is forced, returns true, false otherwise
   */
  public boolean isSyncWithOverwrite() {
    return syncWithOverwrite;
  }

  /**
   * Sets information about whether synchronization is is forced (overwrite document)
   * 
   * @param syncWithOverwrite If synchronization is forced, true, false otherwise
   */
  public void setSyncWithOverwrite(boolean syncWithOverwrite) {
    this.syncWithOverwrite = syncWithOverwrite;
  }

  /**
   * Gets content of resynchronized document (data from client request)
   * 
   * @return Returns content of resynchronized document
   */
  public String getResyncDocContent() {
    return resyncDocContent;
  }

  /**
   * Sets content of resynchronized document (data from client request)
   * 
   * @param resyncDocContent Content of resynchronized document
   */
  public void setResyncDocContent(String resyncDocContent) {
    this.resyncDocContent = resyncDocContent;
  }

  /**
   * Gets list of reloaded annotations
   * 
   * @return Returns list of reloaded annotations
   */
  public ArrayList<Annotation> getReloadAnnotations() {
    return reloadAnnotations;
  }

  /**
   * Sets the list of reloaded annotations
   * 
   * @param reloadAnnotations List of reloaded annotations (requested by client)
   */
  public void setReloadAnnotations(ArrayList<Annotation> reloadAnnotations) {
    this.reloadAnnotations = reloadAnnotations;
  }

  /**
   * Adds reloaded annotation to the list
   * 
   * @param reloadAnnotation Reloaded annotation (requested by client)
   */
  public void addReloadAnnotations(Annotation reloadAnnotation) {
    this.reloadAnnotations.add(reloadAnnotation);
  }

  /**
   * Returns, whether client requested reloading of all annotations
   * 
   * @return If client requested reloading of all annotations, returns true, false otherwise
   */
  public boolean getReloadAll() {
    return reloadAll;
  }

  /**
   * Sets, whether client requested reloading of all annotations
   * 
   * @param reloadAll If client requested reloading of all annotations, true, false otherwise
   */
  public void setReloadAll(boolean reloadAll) {
    this.reloadAll = reloadAll;
  }

  /**
   * Gets queried annotation types (list of strings with filters)
   * 
   * @return Returns queried annotation types (list of strings with filters)
   */
  public ArrayList<String> getQueryTypes() {
    return queryTypes;
  }

  /**
   * Sets queried annotation types (list of strings with filters)
   * 
   * @param queryTypes Queried annotation types (list of strings with filters)
   */
  public void setQueryTypes(ArrayList<String> queryTypes) {
    this.queryTypes = queryTypes;
  }

  /**
   * Adds queried annotation type(s) (string with filter) to the list
   * 
   * @param queryType Queried annotation type (string with filter)
   */
  public void addQueryTypes(String queryType) {
    this.queryTypes.add(queryType);
  }

  /**
   * Gets queried persons (list of strings with filters)
   *
   * @return Returns queried persons (list of strings with filters)
   */
  public ArrayList<String> getQueryPersons() {
    return queryPersons;
  }

  /**
   * Sets queried persons (list of strings with filters)
   *
   * @param queryPersons Queried persons (list of strings with filters)
   */
  public void setQueryPersons(ArrayList<String> queryPersons) {
    this.queryPersons = queryPersons;
  }

  /**
   * Adds queried person(s) (string with filter) to the list
   *
   * @param queryPerson Queried persons (string with filter)
   */
  public void addQueryPersons(String queryPerson) {
    this.queryPersons.add(queryPerson);
  }

  /**
   * Gets queried user groups (list of strings with filters)
   *
   * @return Returns queried user groups (list of strings with filters)
   */
  public ArrayList<String> getQueryUserGroups() {
    return queryUserGroups;
  }

  /**
   * Sets queried user groups (list of strings with filters)
   *
   * @param queryUserGroups Queried user groups (list of strings with filters)
   */
  public void setQueryUserGroups(ArrayList<String> queryUserGroups) {
    this.queryUserGroups = queryUserGroups;
  }

  /**
   * Adds queried user group(s) (string with filter) to the list
   *
   * @param queryUserGroups Queried user group(s) (string with filter)
   */
  public void addQueryUserGroups(String queryUserGroups) {
    this.queryUserGroups.add(queryUserGroups);
  }

  /**
   * Gets queried persons with list of user groups (list of strings with filters)
   *
   * @return Returns queried persons wiht list of user groups (list of strings with filters)
   */
  public ArrayList<String> getQueryPersonsWG() {
    return queryPersonsWG;
  }

  /**
   * Sets queried persons with list of user groups (list of strings with filters)
   *
   * @param queryPersonsWG Queried persons with list of user groups (list of strings with filters)
   */
  public void setQueryPersonsWG(ArrayList<String> queryPersonsWG) {
    this.queryPersonsWG = queryPersonsWG;
  }

  /**
   * Adds queried person(s) with list of user groups (string with filter) to the list
   *
   * @param queryPersonsWG Queried person(s) (string with filter)
   */
  public void addQueryPersonsWG(String queryPersonsWG) {
    this.queryPersonsWG.add(queryPersonsWG);
  }

  /**
   * Gets queried user groups with list of persons (list of strings with filters)
   *
   * @return Returns queried user groups with list of persons (list of strings with filters)
   */
  public ArrayList<String> getQueryUserGroupsWP() {
    return queryUserGroupsWP;
  }

  /**
   * Sets queried user groups with list of persons (list of strings with filters)
   *
   * @param queryUserGroupsWP Queried user groups with list of persons (list of strings with filters)
   */
  public void setQueryUserGroupsWP(ArrayList<String> queryUserGroupsWP) {
    this.queryUserGroupsWP = queryUserGroupsWP;
  }

  /**
   * Adds queried user group(s) with list of persons (string with filter) to the list
   *
   * @param queryUserGroupsWP Queried user group(s) (string with filter)
   */
  public void addQueryUserGroupsWP(String queryUserGroupsWP) {
    this.queryUserGroupsWP.add(queryUserGroupsWP);
  }

  /**
   * Gets raw request data
   *
   * @return Returns raw request data
   */
  public String getRequestString() {
    return requestString;
  }

  /**
   * Sets raw request data
   *
   * @param requestString Raw request data
   */
  public void setRequestString(String requestString) {
    this.requestString = requestString;
  }

  /**
   * Gets parsed request data in document
   *
   * @return Returns parsed request data in document
   */
  public Document getRequestDocument() {
    return requestDocument;
  }

  /**
   * Sets parsed request data in document
   *
   * @param requestDocument Parsed request data in document
   */
  public void setRequestDocument(Document requestDocument) {
    this.requestDocument = requestDocument;
  }

  /**
   * Gets just logged in user
   *
   * @return Returns just logged in user
   */
  public User getLoggedIn() {
    return loggedIn;
  }

  /**
   * Sets just logged in user
   *
   * @param loggedIn Just logged in user
   */
  public void setLoggedIn(User loggedIn) {
    this.loggedIn = loggedIn;
  }

  /**
   * Gets protocol version (set only if this request contains Connect message)
   *
   * @return Returns protocol version
   */
  public String getConnectWPV() {
    return connectWPV;
  }

  /**
   * Sets protocol version (from Connect message)
   *
   * @return Returns protocol version
   */
  public void setConnectWPV(String connectWPV) {
    this.connectWPV = connectWPV;
  }

  /**
   * Returns whether this request contains disconnect message
   *
   * @return If disconnect is presented, returns true, false otherwise
   */
  public boolean isDisconnect() {
    return disconnect;
  }

  /**
   * Sets whether this request contains disconnect message
   *
   * @param disconnect If disconnect is presented, true, false otherwise
   */
  public void setDisconnect(boolean disconnect) {
    this.disconnect = disconnect;
  }

  /**
   * Returns whether this request contains logout message
   *
   * @return If logout is presented, returns true, false otherwise
   */
  public boolean isLogout() {
    return logout;
  }

  /**
   * Sets whether this request contains logout message
   *
   * @param logout If logout is presented, true, false otherwise
   */
  public void setLogout(boolean logout) {
    this.logout = logout;
  }

  /**
   * Returns whether informations from the processed request can be notified
   * to comet handlers (whether error not ocurred)
   *
   * @return If informations can be notified, returns true, false otherwise
   */
  public boolean getCanNotify() {
    return canNotify;
  }

  /**
   * Sets whether informations from the processed request can be notified
   * to comet handlers (whether error not ocurred)
   *
   * @param canNotify If informations can be notified, true, false otherwise
   */
  public void setCanNotify(boolean canNotify) {
    this.canNotify = canNotify;
  }

  /**
   * Returns whether annotated document is changed (text modified).
   * This can be done by textModification message.
   *
   * @return If document is changed, returns true, false otherwise
   */
  public boolean isDocumentChanged() {
    return documentChanged;
  }

  /**
   * Sets whether annotated document is changed (text modified)
   *
   * @param documentChanged If document is changed, true, false otherwise
   */
  public void setDocumentChanged(boolean documentChanged) {
    this.documentChanged = documentChanged;
  }

  /**
   * Returns, whether just synchronized document is new (yet unknown)
   *
   * @return If just synchronized document is new, returns true, false otherwise
   */
  public boolean isNewDocument() {
    return newDocument;
  }

  /**
   * Sets, whether just synchronized document is new (yet unknown)
   *
   * @param newDocument If just synchronized document is new, true, false otherwis
   */
  public void setNewDocument(boolean newDocument) {
    this.newDocument = newDocument;
  }

  /**
   * Gets list of groups to which is user trying to join
   *
   * @return Returns list of groups to which is user trying to join
   */
  public ArrayList<UserGroup> getJoinedGroups() {
    return joinedGroups;
  }

  /**
   * Sets the list of groups to which is user trying to join
   *
   * @param joinedGroups List of groups to which is user trying to join
   */
  public void setJoinedGroups(ArrayList<UserGroup> joinedGroups) {
    this.joinedGroups = joinedGroups;
  }

  /**
   * Adds group to which is user trying to join to the list
   *
   * @param joinedGroup Group to which is user trying to join
   */
  public void addJoinedGroup(UserGroup joinedGroup) {
    this.joinedGroups.add(joinedGroup);
  }

  /**
   * Gets List of groups to be leaved
   *
   * @return Returns list of groups to be leaved
   */
  public ArrayList<UserGroup> getLeavedGroups() {
    return leavedGroups;
  }

  /**
   * Sets the list of groups to be leaved
   *
   * @param leavedGroups List of groups to be leaved
   */
  public void setLeavedGroups(ArrayList<UserGroup> leavedGroups) {
    this.leavedGroups = leavedGroups;
  }

  /**
   * Adds group to be leaved to the list
   *
   * @param leavedGroup Group to be leaved
   */
  public void addLeavedGroup(UserGroup leavedGroup) {
    this.leavedGroups.add(leavedGroup);
  }

  /**
   * Gets indicator whether is only one message sent that was session
   *
   * @return Returns indicator whether is only one message sent that was session
   */
  public boolean isSessionOnly() {
    return sessionOnly;
  }

  /**
   * Sets whether is only one message sent that was session
   *
   * @param sessionOnly Indicator whether is only one message sent that was session
   */
  public void setSessionOnly(boolean sessionOnly) {
    this.sessionOnly = sessionOnly;
  }

  /**
   * Gets URI ofuser group in which are queried attributes from ontology
   * 
   * @return Returns URI of user group in which are queried attributes from ontology
   */
  public String getQueryTypeAttOnto() {
    return queryTypeAttOnto;
  }

  /**
   * Sets URI of user group in which are queried attributes from ontology
   *
   * @param queryTypeAttOnto URI of user group in which are queried attributes from ontology
   */
  public void setQueryTypeAttOnto(String queryTypeAttOnto) {
    this.queryTypeAttOnto = queryTypeAttOnto;
  }
  
  /**
   * Gets sent text modifications which should be applied to document.
   * 
   * @return Sent text modifications which should be applied to document.
   */
  public ArrayList<TextModification> getTextModifications() {
    return textModifications;
  }

  /**
   * Sets identifier of last applied modification
   *
   * @param id Identifier of last applied modification
   */
  public void setLastModificationNumber(int id){
        this.lastModificationNumber = id;
  }

  /**
   * Gets last applied modification identifier
   *
   * @return Returns last applied modification identifier
   */
  public int getLastModificationNumber(){
        return lastModificationNumber;
  }

  /**
   * Adds sent text modifications which should be applied to document.
   * 
   * @param textModifications Sent text modifications which should be applied to document.
   */
  public void addTextModifications(ArrayList<TextModification> textModifications) {
    this.textModifications.addAll(textModifications);
  }
  
  /**
   * Adds sent text modification which should be applied to document.
   * 
   * @param textModification Sent text modification which should be applied to document.
   */
  public void addTextModification(TextModification textModification) {
    this.textModifications.add(textModification);
  }

  /**
   * Gets indicator of all entity types request.
   * 
   * @return indicator of all entity types request
   */
  public boolean isGetEntityTypes() {
    return getEntityTypes;
  }

  /**
   * Sets indicator of all entity types request.
   * 
   * @param getEntityTypes indicator of all entity types request
   */
  public void setGetEntityTypes(boolean getEntityTypes) {
    this.getEntityTypes = getEntityTypes;
  }
  
  /**
   * Gets request of controlled dictionary entity.
   * 
   * @return request of controlled dictionary entity
   */
  public EntityRequest getEntityRequest() {
    return entityRequest;
  }

  /**
   * Sets request of controlled dictionary entity.
   * 
   * @param entityRequest request of controlled dictionary entity
   */
  public void setEntityRequest(EntityRequest entityRequest) {
    this.entityRequest = entityRequest;
  }

  /**
   * Gets version of document before changes.
   * 
   * @return version of document before changes
   */
  public String getOldDocumentVersion() {
    return oldDocumentVersion;
  }

  /**
   * Gets queried persons attribues for protocol version 2.0.
   * 
   * @return queried persons attribues
   */
  public ArrayList<String> getUsersQueryV2() {
    return usersQueryV2;
  }

  /**
   * Sets queried persons attribues for protocol version 2.0.
   * 
   * @param usersQueryV2 queried persons attribues
   */
  public void setUsersQueryV2(ArrayList<String> usersQueryV2) {
    this.usersQueryV2 = usersQueryV2;
  }

  /**
   * Gets queried persons restrictions for protocol version 2.0.
   * 
   * @return queried persons restrictions
   */
  public boolean[] getUsersRestrictionsV2() {
    return usersRestrictionsV2;
  }

  /**
   * Sets queried persons restrictions for protocol version 2.0.
   * 
   * @param usersRestrictionsV2 queried persons restrictions
   */
  public void setUsersRestrictionsV2(boolean[] usersRestrictionsV2) {
    this.usersRestrictionsV2 = usersRestrictionsV2;
  }

  /**
   * Gets queried users groups attribues for protocol version 2.0.
   * 
   * @return queried users groups attribues
   */
  public ArrayList<String> getGroupsQueryV2() {
    return groupsQueryV2;
  }

  /**
   * Sets queried users groups attribues for protocol version 2.0.
   * 
   * @param groupsQueryV2 queried users groups attribues
   */
  public void setGroupsQueryV2(ArrayList<String> groupsQueryV2) {
    this.groupsQueryV2 = groupsQueryV2;
  }

  /**
   * Gets queried user groups persons restrictions for protocol version 2.0.
   * 
   * @return persons restrictions
   */
  public boolean[] getUsersGroupRestrictionsV2() {
    return usersGroupRestrictionsV2;
  }

  /**
   * Sets queried user groups persons restrictions for protocol version 2.0.
   * 
   * @param usersGroupRestrictionsV2 persons restrictions
   */
  public void setUsersGroupRestrictionsV2(boolean[] usersGroupRestrictionsV2) {
    this.usersGroupRestrictionsV2 = usersGroupRestrictionsV2;
  }

  /**
   * Gets list of just subscribed subscriptions
   * 
   * @return Returns list of just subscribed subscriptions
   */
  public ArrayList<Subscription> getSubscribeList() {
    return subscribeList;
  }

  /**
   * Sets list of just subscribed subscriptions
   * 
   * @param subscribeList List of just subscribed subscriptions
   */
  public void setSubscribeList(ArrayList<Subscription> subscribeList) {
    this.subscribeList = subscribeList;
  }

  /**
   * Adds subscription into list of just subscribed subscriptions
   * 
   * @param subscription Just subscribed subscription
   */
  public void addToSubscribe(Subscription subscription) {
    this.subscribeList.add(subscription);
  }

  /**
   * Gets list of just unsubscribed subscriptions
   * 
   * @return Returns list of just unsubscribed subscriptions
   */
  public ArrayList<Subscription> getUnsubscribeList() {
    return unsubscribeList;
  }

  /**
   * Sets list of just unsubscribed subscriptions
   * 
   * @param unsubscribeList List of just unsubscribed subscriptions
   */
  public void setUnsubscribeList(ArrayList<Subscription> unsubscribeList) {
    this.unsubscribeList = unsubscribeList;
  }

  /**
   * Adds just unsubscribed subscription into list of just unsubscribed subscriptions
   * 
   * @param subscription Just unsubscribed subscription
   */
  public void addToUnsubscribe(Subscription subscription) {
    this.unsubscribeList.add(subscription);
  }

  /**
   * Gets array of updated user subscriptions
   * 
   * @return Return array of updated user subscriptions
   */
  public ArrayList<Subscription> getUpdatedSubscriptions() {
    return updatedSubscriptions;
  }

  /**
   * Adds updated subscription into array of updated user subscriptions
   * 
   * @param updatedSubscription Updated subscription
   */
  public void addUpdatedSubscriptions(Subscription updatedSubscription) {
    this.updatedSubscriptions.add(updatedSubscription);
  }
  
  /**
   * Sets array of updated user subscriptions
   * 
   * @param updatedSubscriptions Array of updated user subscriptions
   */
  public void setUpdatedSubscriptions(ArrayList<Subscription> updatedSubscriptions) {
    this.updatedSubscriptions = updatedSubscriptions;
  }

  /**
   * Gets array of deleted user subscriptions
   * 
   * @return Returns array of deleted user subscriptions
   */
  public ArrayList<Subscription> getDeletedSubscriptions() {
    return deletedSubscriptions;
  }

  /**
   * Adds subscription into array of deleted user subscriptions
   * 
   * @param deletedSubscription Deleted user subscription
   */
  public void addDeletedSubscription(Subscription deletedSubscription) {
    this.deletedSubscriptions.add(deletedSubscription);
  }
  
  /**
   * Sets array of deleted user subscriptions
   * 
   * @param deletedSubscriptions Array of deleted user subscriptions
   */
  public void setDeletedSubscriptions(ArrayList<Subscription> deletedSubscriptions) {
    this.deletedSubscriptions = deletedSubscriptions;
  }

  /**
   * Gets array of added user subscriptions
   * 
   * @return Returns array of added user subscriptions
   */
  public ArrayList<Subscription> getNewSubscriptions() {
    return newSubscriptions;
  }

  /**
   * Adds new subscription into array of added user subscriptions
   * 
   * @param newSubscription New user subscription
   */
  public void addNewSubscriptions(Subscription newSubscription) {
    this.newSubscriptions.add(newSubscription);
  }
  
  /**
   * Sets array of added user subscriptions
   * 
   * @param newSubscriptions Array of added user subscriptions
   */
  public void setNewSubscriptions(ArrayList<Subscription> newSubscriptions) {
    this.newSubscriptions = newSubscriptions;
  }

  /**
   * Gets array of subscriptions before update
   * 
   * @return Returns array of subscriptions before update
   */
  public ArrayList<Subscription> getBeforeUpdatedSubscriptions() {
    return beforeUpdatedSubscriptions;
  }

  /**
   * Sets array of subscriptions before update
   * 
   * @param beforeUpdatedSubscriptions Array of subscriptions before update
   */
  public void setBeforeUpdatedSubscriptions(ArrayList<Subscription> beforeUpdatedSubscriptions) {
    this.beforeUpdatedSubscriptions = beforeUpdatedSubscriptions;
  }
  
  /**
   * Adds subscription into array of subscriptions before update
   * 
   * @param beforeUpdatedSubscriptions Subscription before update
   */
  public void addBeforeUpdatedSubscriptions(Subscription beforeUpdatedSubscriptions) {
    this.beforeUpdatedSubscriptions.add(beforeUpdatedSubscriptions);
  }

  /**
   * Gets array with parameters of subscription query
   * 
   * @return Returns array with parameters of subscription query
   */
  public ArrayList<String> getSubscriptionQuery() {
    return subscriptionQuery;
  }

  /**
   * Sets array with parameters of subscription query
   * 
   * @param subscriptionQuery Array with parameters of subscription query
   */
  public void setSubscriptionQuery(ArrayList<String> subscriptionQuery) {
    this.subscriptionQuery = subscriptionQuery;
  }
  
  /**
   * Sets minimal confidence 
   *  
   * @param minConfidence Number of minimal confidence
   */
  public void setMinConfidence(Integer minConfidence){
    this.minConfidence = minConfidence;
  }

  /**
   * Gets number of minimal confidence
   *
   * @return number of minimal confidence
   */
  public Integer getMinConfidence(){
    return minConfidence;
  }
  
  /**
   * Gets information about request for autoconfirm suggestions.
   *
   * @return information about autoconfirm suggestions
   */
  public boolean isAutoconfirmRequested() {
    return autoconfirmRequested;
  }

  /**
   * Sets information about request for autoconfirm suggestions.
   *
   * @param autoconfirmRequested information about autoconfirm suggestions
   */
  public void setAutoconfirmRequested(boolean autoconfirmRequested) {
    this.autoconfirmRequested = autoconfirmRequested;
  }

  /**
   * Gets list of automatically confirmed suggestions
   * 
   * @return Returns list of automatically confirmed suggestions
   */
  public ArrayList<SuggestionLogEntry> getAutoconfirmedSuggestions() {
    return autoconfirmedSuggestions;
  }

  /**
   * Sets list of automatically confirmed suggestions
   * 
   * @param autoconfirmedSuggestions List of automatically confirmed suggestions
   */
  public void setAutoconfirmedSuggestions(ArrayList<SuggestionLogEntry> autoconfirmedSuggestions) {
    this.autoconfirmedSuggestions = autoconfirmedSuggestions;
  }
  
  /**
   * Adds suggestion into list of automatically confirmed suggestions 
   * 
   * @param autoconfirmedSuggestion Automatically confirmed suggestions
   */
  public void addAutoconfirmedSuggestion(SuggestionLogEntry autoconfirmedSuggestion) {
    this.autoconfirmedSuggestions.add(autoconfirmedSuggestion);
  }
  
  /**
   * Auxiliary class to query the dictionary entity.
   * 
   * @brief Holds information about the query to dictionary entries.
   * @author Martin Petr
   */
  public static class EntityRequest{
    /** Type of dictionary entity */
    private String type;
    /** Filter of dictionary entities */
    private String filter;
    /** Maximum number of results */
    private Integer maxResults;

    /**
     * Constructor.
     */
    public EntityRequest() {
    }

    /**
     * Constructor.
     * 
     * @param type type of dictionary entity
     * @param filter filter of dictionary entities
     */
    public EntityRequest(String type, String filter) {
      this.type = type;
      this.filter = filter;
    }

    /**
     * Constructor.
     * 
     * @param type type of dictionary entity
     * @param filter filter of dictionary entities
     * @param maxResults Maximum number of results
     */
    public EntityRequest(String type, String filter, Integer maxResults) {
      this.type = type;
      this.filter = filter;
      this.maxResults = maxResults;
    }

    /**
     * Gets type of dictionary entity.
     * 
     * @return type of dictionary entity
     */
    public String getType() {
      return type;
    }

    /**
     * Sets type of dictionary entity.
     * 
     * @param type type of dictionary entity
     */
    public void setType(String type) {
      this.type = type;
    }

    /**
     * Gets filter of dictionary entities.
     * 
     * @return filter of dictionary entities
     */
    public String getFilter() {
      return filter;
    }

    /**
     * Sets filter of dictionary entities.
     * 
     * @param filter filter of dictionary entities
     */
    public void setFilter(String filter) {
      this.filter = filter;
    }

    /**
     * Gets maximum number of results.
     * 
     * @return maximum number of results
     */
    public Integer getMaxResults() {
      return maxResults;
    }

    /**
     * Sets maximum number of results.
     * 
     * @param maxResults Maximum number of results
     */
    public void setMaxResults(Integer maxResults) {
      this.maxResults = maxResults;
    }
  }
} // class RequestInfo