Package de.xima.fc.session

Class FRQSession

java.lang.Object
java.util.AbstractMap<K,V>
java.util.concurrent.ConcurrentHashMap<Serializable,Serializable>
de.xima.fc.session.FRQSession
All Implemented Interfaces:
Serializable, AutoCloseable, ConcurrentMap<Serializable,Serializable>, Map<Serializable,Serializable>
public final class FRQSession extends ConcurrentHashMap<Serializable,Serializable> implements Map<Serializable,Serializable>, AutoCloseable, Serializable
See Also:

  • Field Details

    • isAnonymize

      protected boolean isAnonymize

  • Method Details

    • getId

      public String getId()
      Returns:
      the formSessionId

    • getMandantId

      public long getMandantId()
      Returns:
      The ID of the client to which the form belongs.

    • getClientUuid

      public UUID getClientUuid()
      Returns:
      The UUID of the client to which the form belongs.

    • getProjectId

      public long getProjectId()
      Returns:
      the projectId

    • getFormVersionId

      public long getFormVersionId()
      Returns:
      the formVersionId

    • getUserModel

      public IUser getUserModel()

    • setUserModel

      public void setUserModel(IUser user)

    • getUserProfile

      public org.pac4j.core.profile.CommonProfile getUserProfile()

    • setUserProfile

      public void setUserProfile(org.pac4j.core.profile.CommonProfile profile)

    • getRequestUrl

      public String getRequestUrl()

    • setRequestUrl

      public void setRequestUrl(String requestUrl)

    • getRequestTypes

      public List<EFormRequestType> getRequestTypes()
      During a single FRQ session, multiple HTTP requests may be made. For example, during the usual lifecycle of an FRQ session, the form is first requested (PROVIDE, REVIEW etc.) and subsequentially submitted (PROCESS). This method returns a list of all request types.
      Returns:
      All request types, with the first entry being the first request and the last entry being the most recent request.

    • setRequestTypes

      public void setRequestTypes(List<EFormRequestType> requestTypes)
      During a single FRQ session, multiple HTTP requests may be made. For example, during the usual lifecycle of an FRQ session, the form is first requested (PROVIDE, REVIEW etc.) and subsequentially submitted (PROCESS). This method returns a list of all request types.
      Parameters:
      requestTypes - All request types, with the first entry being the first request and the last entry being the most recent request.

    • getRequestType

      @Deprecated public EFormRequestType getRequestType()
      Deprecated.
      Use getMostRecentRequestType()
      Returns:
      The type of the most recent request that was made.
      See Also:

    • getMostRecentRequestType

      public EFormRequestType getMostRecentRequestType()
      Returns:
      The type of the most recent request that was made.
      See Also:

    • getInitialRequestType

      public EFormRequestType getInitialRequestType()
      Returns:
      The type of the original request that started this FRQ session.
      See Also:

    • addRequestType

      public void addRequestType(EFormRequestType requestType)

    • setInProcess

      public void setInProcess(boolean inProcess)

    • isInProcess

      public boolean isInProcess()

    • setAnonymize

      public void setAnonymize(boolean anonymize)

    • isAnonymize

      public boolean isAnonymize()

    • init

      public void init(IFormRequestContext ctx)

    • createUserDataJSON

      public com.alibaba.fastjson.JSONObject createUserDataJSON()

    • getProcessId

      public String getProcessId()
      Gets the process ID of the form record, if this FRQ session is associated with a form record. When a new form is opened, no form record was created yet.
      Returns:
      The process ID of the form record, or the empty string when this session does not have a form record.

    • getLocale

      public Locale getLocale()

    • setLocale

      public void setLocale(Locale locale)

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable

    • getUser

      @Deprecated public Benutzer getUser()
      Deprecated.
      Use getUserModel() instead.

    • setUser

      @Deprecated public void setUser(Benutzer formUser)
      Deprecated.
      Use setUserModel(IUser) instead.

    • getUserGroups

      @Deprecated public List<BenutzerGruppe> getUserGroups()
      Deprecated.
      Use getUser() & IUser.getClientUserGroups(String, Mandant) instead.

    • setUserGroups

      @Deprecated public void setUserGroups(List<BenutzerGruppe> userGroups)
      Deprecated.
      Use getUser() & IUser.getClientUserGroups(String, Mandant) instead.

    • setRequestType

      @Deprecated public void setRequestType(EFormRequestType reqType)
      Deprecated.
      Use setRequestTypes(List) or getRequestTypes().add() to add a type.
      Sets the type of the most recent request.
      Parameters:
      reqType - Request type to set.

    • getXfcSession

      @Deprecated public XfcSession getXfcSession()
      Deprecated.

    • getUserLdapData

      @Deprecated public com.alibaba.fastjson.JSONObject getUserLdapData()
      Deprecated.

    • setUserLdapData

      @Deprecated public void setUserLdapData(com.alibaba.fastjson.JSONObject userLdapData)
      Deprecated.

    • getFormBenutzer

      @Deprecated public Benutzer getFormBenutzer()
      Deprecated.
      user getUser()
      Returns:
      the user for this form-request

    • setFormBenutzer

      @Deprecated public void setFormBenutzer(Benutzer ben)
      Deprecated.
      user setUser(Benutzer)