com.aspc.DBObj.Contact

Class Session

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Contact.Session

All Implemented Interfaces:

SecondaryCacheGroup

public class Session
extends DBObject

Every time a user logins into the system a session object is created which stores many informational details and the user's timezone which is used when displaying times.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

26 June 2002

Author:

Nigel Leck

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID Every time a user logins into the system a session object is created which stores many informational details and the user's timezone which is used when displaying times.
static java.lang.String	DBCLASS_NAME Every time a user logins into the system a session object is created which stores many informational details and the user's timezone which is used when displaying times.
static java.lang.String	ENV_INNER_CIRCLE_PATTERN The INNER CIRCLE patterns

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
Session(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
void	addSessionProperty(java.lang.String name, java.lang.String value)
static boolean	checkLost(MutableDataSource mds) check if we lost any data
void	checkSession(java.lang.String domainUser) Check the session is still valid
static Session	create(MutableDataSource mds) Make a new instance of this class.
void	eventDataLoaded() When the underlying DBData is changed/ loaded.
void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extAutoEnterCreate() When the record is created
protected void	extFixUp() fixes the following problem 1) delete the session if the login can no longer be found.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Calculate the derived global key for this field.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extPreValidate() set the variables.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
DBTimeZone	fetchDBTimeZone() fetch the linked time zone record, use the login's timezone if set else by searching on the raw timezone text sent from the client.
DBJobManagerSession	findDroidSession(java.lang.String... args) The droid job manager session.
static Session	findKey(DataSource ds, int key) Find the target for this class by the primary key
Country	findLocationCountry(java.lang.String... args) The location country.
static Login	findLogin(java.lang.String signature, java.lang.String loginid) The function getLogin() returns the Login DBObject identified by the given parameter.
Login	findLoginId(java.lang.String... args) The login of the user who logs in.
static Session	findSession(java.lang.String signature, java.lang.String soapSessionID) The function getSession() returns the Session DBObject identified by the parameter SiteMinder Session Id from the database.
SessionType	findType(java.lang.String... args) The session type.
java.util.List<java.lang.String>	getAttributes(java.lang.String... args)
java.lang.String	getClientHostname(java.lang.String... args)
java.lang.String	getDeviceVerificationCode(java.lang.String... args)
DBJobManagerSession	getDroidSession(java.lang.String... args)
java.lang.String	getDuration(java.lang.String... args)
java.util.Date	getEnd(java.lang.String... args)
java.lang.String	getHostName(java.lang.String... args)
java.lang.String	getHostURL(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getJavaVersion(java.lang.String... args)
java.lang.String	getJsonGeoIP(java.lang.String... args)
java.lang.String	getLanguage(java.lang.String... args)
java.lang.String	getLocationCity(java.lang.String... args)
java.lang.String	getLocationCoordinates(java.lang.String... args)
Country	getLocationCountry(java.lang.String... args)
java.lang.String	getLocationRegion(java.lang.String... args)
java.lang.String	getLocationZipCode(java.lang.String... args)
Login	getLogin() Get the login for this session Note: Maybe a new record.
Login	getLoginId(java.lang.String... args)
java.lang.String	getLoginPars() Get the login parameters
static long	getLostCount() get the number of lost sessions
java.lang.String	getMonitorState(java.lang.String... args)
java.lang.String	getOneTimePassword(java.lang.String... args)
double	getOsVersion(java.lang.String... args)
java.lang.String	getProperties(java.lang.String... args)
ReadOnlyDataSource	getReadOnlyDataSource() get the readonly data source to use for this session
java.lang.String	getReason(java.lang.String... args)
java.lang.String	getScreen(java.lang.String... args)
int	getScreenHeight(java.lang.String... args)
int	getScreenWidth(java.lang.String... args)
java.lang.String	getSoapSessionId(java.lang.String... args)
java.lang.String	getSsoMagicNumber(java.lang.String... args)
java.util.Date	getStart(java.lang.String... args)
java.lang.String	getStateID(java.lang.String... args)
java.util.Date	getStateTimeout(java.lang.String... args)
java.lang.String	getSummary(java.lang.String... args)
java.util.TimeZone	getTimeZone() Get the timezone to use for this session
java.lang.String	getTimeZoneRaw(java.lang.String... args)
SessionType	getType(java.lang.String... args)
java.lang.String	getUserAgent(java.lang.String... args)
java.lang.String	getVerificationPhase(java.lang.String... args)
boolean	innerCircle() Is the session from the inner circle ?
boolean	isActive() Is it active
boolean	isLoggedOut(java.lang.String... args)
boolean	isMatch(java.lang.String... args)
boolean	isOsLinux(java.lang.String... args)
boolean	isOsMac(java.lang.String... args)
boolean	isOsWindows(java.lang.String... args)
boolean	isTimedOut(java.lang.String... args)
boolean	isValidToTerminate(java.lang.String... args)
org.w3c.dom.Element	makeMoveTo(org.w3c.dom.Document resultDoc)
static DBQuery<Session>	makeQuery(DataSource ds) Make a new QUERY for this class.
static java.lang.String	makeUniqueID() create a unique session id
java.lang.String	readSessionAttribute(java.lang.String name)
java.lang.String	readSessionProperty(java.lang.String name)
static void	remove(java.lang.String signature, java.lang.String soapSessionID) The function remove() removes a Session DBObject identified by the parameter SiteMinder Session Id from the database.
Session	setAttributes(java.util.List<java.lang.String> value, java.lang.String... args)
Session	setClientHostname(java.lang.String value, java.lang.String... args)
Session	setDeviceVerificationCode(java.lang.String value, java.lang.String... args)
Session	setDroidSession(com.aspc.dal.job.DBJobManagerSession value, java.lang.String... args)
Session	setEnd(java.util.Date value, java.lang.String... args)
Session	setHostName(java.lang.String value, java.lang.String... args)
Session	setHostURL(java.lang.String value, java.lang.String... args)
Session	setID(int value, java.lang.String... args)
Session	setJavaVersion(java.lang.String value, java.lang.String... args)
Session	setLanguage(java.lang.String value, java.lang.String... args)
Session	setLocationCoordinates(java.lang.String value, java.lang.String... args)
Session	setLoggedOut(boolean value, java.lang.String... args)
Session	setLoginId(com.aspc.dal.dbobj.contact.Login value, java.lang.String... args)
Session	setMonitorState(java.lang.String value, java.lang.String... args)
Session	setOneTimePassword(java.lang.String value, java.lang.String... args)
Session	setProperties(java.lang.String value, java.lang.String... args)
Session	setReason(java.lang.String value, java.lang.String... args)
Session	setScreenHeight(int value, java.lang.String... args)
Session	setScreenWidth(int value, java.lang.String... args)
Session	setSoapSessionId(java.lang.String value, java.lang.String... args)
Session	setSsoMagicNumber(java.lang.String value, java.lang.String... args)
Session	setStart(java.util.Date value, java.lang.String... args)
Session	setStateID(java.lang.String value, java.lang.String... args)
Session	setStateTimeout(java.util.Date value, java.lang.String... args)
Session	setTimedOut(boolean value, java.lang.String... args)
Session	setTimeZoneRaw(java.lang.String value, java.lang.String... args)
Session	setType(com.aspc.dal.dbobj.misc.SessionType value, java.lang.String... args)
Session	setUserAgent(java.lang.String value, java.lang.String... args)
Session	setVerificationPhase(java.lang.String value, java.lang.String... args)
java.lang.String	toString() The description.
void	writeSessionAttribute(java.lang.String name, java.lang.String value)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Every time a user logins into the system a session object is created which stores many informational details and the user's timezone which is used when displaying times.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Every time a user logins into the system a session object is created which stores many informational details and the user's timezone which is used when displaying times.

ENV_INNER_CIRCLE_PATTERN

public static final java.lang.String ENV_INNER_CIRCLE_PATTERN

The INNER CIRCLE patterns

See Also:

Constant Field Values

Constructor Detail

Session

public Session(@Nonnull
               DBClass def,
               @Nonnull
               DataSource dataSource)
        throws java.lang.Exception

Std. DBObject constructor.

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public Session setID(int value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getAttributes

@CheckReturnValue
 @Nonnull
public java.util.List<java.lang.String> getAttributes(java.lang.String... args)

setAttributes

@Nonnull
public Session setAttributes(java.util.List<java.lang.String> value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getClientHostname

@CheckReturnValue
 @Nonnull
public java.lang.String getClientHostname(java.lang.String... args)

setClientHostname

@Nonnull
public Session setClientHostname(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getDeviceVerificationCode

@CheckReturnValue
 @Nonnull
public java.lang.String getDeviceVerificationCode(java.lang.String... args)

setDeviceVerificationCode

@Nonnull
public Session setDeviceVerificationCode(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getDroidSession

@CheckReturnValue
 @Nullable
public DBJobManagerSession getDroidSession(java.lang.String... args)

findDroidSession

@CheckReturnValue
 @Nonnull
public final DBJobManagerSession findDroidSession(java.lang.String... args)
                                                                       throws NotFoundException

The droid job manager session.

--> DBJobManagerSession (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBJobManagerSession

Throws:

NotFoundException - DBJobManagerSession was not found

setDroidSession

@Nonnull
public Session setDroidSession(com.aspc.dal.job.DBJobManagerSession value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getDuration

@CheckReturnValue
 @Nonnull
public java.lang.String getDuration(java.lang.String... args)

getEnd

@CheckReturnValue
 @Nullable
public java.util.Date getEnd(java.lang.String... args)

setEnd

@Nonnull
public Session setEnd(java.util.Date value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getHostName

@CheckReturnValue
 @Nonnull
public java.lang.String getHostName(java.lang.String... args)

setHostName

@Nonnull
public Session setHostName(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getHostURL

@CheckReturnValue
 @Nonnull
public java.lang.String getHostURL(java.lang.String... args)

setHostURL

@Nonnull
public Session setHostURL(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

isMatch

@CheckReturnValue
public boolean isMatch(java.lang.String... args)

getJavaVersion

@CheckReturnValue
 @Nonnull
public java.lang.String getJavaVersion(java.lang.String... args)

setJavaVersion

@Nonnull
public Session setJavaVersion(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getJsonGeoIP

@CheckReturnValue
 @Nonnull
public java.lang.String getJsonGeoIP(java.lang.String... args)

getLanguage

@CheckReturnValue
 @Nonnull
public java.lang.String getLanguage(java.lang.String... args)

setLanguage

@Nonnull
public Session setLanguage(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getLocationCity

@CheckReturnValue
 @Nonnull
public java.lang.String getLocationCity(java.lang.String... args)

getLocationCoordinates

@CheckReturnValue
 @Nonnull
public java.lang.String getLocationCoordinates(java.lang.String... args)

setLocationCoordinates

@Nonnull
public Session setLocationCoordinates(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getLocationCountry

@CheckReturnValue
 @Nullable
public Country getLocationCountry(java.lang.String... args)

findLocationCountry

@CheckReturnValue
 @Nonnull
public final Country findLocationCountry(java.lang.String... args)
                                                              throws NotFoundException

The location country.

--> Country (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Country

Throws:

NotFoundException - Country was not found

getLocationRegion

@CheckReturnValue
 @Nonnull
public java.lang.String getLocationRegion(java.lang.String... args)

getLocationZipCode

@CheckReturnValue
 @Nonnull
public java.lang.String getLocationZipCode(java.lang.String... args)

isLoggedOut

@CheckReturnValue
public boolean isLoggedOut(java.lang.String... args)

setLoggedOut

@Nonnull
public Session setLoggedOut(boolean value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getLoginId

@CheckReturnValue
 @Nullable
public Login getLoginId(java.lang.String... args)

findLoginId

@CheckReturnValue
 @Nonnull
public final Login findLoginId(java.lang.String... args)
                                                    throws NotFoundException

The login of the user who logs in.

--> Login (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Login

Throws:

NotFoundException - Login was not found

setLoginId

@Nonnull
public Session setLoginId(com.aspc.dal.dbobj.contact.Login value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getMonitorState

@CheckReturnValue
 @Nonnull
public java.lang.String getMonitorState(java.lang.String... args)

setMonitorState

@Nonnull
public Session setMonitorState(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getOneTimePassword

@CheckReturnValue
 @Nonnull
public java.lang.String getOneTimePassword(java.lang.String... args)

setOneTimePassword

@Nonnull
public Session setOneTimePassword(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

isOsLinux

@CheckReturnValue
public boolean isOsLinux(java.lang.String... args)

isOsMac

@CheckReturnValue
public boolean isOsMac(java.lang.String... args)

getOsVersion

@CheckReturnValue
public double getOsVersion(java.lang.String... args)

isOsWindows

@CheckReturnValue
public boolean isOsWindows(java.lang.String... args)

getProperties

@CheckReturnValue
 @Nonnull
public java.lang.String getProperties(java.lang.String... args)

setProperties

@Nonnull
public Session setProperties(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getReason

@CheckReturnValue
 @Nonnull
public java.lang.String getReason(java.lang.String... args)

setReason

@Nonnull
public Session setReason(java.lang.String value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getScreen

@CheckReturnValue
 @Nonnull
public java.lang.String getScreen(java.lang.String... args)

getScreenHeight

@CheckReturnValue
public int getScreenHeight(java.lang.String... args)

setScreenHeight

@Nonnull
public Session setScreenHeight(int value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getScreenWidth

@CheckReturnValue
public int getScreenWidth(java.lang.String... args)

setScreenWidth

@Nonnull
public Session setScreenWidth(int value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getSoapSessionId

@CheckReturnValue
 @Nonnull
public java.lang.String getSoapSessionId(java.lang.String... args)

setSoapSessionId

@Nonnull
public Session setSoapSessionId(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getSsoMagicNumber

@CheckReturnValue
 @Nonnull
public java.lang.String getSsoMagicNumber(java.lang.String... args)

setSsoMagicNumber

@Nonnull
public Session setSsoMagicNumber(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getStart

@CheckReturnValue
 @Nullable
public java.util.Date getStart(java.lang.String... args)

setStart

@Nonnull
public Session setStart(java.util.Date value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getStateID

@CheckReturnValue
 @Nonnull
public java.lang.String getStateID(java.lang.String... args)

setStateID

@Nonnull
public Session setStateID(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getStateTimeout

@CheckReturnValue
 @Nullable
public java.util.Date getStateTimeout(java.lang.String... args)

setStateTimeout

@Nonnull
public Session setStateTimeout(java.util.Date value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getSummary

@CheckReturnValue
 @Nonnull
public java.lang.String getSummary(java.lang.String... args)

getTimeZoneRaw

@CheckReturnValue
 @Nonnull
public java.lang.String getTimeZoneRaw(java.lang.String... args)

setTimeZoneRaw

@Nonnull
public Session setTimeZoneRaw(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

isTimedOut

@CheckReturnValue
public boolean isTimedOut(java.lang.String... args)

setTimedOut

@Nonnull
public Session setTimedOut(boolean value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getType

@CheckReturnValue
 @Nullable
public SessionType getType(java.lang.String... args)

findType

@CheckReturnValue
 @Nonnull
public final SessionType findType(java.lang.String... args)
                                                       throws NotFoundException

The session type.

--> SessionType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SessionType

Throws:

NotFoundException - SessionType was not found

setType

@Nonnull
public Session setType(com.aspc.dal.dbobj.misc.SessionType value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getUserAgent

@CheckReturnValue
 @Nonnull
public java.lang.String getUserAgent(java.lang.String... args)

setUserAgent

@Nonnull
public Session setUserAgent(java.lang.String value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

isValidToTerminate

@CheckReturnValue
public boolean isValidToTerminate(java.lang.String... args)

getVerificationPhase

@CheckReturnValue
 @Nonnull
public java.lang.String getVerificationPhase(java.lang.String... args)

setVerificationPhase

@Nonnull
public Session setVerificationPhase(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static Session create(@Nonnull
                                                         MutableDataSource mds)
                                                  throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<Session> makeQuery(@Nonnull
                                                                     DataSource ds)
                                                              throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static Session findKey(@Nonnull
                                                          DataSource ds,
                                                          int key)
                                                   throws NotFoundException,
                                                          java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

getLostCount

@CheckReturnValue
public static long getLostCount()

get the number of lost sessions

Returns:

the count

addSessionProperty

public void addSessionProperty(@Nonnull
                               java.lang.String name,
                               @Nonnull
                               java.lang.String value)
                        throws java.lang.Exception

Throws:

java.lang.Exception

readSessionProperty

@CheckReturnValue
 @Nullable
public java.lang.String readSessionProperty(@Nonnull
                                                                         java.lang.String name)
                                                                  throws java.lang.IllegalArgumentException,
                                                                         java.io.IOException

Throws:

java.lang.IllegalArgumentException

java.io.IOException

readSessionAttribute

@CheckReturnValue
 @Nonnull
public java.lang.String readSessionAttribute(@Nonnull
                                                                         java.lang.String name)

writeSessionAttribute

public void writeSessionAttribute(@Nonnull
                                  java.lang.String name,
                                  @Nonnull
                                  java.lang.String value)
                           throws SessionWriteException

Throws:

SessionWriteException

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

Description copied from class: DBObject

The description.

Overrides:

toString in class DBObject

Returns:

The description

checkLost

@CheckReturnValue
public static boolean checkLost(MutableDataSource mds)

check if we lost any data

Parameters:

mds - the data source to check

Returns:

true if we have lost data.

innerCircle

@CheckReturnValue
public boolean innerCircle()

Is the session from the inner circle ?

Returns:

true if within the inner circle.

eventDataLoaded

public void eventDataLoaded()

When the underlying DBData is changed/ loaded.

Overrides:

eventDataLoaded in class DBObject

extAutoEnterCreate

@OverridingMethodsMustInvokeSuper
protected void extAutoEnterCreate()
                                                             throws java.lang.Exception

When the record is created

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - a serious problem.

makeUniqueID

@CheckReturnValue
 @Nonnull
public static java.lang.String makeUniqueID()

create a unique session id

Returns:

the newly created session id Never disclose the information in the session id. ( do not include the username, time or layer id ) as we did previously. https://www.owasp.org/index.php/Session_Management_Cheat_Sheet#Session_ID_Content_.28or_Value.29 No special characters as this is used in cookies etc. http://docs.oracle.com/javaee/5/api/javax/servlet/http/Cookie.html#setValue%28java.lang.String%29

isActive

@CheckReturnValue
public boolean isActive()

Is it active

Returns:

true if active

getLoginPars

@CheckReturnValue
 @Nonnull
public java.lang.String getLoginPars()

Get the login parameters

Returns:

The login parameters

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
public void eventFieldUpdated(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                java.lang.Object previous,
                                                                @Nullable
                                                                GlobalKey previousKey,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

update dependent fields.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

Throws:

java.lang.Exception - a serious problem

getLogin

@CheckReturnValue
 @Nullable
public final Login getLogin()

Get the login for this session Note: Maybe a new record.

Returns:

The login

getTimeZone

@CheckReturnValue
 @Nonnull
public final java.util.TimeZone getTimeZone()

Get the timezone to use for this session

Returns:

The timezone

getReadOnlyDataSource

@CheckReturnValue
 @Nonnull
public final ReadOnlyDataSource getReadOnlyDataSource()

get the readonly data source to use for this session

Returns:

The readonly data source

extValidateField

@OverridingMethodsMustInvokeSuper
 @CheckReturnValue
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Description copied from class: DBObject

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

checkSession

public void checkSession(@Nonnull
                         java.lang.String domainUser)
                  throws java.lang.Exception

Check the session is still valid

Parameters:

domainUser - The user name to check

Throws:

java.lang.Exception - a serious problem

remove

public static void remove(@Nullable
                          java.lang.String signature,
                          @Nullable
                          java.lang.String soapSessionID)
                   throws java.lang.Exception

The function remove() removes a Session DBObject identified by the parameter SiteMinder Session Id from the database.

Parameters:

soapSessionID - The session id

signature - The database name.

Throws:

java.lang.Exception - A serious problem

findSession

@CheckReturnValue
 @Nonnull
public static Session findSession(@Nonnull
                                                              java.lang.String signature,
                                                              java.lang.String soapSessionID)
                                                       throws java.lang.Exception

The function getSession() returns the Session DBObject identified by the parameter SiteMinder Session Id from the database.

Parameters:

signature - The database name.

soapSessionID - as String.

Returns:

The session

Throws:

java.lang.Exception - A serious problem

findLogin

public static Login findLogin(java.lang.String signature,
                              java.lang.String loginid)
                       throws java.lang.Exception

The function getLogin() returns the Login DBObject identified by the given parameter.

Parameters:

loginid - The login

signature - The database name.

Returns:

The login

Throws:

java.lang.Exception - A serious problem

extFixUp

@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception

fixes the following problem 1) delete the session if the login can no longer be found. 2) delete the session if the soap session isn't unique

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem

extPreValidate

@OverridingMethodsMustInvokeSuper
protected void extPreValidate()
                                                         throws java.lang.Exception

set the variables.

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - a serious problem

extGetDerivedGlobalKey

@CheckReturnValue
 @Nullable
protected GlobalKey extGetDerivedGlobalKey(@Nonnull
                                                                        DBField field,
                                                                        @Nullable
                                                                        FldParams params)
                                                                 throws java.lang.Exception

Calculate the derived global key for this field.

Overrides:

extGetDerivedGlobalKey in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated global key

Throws:

java.lang.Exception - A serious problem

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The value.

Throws:

java.lang.Exception - A serious problem

fetchDBTimeZone

public DBTimeZone fetchDBTimeZone()
                           throws java.lang.Exception

fetch the linked time zone record, use the login's timezone if set else by searching on the raw timezone text sent from the client.

Returns:

The timezone record if found otherwise null

Throws:

java.lang.Exception - a serious problem

makeMoveTo

@CheckReturnValue
 @Nullable
public org.w3c.dom.Element makeMoveTo(org.w3c.dom.Document resultDoc)
                                                            throws java.lang.Exception

Parameters:

resultDoc - result document

Returns:

Element

Throws:

java.lang.Exception - A serious problem occurred