de.innovationgate.wga.server.api

Class Session

java.lang.Object

de.innovationgate.wga.server.api.Session

public class Session
extends java.lang.Object

Information about the end-user session for which the current environment runs. This may be a HTTP session or a WebSocket session. If no end-user session is available on the environment no data is returned.

Method Summary

Methods

Modifier and Type	Method and Description
int	getAuthoringMode(Database db) Returns the current authoring mode regarding the given database.
int	getAuthoringMode(java.lang.String dbKey) Returns the current authoring mode regarding the given database.
java.lang.String	getId() Returns the id of the HTTP session, if available, else null
javax.servlet.http.HttpSession	getJavaHttpSession() Returns the JavaEE HTTP session object.
javax.websocket.Session	getJavaWebSocketSession() Returns the JavaEE WebSocket session object.
boolean	isAvailable() Returns if session data is available
boolean	isHttpSessionAvailable()
boolean	isNew() Returns if the session was just created and the client does not yet know about the session ID This is only informative if the session type is HTTP, returns true on WebSocket sessions.
boolean	isWebSocketSessionAvailable()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getJavaHttpSession

public javax.servlet.http.HttpSession getJavaHttpSession()
                                                  throws de.innovationgate.webgate.api.WGException

Returns the JavaEE HTTP session object. Only available if the session is a HTTP session.

Throws:

de.innovationgate.webgate.api.WGException

getJavaWebSocketSession

public javax.websocket.Session getJavaWebSocketSession()
                                                throws de.innovationgate.webgate.api.WGException

Returns the JavaEE WebSocket session object. Only available if the session is a WebSocket session.

Throws:

de.innovationgate.webgate.api.WGException

getAuthoringMode

public int getAuthoringMode(Database db)
                     throws de.innovationgate.webgate.api.WGException

Returns the current authoring mode regarding the given database.

Parameters:

db - The database

Returns:

The authoring mode as constant AUTHORINGMODE_...

Throws:

de.innovationgate.webgate.api.WGException

getAuthoringMode

public int getAuthoringMode(java.lang.String dbKey)
                     throws de.innovationgate.webgate.api.WGException

Returns the current authoring mode regarding the given database.

Parameters:

db - The database

Returns:

The authoring mode as constant AUTHORINGMODE_...

Throws:

de.innovationgate.webgate.api.WGException

isAvailable

public boolean isAvailable()

Returns if session data is available

isNew

public boolean isNew()
              throws de.innovationgate.webgate.api.WGException

Returns if the session was just created and the client does not yet know about the session ID This is only informative if the session type is HTTP, returns true on WebSocket sessions.

Throws:

de.innovationgate.webgate.api.WGException

isWebSocketSessionAvailable

public boolean isWebSocketSessionAvailable()

isHttpSessionAvailable

public boolean isHttpSessionAvailable()

getId

public java.lang.String getId()
                       throws de.innovationgate.webgate.api.WGException

Returns the id of the HTTP session, if available, else null

Throws:

de.innovationgate.webgate.api.WGException