WGSessionContext

java.lang.Object
- de.innovationgate.webgate.api.WGSessionContext

All Implemented Interfaces:

LockOwner
```
public class WGSessionContext
extends java.lang.Object
implements LockOwner
```
Contains all information about the current database session.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class WGSessionContext.DocumentContext

Nested Classes
Modifier and Type	Class and Description
`class`	`WGSessionContext.DocumentContext`

Field Summary

Fields
Modifier and Type	Field and Description
`static org.apache.log4j.Logger`	`LOG_COREFETCHING`
`static org.apache.log4j.Logger`	`LOG_SESSIONS`
`static java.lang.String`	`SATTRIB_BYPASS_PREEMTIVE_CACHING` Predefined attribute key to be placed via `setAttribute(Object, Object)` on a session to control "preemptive caching" behaviour, which automatically caches some frequently used values from a just retrieved document.
`static int`	`TRANSACTION_MODE_DEFAULT` The default transaction mode of this database backend.
`static int`	`TRANSACTION_MODE_MANUAL` Manual control of transaction commit by using `WGDatabase.startTransaction()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAfterTransactionTask(java.util.concurrent.Callable<java.lang.Object> r)`
`void`	`addFetchedCore(WGDocument doc, WGDocumentCore core)` Adds a fetched document core to the document cores list.
`void`	`clearCache()` Clears the session private cache including all fetched document cores.
`int`	`getAccessLevel()` The access level of the current user.
`java.lang.Object`	`getAttribute(java.lang.Object key)` Retrieves a custom attribute added to this session.
`AuthenticationSession`	`getAuthenticationSession()` Returns the session on the authentication module in use for this database session
`java.lang.String`	`getClient()` Returns the current client software which uses the WGAPI.
`java.util.Date`	`getCreated()` Returns the creation date of this session.
`java.lang.Object`	`getCredentials()` Returns the credentials object used to open this session
`java.util.Date`	`getDatabaseChangeDateAtStart()` Returns the last changed date that the opened database had at the beginning of this session
`java.util.List<WGDocument>`	`getEditedDocuments()` Returns a list of documents that were edited in the current session and have not yet been saved
`java.lang.String`	`getMasterTenantUser()` When this is a master session can hold the name of the user that triggered this master session
`int`	`getMaxDocs()` Returns the maximum number of backend documents that session may fetch at once.
`WGUserAccess`	`getOriginalUserAccess()` If an `UserAccessFilter` is active on the session returns the original user access of the current user without the filter.
`java.lang.String`	`getPassword()` The password used to open this session, if any
`java.lang.Comparable<?>`	`getRevisionAtStart()` Returns the database revision that was current when the session started
`java.lang.String`	`getSessionToken()` If the database supports feature WGDatabase.FEATURE_SESSIONTOKEN, a session token that can be used to reconnect to this database session after this WGA session has been closed.
`java.lang.String`	`getTask()` Returns the task the WGA client is executing in this session.
`int`	`getTotalFetchedCores()` Returns the total number of fetched cores in this session (without core reduction)
`int`	`getTransactionMode()` Returns the current transaction mode of the session of one of the constants WGSessionContext.TRANSACTION_MODE...
`java.lang.String`	`getUser()` The current users name.
`WGUserAccess`	`getUserAccess()` Returns the complete access rights information of current session
`WGUserDetails`	`getUserDetails()` Returns details about the current user if the DB implementation supports this, otherwise null.
`boolean`	`isActiveCore(WGDocumentCore core)` Checks ift the given document core is attached to the current session
`boolean`	`isAnonymous()` Determines, if this is an anonymous session
`boolean`	`isAnyDocumentEdited()` Determines if any document has been edited in the current session whose changes are not yet saved
`boolean`	`isBatchProcess()` Returns if the current session is marked as belonging to a batch process, processing mass data.
`boolean`	`isCacheWritingEnabled()` Returns if we currently may write to the cache.
`boolean`	`isCachingEnabled()` Determines, if caching is enabled for this session.
`boolean`	`isCascadeDeletions()` Determines, if cascaded deletions are active in this session (i.e. removing a parent document automatically removes it's children)
`boolean`	`isContentTypeEventsEnabled()` Returns if content type events are enabled for this session
`boolean`	`isDatabaseUpdated()` Determines, if this database has been updated since last session or inside this session.
`boolean`	`isDesigner()` Deprecated. There are no multiple designer access levels any more. Directly test for access level "manager" instead.
`boolean`	`isEventsEnabled()` Determines, if events are enabled in this session
`boolean`	`isEventThread()` Determines if the current session runs in the WGAPI event thread
`boolean`	`isMasterSession()` Returns if this session is a master session (i.e. build with databases master login)
`boolean`	`isMaxCoreMessageShowed()` Determines, if the message that the maxdocs threshold has been exceeded, has already been put out to the log.
`boolean`	`isProtectedRelationsEnabled()` Returns if protection for protected relations is enabled.
`boolean`	`isTestUniqueNames()` Determines if unique content names are tested before saving content.
`boolean`	`isTransactionActive()` Determines if a (real) manual transaction is currently in process
`void`	`removeAttribute(java.lang.String name)` Removes a session attribute
`void`	`resetTransactionMode()` Sets the transaction mode back to the initial transaction mode of the session
`void`	`setAttribute(java.lang.Object key, java.lang.Object value)` Sets a custom attribute to this session.
`void`	`setBatchProcess(boolean batchProcess)` Sets it this session is marked as belonging to a batch process.
`void`	`setCachingEnabled(boolean b)` Sets, if caching is enabled for this session.
`void`	`setCascadeDeletions(boolean b)` Sets if cascaded deletions (removing a parent document automatically removes it's children) should be enabled
`void`	`setClient(java.lang.String string)` Sets the WGA client software that is currently using the WGAPI.
`void`	`setContentTypeEventsEnabled(boolean contentTypeEventsEnabled)` Sets if content type events are enabled on this session
`void`	`setEventsEnabled(boolean b)` Sets if events should be enabled for this session
`void`	`setMasterTenantUser(java.lang.String masterTenantUser)` On master sessions can be used to set the name of the user that triggered the master session.
`void`	`setMaxDocs(int maxDocs)` Sets the maximum number of backend documents that the current session may fetch at once.
`void`	`setProtectedRelationsEnabled(boolean protectedRelationsEnabled)` Sets if protection for protected relations is enabled.
`void`	`setTask(java.lang.String string)` Sets the task that the current WGA client is accomplishing
`void`	`setTestUniqueNames(boolean b)` Sets if unique content names should be tested before storing content in this session
`void`	`setTransactionMode(int transactionMode)` Sets the transaction mode for this session.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOG_COREFETCHING
```
public static final org.apache.log4j.Logger LOG_COREFETCHING
```
  - LOG_SESSIONS
```
public static final org.apache.log4j.Logger LOG_SESSIONS
```
  - SATTRIB_BYPASS_PREEMTIVE_CACHING
```
public static final java.lang.String SATTRIB_BYPASS_PREEMTIVE_CACHING
```
    Predefined attribute key to be placed via setAttribute(Object, Object) on a session to control "preemptive caching" behaviour, which automatically caches some frequently used values from a just retrieved document. This is enabled by default. Store this with attribute value "false" to disable it.
    
    See Also:
    Constant Field Values
  - TRANSACTION_MODE_DEFAULT
```
public static final int TRANSACTION_MODE_DEFAULT
```
    The default transaction mode of this database backend. Should commit changes on every save() operation.
    
    See Also:
    Constant Field Values
  - TRANSACTION_MODE_MANUAL
```
public static final int TRANSACTION_MODE_MANUAL
```
    Manual control of transaction commit by using WGDatabase.startTransaction()
    
    See Also:
    Constant Field Values
- Method Detail
  - addFetchedCore
```
public void addFetchedCore(WGDocument doc,
                  WGDocumentCore core)
```
    Adds a fetched document core to the document cores list. This method implements the maxdocs reduction, where the number of parallel retrieved doc cores are reduced to the maxdocs setting on the database object.
    
    Parameters:
    doc -
  - getAccessLevel
```
public int getAccessLevel()
```
    The access level of the current user.
    
    Returns:
    A constant of WGDatabase.ACCESSLEVEL_...
  - getUserAccess
```
public WGUserAccess getUserAccess()
```
    Returns the complete access rights information of current session
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.Object key)
```
    Retrieves a custom attribute added to this session.
    
    Parameters:
    key - Name of the attribute
    
    Returns:
    The attribute value
  - getPassword
```
public java.lang.String getPassword()
```
    The password used to open this session, if any
  - getCredentials
```
public java.lang.Object getCredentials()
```
    Returns the credentials object used to open this session
  - getSessionToken
```
public java.lang.String getSessionToken()
                                 throws WGBackendException
```
    If the database supports feature WGDatabase.FEATURE_SESSIONTOKEN, a session token that can be used to reconnect to this database session after this WGA session has been closed.
    
    Throws:
    
    WGBackendException
  - getUser
```
public java.lang.String getUser()
```
    The current users name.
    
    Returns:
    Returns a String
  - isAnonymous
```
public boolean isAnonymous()
```
    Determines, if this is an anonymous session
  - isDatabaseUpdated
```
public boolean isDatabaseUpdated()
```
    Determines, if this database has been updated since last session or inside this session.
    
    Returns:
    Returns a boolean
  - isDesigner
```
public boolean isDesigner()
```
    Deprecated. There are no multiple designer access levels any more. Directly test for access level "manager" instead.
    
    Determine, if the current user has designer rights, i.e. the ability to edit Languages, File Containers, TML and CSS/JS modules
  - isTransactionActive
```
public boolean isTransactionActive()
```
    Determines if a (real) manual transaction is currently in process
  - setAttribute
```
public void setAttribute(java.lang.Object key,
                java.lang.Object value)
```
    Sets a custom attribute to this session. These attributes will get discarded when the session ends.
    
    Parameters:
    key - The attribute name
    value - The attribute value
  - isEventThread
```
public boolean isEventThread()
```
    Determines if the current session runs in the WGAPI event thread
  - isMasterSession
```
public boolean isMasterSession()
```
    Returns if this session is a master session (i.e. build with databases master login)
  - isEventsEnabled
```
public boolean isEventsEnabled()
```
    Determines, if events are enabled in this session
  - setEventsEnabled
```
public void setEventsEnabled(boolean b)
```
    Sets if events should be enabled for this session
    
    Parameters:
    b -
  - getUserDetails
```
public WGUserDetails getUserDetails()
                             throws WGAPIException
```
    Returns details about the current user if the DB implementation supports this, otherwise null.
    
    Throws:
    
    WGAPIException
  - isCascadeDeletions
```
public boolean isCascadeDeletions()
```
    Determines, if cascaded deletions are active in this session (i.e. removing a parent document automatically removes it's children)
  - setCascadeDeletions
```
public void setCascadeDeletions(boolean b)
```
    Sets if cascaded deletions (removing a parent document automatically removes it's children) should be enabled
    
    Parameters:
    b -
  - getClient
```
public java.lang.String getClient()
```
    Returns the current client software which uses the WGAPI.
  - setClient
```
public void setClient(java.lang.String string)
```
    Sets the WGA client software that is currently using the WGAPI.
    
    Parameters:
    string - A wga client string.
  - getTask
```
public java.lang.String getTask()
```
    Returns the task the WGA client is executing in this session. This must be set by the WGA client externally.
  - setTask
```
public void setTask(java.lang.String string)
```
    Sets the task that the current WGA client is accomplishing
    
    Parameters:
    string -
  - getTotalFetchedCores
```
public int getTotalFetchedCores()
```
    Returns the total number of fetched cores in this session (without core reduction)
  - isMaxCoreMessageShowed
```
public boolean isMaxCoreMessageShowed()
```
    Determines, if the message that the maxdocs threshold has been exceeded, has already been put out to the log.
  - isAnyDocumentEdited
```
public boolean isAnyDocumentEdited()
```
    Determines if any document has been edited in the current session whose changes are not yet saved
  - getCreated
```
public java.util.Date getCreated()
```
    Returns the creation date of this session.
  - isCachingEnabled
```
public boolean isCachingEnabled()
```
    Determines, if caching is enabled for this session.
  - isCacheWritingEnabled
```
public boolean isCacheWritingEnabled()
```
    Returns if we currently may write to the cache.
  - setCachingEnabled
```
public void setCachingEnabled(boolean b)
```
    Sets, if caching is enabled for this session.
    
    Parameters:
    b -
  - isTestUniqueNames
```
public boolean isTestUniqueNames()
```
    Determines if unique content names are tested before saving content.
  - setTestUniqueNames
```
public void setTestUniqueNames(boolean b)
```
    Sets if unique content names should be tested before storing content in this session
    
    Parameters:
    b -
  - getMaxDocs
```
public int getMaxDocs()
```
    Returns the maximum number of backend documents that session may fetch at once.
  - setMaxDocs
```
public void setMaxDocs(int maxDocs)
```
    Sets the maximum number of backend documents that the current session may fetch at once. If more documents are used by this session the oldest document gets disposed (and must be fetched again if it will be used again). This defaults to 2000 for normal, 100 for batch processes.
    
    Parameters:
    maxDocs - The maxDocs to set.
  - isBatchProcess
```
public boolean isBatchProcess()
```
    Returns if the current session is marked as belonging to a batch process, processing mass data.
  - setBatchProcess
```
public void setBatchProcess(boolean batchProcess)
```
    Sets it this session is marked as belonging to a batch process. A session that is marked for batch processing will have many caches deactivated and will have getMaxDocs()=100 (if MaxDocs setting is not below that).
  - getDatabaseChangeDateAtStart
```
public java.util.Date getDatabaseChangeDateAtStart()
```
    Returns the last changed date that the opened database had at the beginning of this session
  - getEditedDocuments
```
public java.util.List<WGDocument> getEditedDocuments()
```
    Returns a list of documents that were edited in the current session and have not yet been saved
  - getAuthenticationSession
```
public AuthenticationSession getAuthenticationSession()
```
    Returns the session on the authentication module in use for this database session
  - clearCache
```
public void clearCache()
                throws WGAPIException
```
    Clears the session private cache including all fetched document cores. Note: All unsaved document modifications will be gone after calling this method
    
    Throws:
    
    WGAPIException
  - isProtectedRelationsEnabled
```
public boolean isProtectedRelationsEnabled()
```
    Returns if protection for protected relations is enabled. Defaults to true. This protection will prevent contents from being removed while they are the target of a protected relation.
  - setProtectedRelationsEnabled
```
public void setProtectedRelationsEnabled(boolean protectedRelationsEnabled)
```
    Sets if protection for protected relations is enabled. Defaults to true. This protection will prevent contents from being removed while they are the target of a protected relation.
  - isContentTypeEventsEnabled
```
public boolean isContentTypeEventsEnabled()
```
    Returns if content type events are enabled for this session
  - setContentTypeEventsEnabled
```
public void setContentTypeEventsEnabled(boolean contentTypeEventsEnabled)
```
    Sets if content type events are enabled on this session
  - setTransactionMode
```
public void setTransactionMode(int transactionMode)
```
    Sets the transaction mode for this session. Never use that directly. Control transactions using WGDatabase.startTransaction() and the methods of the returned WGTransaction object
    
    Parameters:
    transactionMode - The transaction mode. Use constants WGSessionContext.TRANSACTION_MODE...
  - getTransactionMode
```
public int getTransactionMode()
```
    Returns the current transaction mode of the session of one of the constants WGSessionContext.TRANSACTION_MODE...
  - resetTransactionMode
```
public void resetTransactionMode()
```
    Sets the transaction mode back to the initial transaction mode of the session
  - removeAttribute
```
public void removeAttribute(java.lang.String name)
```
    Removes a session attribute
    
    Parameters:
    name - Then name of the attribute
  - getRevisionAtStart
```
public java.lang.Comparable<?> getRevisionAtStart()
```
    Returns the database revision that was current when the session started
  - getOriginalUserAccess
```
public WGUserAccess getOriginalUserAccess()
```
    If an UserAccessFilter is active on the session returns the original user access of the current user without the filter. If no filter is active returns null.
  - getMasterTenantUser
```
public java.lang.String getMasterTenantUser()
```
    When this is a master session can hold the name of the user that triggered this master session
  - setMasterTenantUser
```
public void setMasterTenantUser(java.lang.String masterTenantUser)
                         throws WGAPIException
```
    On master sessions can be used to set the name of the user that triggered the master session. This information will be put out on the user name within this master session.
    
    Parameters:
    masterTenantUser -
    
    Throws:
    
    WGAPIException
  - isActiveCore
```
public boolean isActiveCore(WGDocumentCore core)
                     throws WGAPIException
```
    Checks ift the given document core is attached to the current session
    
    Returns:
    True if the core is still active, false if it is no longer attached and the same document is now represented by a differen core instance
    
    Throws:
    
    WGAPIException
  - addAfterTransactionTask
```
public void addAfterTransactionTask(java.util.concurrent.Callable<java.lang.Object> r)
```

Class WGSessionContext

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG_COREFETCHING

LOG_SESSIONS

SATTRIB_BYPASS_PREEMTIVE_CACHING

TRANSACTION_MODE_DEFAULT

TRANSACTION_MODE_MANUAL

Method Detail

addFetchedCore

getAccessLevel

getUserAccess

getAttribute

getPassword

getCredentials

getSessionToken

getUser

isAnonymous

isDatabaseUpdated

isDesigner

isTransactionActive

setAttribute

isEventThread

isMasterSession

isEventsEnabled

setEventsEnabled

getUserDetails

isCascadeDeletions

setCascadeDeletions

getClient

setClient

getTask

setTask

getTotalFetchedCores

isMaxCoreMessageShowed

isAnyDocumentEdited

getCreated

isCachingEnabled

isCacheWritingEnabled

setCachingEnabled

isTestUniqueNames

setTestUniqueNames

getMaxDocs

setMaxDocs

isBatchProcess

setBatchProcess

getDatabaseChangeDateAtStart

getEditedDocuments

getAuthenticationSession

clearCache

isProtectedRelationsEnabled

setProtectedRelationsEnabled

isContentTypeEventsEnabled

setContentTypeEventsEnabled

setTransactionMode

getTransactionMode

resetTransactionMode

removeAttribute

getRevisionAtStart

getOriginalUserAccess

getMasterTenantUser

setMasterTenantUser

isActiveCore

addAfterTransactionTask