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:: Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.concurrent.ConcurrentHashMap
  ConcurrentHashMap.KeySetView<K extends Object,V extends Object>
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K extends Object,V extends Object>

Field Summary

Fields
Modifier and Type Field Description

protected boolean isAnonymize

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addRequestType(EFormRequestType requestType)`
`void`	`close()`
`com.alibaba.fastjson.JSONObject`	`createUserDataJSON()`
`UUID`	`getClientUuid()`
`Benutzer`	`getFormBenutzer()`	Deprecated. user `getUser()`
`long`	`getFormVersionId()`
`String`	`getId()`
`EFormRequestType`	`getInitialRequestType()`
`Locale`	`getLocale()`
`long`	`getMandantId()`
`EFormRequestType`	`getMostRecentRequestType()`
`String`	`getProcessId()`	Gets the `process ID` of the `form record`, if this FRQ session is associated with a form record.
`long`	`getProjectId()`
`EFormRequestType`	`getRequestType()`	Deprecated. Use `getMostRecentRequestType()`
`List<EFormRequestType>`	`getRequestTypes()`	During a single FRQ session, multiple HTTP requests may be made.
`String`	`getRequestUrl()`
`Benutzer`	`getUser()`	Deprecated. Use `getUserModel()` instead.
`List<BenutzerGruppe>`	`getUserGroups()`	Deprecated. Use `getUser()` & `IUser.getClientUserGroups(String, Mandant)` instead.
`com.alibaba.fastjson.JSONObject`	`getUserLdapData()`	Deprecated.
`IUser`	`getUserModel()`
`org.pac4j.core.profile.CommonProfile`	`getUserProfile()`
`XfcSession`	`getXfcSession()`	Deprecated.
`void`	`init(IFormRequestContext ctx)`
`boolean`	`isAnonymize()`
`boolean`	`isInProcess()`
`void`	`setAnonymize(boolean anonymize)`
`void`	`setFormBenutzer(Benutzer ben)`	Deprecated. user `setUser(Benutzer)`
`void`	`setInProcess(boolean inProcess)`
`void`	`setLocale(Locale locale)`
`void`	`setRequestType(EFormRequestType reqType)`	Deprecated. Use `setRequestTypes(List)` or `getRequestTypes().add()` to add a type.
`void`	`setRequestTypes(List<EFormRequestType> requestTypes)`	During a single FRQ session, multiple HTTP requests may be made.
`void`	`setRequestUrl(String requestUrl)`
`void`	`setUser(Benutzer formUser)`	Deprecated. Use `setUserModel(IUser)` instead.
`void`	`setUserGroups(List<BenutzerGruppe> userGroups)`	Deprecated. Use `getUser()` & `IUser.getClientUserGroups(String, Mandant)` instead.
`void`	`setUserLdapData(com.alibaba.fastjson.JSONObject userLdapData)`	Deprecated.
`void`	`setUserModel(IUser user)`
`void`	`setUserProfile(org.pac4j.core.profile.CommonProfile profile)`

Methods inherited from class java.util.concurrent.ConcurrentHashMap
clear, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, forEach, forEach, forEachEntry, forEachEntry, forEachKey, forEachKey, forEachValue, forEachValue, get, getOrDefault, hashCode, isEmpty, keys, keySet, keySet, mappingCount, merge, newKeySet, newKeySet, put, putAll, putIfAbsent, reduce, reduceEntries, reduceEntries, reduceEntriesToDouble, reduceEntriesToInt, reduceEntriesToLong, reduceKeys, reduceKeys, reduceKeysToDouble, reduceKeysToInt, reduceKeysToLong, reduceToDouble, reduceToInt, reduceToLong, reduceValues, reduceValues, reduceValuesToDouble, reduceValuesToInt, reduceValuesToLong, remove, remove, replace, replace, replaceAll, search, searchEntries, searchKeys, searchValues, size, toString, values

Methods inherited from class java.util.AbstractMap
clone

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

- Field Detail
  - isAnonymize
```
protected boolean isAnonymize
```
- Method Detail
  - 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:
    
    getInitialRequestType(), getRequestTypes()
  - getMostRecentRequestType
```
public EFormRequestType getMostRecentRequestType()
```
    Returns:
    
    The type of the most recent request that was made.
    
    See Also:
    
    getRequestTypes()
  - getInitialRequestType
```
public EFormRequestType getInitialRequestType()
```
    Returns:
    
    The type of the original request that started this FRQ session.
    
    See Also:
    
    getRequestTypes()
  - 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)

Class FRQSession

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ConcurrentHashMap

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Method Summary

Methods inherited from class java.util.concurrent.ConcurrentHashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

isAnonymize

Method Detail

getId

getMandantId

getClientUuid

getProjectId

getFormVersionId

getUserModel

setUserModel

getUserProfile

setUserProfile

getRequestUrl

setRequestUrl

getRequestTypes

setRequestTypes

getRequestType

getMostRecentRequestType

getInitialRequestType

addRequestType

setInProcess

isInProcess

setAnonymize

isAnonymize

init

createUserDataJSON

getProcessId

getLocale

setLocale

close

getUser

setUser

getUserGroups

setUserGroups

setRequestType

getXfcSession

getUserLdapData

setUserLdapData

getFormBenutzer

setFormBenutzer