com.sibvisions.rad.server
Class AbstractSession

java.lang.Object
  com.sibvisions.rad.server.AbstractSession

All Implemented Interfaces:

ISession

public abstract class AbstractSession
extends java.lang.Object
implements ISession

A Session is a server side session which will be started when an IConnection connects to a remote server.
The session persists for a specified time period, across more than one request from the IConnection.

See Also:

ISession

Field Summary

protected ChangedHashtable<java.lang.String,java.lang.Object>	chtExternalProperties the properties got via constructor.
protected ChangedHashtable<java.lang.String,java.lang.Object>	chtProperties the client and server properties.
protected ILogger	log the log instance.

Method Summary

protected void	addCallBackResult(ResultObject pResult) Adds the result of an asynchronous call to the cache.
java.lang.Object	call(java.lang.String pObjectName, java.lang.String pMethod, java.lang.Object... pParams) Executes a method from an object in the life-cycle object.
java.lang.Object	callAction(java.lang.String pAction, java.lang.Object... pParams) Executes an action from the life-cycle object.
protected void	checkAccess() Checks if it is allowed to create the session.
protected java.lang.Object	executeWithSessionContext(SessionContext pContext, com.sibvisions.rad.server.Call pCall) Executes a remote method call.
java.lang.Object	get(java.lang.String pObjectName) Gets an object from the life-cycle object.
abstract IAccessController	getAccessController() Gets the IAccessController for checking the access to server side objects and calls.
long	getAliveInterval() Gets the desired client-side communication interval for this session.
java.lang.String	getApplicationName() Gets the associated application name of the session.
protected abstract ApplicationZone	getApplicationZone() Gets the application zone for which the session was created.
java.lang.Object	getId() Gets the session identifier.
long	getLastAccessTime() Gets the time of the last session access.
long	getLastAliveTime() Gets the time of the last communication of the session.
java.lang.String	getLifeCycleName() Gets the name of the life-cycle object.
int	getMaxInactiveInterval() Returns the maximum time interval, in seconds, that this session will be active.
InjectObject	getObject(java.lang.String pName) Gets an object from the cache.
java.lang.String	getPassword() Gets the sessions password.
ChangedHashtable<java.lang.String,java.lang.Object>	getProperties() Gets a reference to the internal properties.
java.lang.Object	getProperty(java.lang.String pName) Gets the value of a property.
protected DefaultSessionManager	getSessionManager() Gets the session manager for this session.
long	getStartTime() Gets the session start/create time.
java.lang.String	getUserName() Gets the sessions user name.
protected void	initMaxAliveInterval(ChangedHashtable<java.lang.String,java.lang.Object> pProperties, Zone pZone) Initializes the max alive interval.
protected void	initMaxInactiveInterval(ChangedHashtable<java.lang.String,java.lang.Object> pProperties, Zone pZone, java.lang.String pScope, int pDefault) Initializes the max inactive interval.
boolean	isAlive(long pAccessTime) Checks if the session is alive.
protected boolean	isExecuting() Returns whether the session is execution at least one command.
boolean	isInactive(long pAccessTime) Checks if the session is inactive.
boolean	isLocked() Gets whether the session is locked.
protected boolean	isMaxAliveIntervalExceeded(long pAccessTime) Gets whether the alive interval is exceeded.
void	lock() Sets the session locked.
protected Record	openRecord(java.lang.String pCommand, java.lang.Object... pParameter) Opens a record.
java.lang.Object	put(java.lang.String pObjectName, java.lang.Object pObject) Puts an object to the life-cycle object.
InjectObject	putObject(InjectObject pObject) Puts an object to the cache.
InjectObject	removeObject(InjectObject pObject) Removes an object from the cache.
void	setAliveInterval(long pAliveInterval) Sets the desired client-side communication interval for this session.
protected void	setExecuting(boolean pExecuting) Sets that the session is executiong a command.
void	setLastAccessTime(long pLastAccessTime) Sets the time of the last session access.
void	setLastAliveTime(long pLastAliveTime) Sets the time of the last communication of the session.
void	setMaxInactiveInterval(int pMaxInactiveInterval) Specifies the time, in seconds, before the session will be inactive.
abstract void	setNewPassword(java.lang.String pOldPassword, java.lang.String pNewPassword) Sets the new password for the current session.
void	setPassword(java.lang.String pPassword) Sets the session password.
protected void	setProperties(java.util.List<java.lang.Object[]> pProperties) Sets multiple properties.
void	setProperty(java.lang.String pName, java.lang.Object pValue) Sets a property.
protected void	setPropertyIntern(java.lang.String pName, java.lang.Object pValue) Sets internal members with property values.
void	setUserName(java.lang.String pUserName) Sets the sessions user name.
void	unlock() Unlocks the session.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.rad.server.ISession

getConfig

Field Detail

log

protected ILogger log

the log instance.

chtProperties

protected ChangedHashtable<java.lang.String,java.lang.Object> chtProperties

the client and server properties.

chtExternalProperties

protected ChangedHashtable<java.lang.String,java.lang.Object> chtExternalProperties

the properties got via constructor.

Method Detail

getApplicationZone

protected abstract ApplicationZone getApplicationZone()

Gets the application zone for which the session was created.

Returns:

the application zone

getAccessController

public abstract IAccessController getAccessController()

Gets the IAccessController for checking the access to server side objects and calls.

Returns:

the object inspector or null if no inspector is available

setNewPassword

public abstract void setNewPassword(java.lang.String pOldPassword,
                                    java.lang.String pNewPassword)
                             throws java.lang.Exception

Sets the new password for the current session.

Parameters:

pOldPassword - the old password

pNewPassword - the new password

Throws:

java.lang.Exception - if the password can not be changed

getId

public java.lang.Object getId()

Gets the session identifier.

Specified by:

getId in interface ISession

Returns:

session id

getLifeCycleName

public java.lang.String getLifeCycleName()

Gets the name of the life-cycle object.

Specified by:

getLifeCycleName in interface ISession

Returns:

the name of the life-cycle object

getApplicationName

public final java.lang.String getApplicationName()

Gets the associated application name of the session.

Specified by:

getApplicationName in interface ISession

Returns:

service name

getUserName

public final java.lang.String getUserName()

Gets the sessions user name.

Specified by:

getUserName in interface ISession

Returns:

the user name

getPassword

public final java.lang.String getPassword()

Gets the sessions password.

Specified by:

getPassword in interface ISession

Returns:

the password

getProperty

public java.lang.Object getProperty(java.lang.String pName)

Gets the value of a property. The access time will be updated.

Specified by:

getProperty in interface ISession

Parameters:

pName - the property name

Returns:

the value of the property or null if the property is not available

getStartTime

public long getStartTime()

Gets the session start/create time.

Specified by:

getStartTime in interface ISession

Returns:

start time in millis

getLastAccessTime

public long getLastAccessTime()

Gets the time of the last session access.

Specified by:

getLastAccessTime in interface ISession

Returns:

access time in millis

setMaxInactiveInterval

public void setMaxInactiveInterval(int pMaxInactiveInterval)

Specifies the time, in seconds, before the session will be inactive. A zero or negative time indicates the session should never be inactive.

Specified by:

setMaxInactiveInterval in interface ISession

Parameters:

pMaxInactiveInterval - time in seconds

getMaxInactiveInterval

public int getMaxInactiveInterval()

Returns the maximum time interval, in seconds, that this session will be active. After this interval, the session is inactive. The maximum time interval can be set with the setMaxInactiveInterval method. A zero or negative time indicates the session should never be inactive.

Specified by:

getMaxInactiveInterval in interface ISession

Returns:

time in seconds

See Also:

ISession.setMaxInactiveInterval(int)

isInactive

public boolean isInactive(long pAccessTime)

Checks if the session is inactive.

Specified by:

isInactive in interface ISession

Parameters:

pAccessTime - current access time

Returns:

true if the session is inactive

See Also:

ISession.getMaxInactiveInterval(), ISession.getLastAccessTime()

getLastAliveTime

public long getLastAliveTime()

Gets the time of the last communication of the session.

Specified by:

getLastAliveTime in interface ISession

Returns:

the last communication/alive time

setAliveInterval

public void setAliveInterval(long pAliveInterval)

Sets the desired client-side communication interval for this session.

Specified by:

setAliveInterval in interface ISession

Parameters:

pAliveInterval - the alive interval (client-side)

getAliveInterval

public long getAliveInterval()

Gets the desired client-side communication interval for this session.

Specified by:

getAliveInterval in interface ISession

Returns:

the alive interval (client-side)

isAlive

public boolean isAlive(long pAccessTime)

Checks if the session is alive. That means the client sends alive messages. The session is not alive if the client doesn't send alive messages during 4 times of the desired alive interval.

Specified by:

isAlive in interface ISession

Parameters:

pAccessTime - current access time

Returns:

true if the session is alive

See Also:

ISession.getLastAliveTime(), ISession.getAliveInterval()

call

public java.lang.Object call(java.lang.String pObjectName,
                             java.lang.String pMethod,
                             java.lang.Object... pParams)
                      throws java.lang.Throwable

Executes a method from an object in the life-cycle object.

Specified by:

call in interface ISession

Parameters:

pObjectName - list of already mapped server object name/alias

pMethod - method name which should be called

pParams - parameters for the method call

Returns:

result of method call or null if it's an asynchronous method call

Throws:

java.lang.Throwable - if the object identified by pObjectName was found but can not be created

java.lang.SecurityException - if the method call is not allowed

callAction

public java.lang.Object callAction(java.lang.String pAction,
                                   java.lang.Object... pParams)
                            throws java.lang.Throwable

Executes an action from the life-cycle object.

Specified by:

callAction in interface ISession

Parameters:

pAction - action which should be called

pParams - the parameters for the action call

Returns:

result from the action call

Throws:

java.lang.Throwable - communication error, security checks, invalid action, ...

get

public java.lang.Object get(java.lang.String pObjectName)
                     throws java.lang.Throwable

Gets an object from the life-cycle object.

Specified by:

get in interface ISession

Parameters:

pObjectName - the object name

Returns:

the object

Throws:

java.lang.Throwable - if the object was not found or an error occured during object creation

put

public java.lang.Object put(java.lang.String pObjectName,
                            java.lang.Object pObject)
                     throws java.lang.Throwable

Puts an object to the life-cycle object.

Specified by:

put in interface ISession

Parameters:

pObjectName - the object name

pObject - the object

Returns:

the object if an object was already specified

Throws:

java.lang.Throwable - if an unknown error occurs while putting the object

setUserName

public final void setUserName(java.lang.String pUserName)

Sets the sessions user name.

Parameters:

pUserName - the user name

setPassword

public final void setPassword(java.lang.String pPassword)

Sets the session password.

Parameters:

pPassword - the password

setLastAccessTime

public void setLastAccessTime(long pLastAccessTime)

Sets the time of the last session access.

Parameters:

pLastAccessTime - access time in millis

setLastAliveTime

public void setLastAliveTime(long pLastAliveTime)

Sets the time of the last communication of the session.

Parameters:

pLastAliveTime - the last communication/alive time

executeWithSessionContext

protected java.lang.Object executeWithSessionContext(SessionContext pContext,
                                                     com.sibvisions.rad.server.Call pCall)
                                              throws java.lang.Throwable

Executes a remote method call. This method can be overwritten from sub classes.

Parameters:

pContext - the current session context

pCall - the call information

Returns:

result of method call or null if it's an asynchronous method call

Throws:

java.lang.Throwable - if an exception occurs during call

java.lang.SecurityException - if the call is not allowed

addCallBackResult

protected void addCallBackResult(ResultObject pResult)

Adds the result of an asynchronous call to the cache.

Parameters:

pResult - the result of an asynchronous call

setProperty

public void setProperty(java.lang.String pName,
                        java.lang.Object pValue)

Sets a property. The access time will be updated.

Specified by:

setProperty in interface ISession

Parameters:

pName - the property name

pValue - the value of the property or null to delete the property

setProperties

protected void setProperties(java.util.List<java.lang.Object[]> pProperties)

Sets multiple properties.

Parameters:

pProperties - the key/value paris as list of Object[]

setPropertyIntern

protected final void setPropertyIntern(java.lang.String pName,
                                       java.lang.Object pValue)

Sets internal members with property values. The alive time will be updated.

Parameters:

pName - the property name

pValue - the property value

getProperties

public ChangedHashtable<java.lang.String,java.lang.Object> getProperties()

Gets a reference to the internal properties.

Specified by:

getProperties in interface ISession

Returns:

the session properties

getSessionManager

protected DefaultSessionManager getSessionManager()

Gets the session manager for this session.

Returns:

the session manager

putObject

public InjectObject putObject(InjectObject pObject)

Puts an object to the cache. If an object with the same name is already added, it will be replaced.

Parameters:

pObject - the object to inject

Returns:

the previous object or null if there was no object with the same object name added

removeObject

public InjectObject removeObject(InjectObject pObject)

Removes an object from the cache.

Parameters:

pObject - the object to remove

Returns:

the removed object or null if an object with the same object name was not found

getObject

public InjectObject getObject(java.lang.String pName)

Gets an object from the cache.

Parameters:

pName - the name of the object

Returns:

the object or null if an object with the given name was not found

isExecuting

protected boolean isExecuting()

Returns whether the session is execution at least one command.

Returns:

true if the session is executing a command, otherwise false

isMaxAliveIntervalExceeded

protected boolean isMaxAliveIntervalExceeded(long pAccessTime)

Gets whether the alive interval is exceeded.

Parameters:

pAccessTime - the access time

Returns:

true if alive timeout is exceeded, false otherwise

setExecuting

protected void setExecuting(boolean pExecuting)

Sets that the session is executiong a command. The method considers that sub exections will be made. It changes a counter per method call.

Parameters:

pExecuting - true to increase the execution counter; false to decrease the execution counter

checkAccess

protected void checkAccess()

Checks if it is allowed to create the session.

openRecord

protected Record openRecord(java.lang.String pCommand,
                            java.lang.Object... pParameter)

Opens a record.

Parameters:

pCommand - the command

pParameter - additional parameter

Returns:

the record or null if record couldn't be created

initMaxInactiveInterval

protected void initMaxInactiveInterval(ChangedHashtable<java.lang.String,java.lang.Object> pProperties,
                                       Zone pZone,
                                       java.lang.String pScope,
                                       int pDefault)
                                throws java.lang.Exception

Initializes the max inactive interval.

Parameters:

pProperties - the session properties

pZone - the zone to use

pScope - the scope (master/subsession)

pDefault - the default timeout if not configured

Throws:

java.lang.Exception - if reading configuration failed

initMaxAliveInterval

protected void initMaxAliveInterval(ChangedHashtable<java.lang.String,java.lang.Object> pProperties,
                                    Zone pZone)
                             throws java.lang.Exception

Initializes the max alive interval.

Parameters:

pProperties - the session properties

pZone - the zone to use

Throws:

java.lang.Exception - if reading configuration failed

lock

public void lock()

Sets the session locked. This means that the session is in use. If you lock an already locked session, a lock counter will be used. A locked session must be unlock()ed.

See Also:

unlock()

unlock

public void unlock()

Unlocks the session.

See Also:

lock()

isLocked

public boolean isLocked()

Gets whether the session is locked.

Returns:

true if this session is locked, false otherwise

See Also:

lock()