Skip navigation links

com.sigmadynamics.sdo.support
Class SDSessionBase

java.lang.Object
com.sigmadynamics.sdo.support.SDOBase
com.sigmadynamics.sdo.support.SDSessionBase

All Implemented Interfaces:

SDOInterface, EntityInterface, SessionInterface

Direct Known Subclasses:

SessionBase

public abstract class SDSessionBase

extends SDOBase

implements SessionInterface

The base session implementation.

Always subclassed by code-generation.

Field Summary

(package private) static SDCategory

log

Fields inherited from class com.sigmadynamics.sdo.support.SDOBase

description, internalName, sdExternalName

Method Summary

void	cleanUp() Overridden by subclasses to release any resources allocated by init().
void	close() This method causes the session to be closed as soon as the current entry point finishes executing.
void	fill()
ApplicationInterface	getApp()
protected boolean	getControlGroupStatus()
java.util.Set	getKeys() This is called by generated code to get the session's set of keys.
static SessionInterface	getSession() Gets the current thread's session.
long	getTimeToDie() Get the session's idle timer value.
void	init() Overridden by subclasses to allocate resources needed by the subclass.
boolean	isBatchSession()
boolean	isClosed()
boolean	isClosing()
boolean	isTemporary()
boolean	isTimedOut() Indicates whether the timeout task has queued this session for cleanup.
void	learn()
void	reset()

Methods inherited from class com.sigmadynamics.sdo.support.SDOBase

getDescription, getSDOId, getSDOLabel, getSDOLabelOrId, setDescription, setSDOId, setSDOLabel

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sigmadynamics.sdo.interfaces.SessionInterface

getChoiceHistory

Methods inherited from interface com.sigmadynamics.sdo.interfaces.EntityInterface

resetAttributes

Methods inherited from interface com.sigmadynamics.sdo.interfaces.client.SDOInterface

getDescription, getSDOId, getSDOLabel, getSDOLabelOrId

Field Detail

log

static final SDCategory log

Method Detail

getKeys

public java.util.Set getKeys()

This is called by generated code to get the session's set of keys.

Accesses a snapshot of the keys, cloned soon after the entry point runner acquired the session's run lock.

Specified by:

getKeys in interface SessionInterface

isClosed

public boolean isClosed()

Specified by:

isClosed in interface SessionInterface

Returns:

true if the session has finished closing.

isClosing

public boolean isClosing()

Specified by:

isClosing in interface SessionInterface

Returns:

true if the session is in the process of closing.

isTemporary

public boolean isTemporary()

Specified by:

isTemporary in interface SessionInterface

Returns:

true if the session has no keys and will live only for the duration of the current request.

getSession

public static SessionInterface getSession()

Gets the current thread's session.

Returns:

the current session

isTimedOut

public boolean isTimedOut()

Indicates whether the timeout task has queued this session for cleanup.

Specified by:

isTimedOut in interface SessionInterface

Returns:

true if queued

getTimeToDie

public long getTimeToDie()

Get the session's idle timer value.

Specified by:

getTimeToDie in interface SessionInterface

Returns:

Millisec remaining before this session is subject to being discarded.

close

public final void close()

This method causes the session to be closed as soon as the current entry point finishes executing. At that time, the session is removed from the session table, and the session's cleanup method is called.

Any other threads holding references to the session will throw SessionIsClosedException when they acquire the session's run lock and try to execute.

Caller is assumed to hold the session's run lock.

Specified by:

close in interface SessionInterface

learn

public void learn()

init

public void init()

Overridden by subclasses to allocate resources needed by the subclass.

Specified by:

init in interface SessionInterface

cleanUp

public void cleanUp()

Overridden by subclasses to release any resources allocated by init().

Specified by:

cleanUp in interface SessionInterface

getApp

public ApplicationInterface getApp()

Specified by:

getApp in interface SessionInterface

getControlGroupStatus

protected boolean getControlGroupStatus()

fill

public void fill()

Specified by:

fill in interface EntityInterface

reset

public void reset()

Specified by:

reset in interface EntityInterface

isBatchSession

public boolean isBatchSession()

Specified by:

isBatchSession in interface SessionInterface

Skip navigation links