oracle.ifs.fdk.impl

Class FdkSystemSessionImpl

java.lang.Object

oracle.ifs.fdk.FdkSession

oracle.ifs.fdk.impl.FdkSessionImpl

oracle.ifs.fdk.impl.FdkSystemSessionImpl

All Implemented Interfaces:

LogInfo

public final class FdkSystemSessionImpl
extends FdkSessionImpl

Implementation of a system session.

Field Summary

Fields inherited from class oracle.ifs.fdk.FdkSession

m_CurrentRequestThread, m_Tag

Constructor Summary

Constructors

Constructor and Description
FdkSystemSessionImpl() Creates a new FdkSystemSessionImpl using a LibrarySession retrieved from the SystemSessionPool.

Method Summary

Modifier and Type	Method and Description
void	beginRequest(boolean wait, long timeout, String tag) Notifies the session that a new request has begun.
void	disconnectNotify() Disconnects this user session.
boolean	endRequest() Notifies the session that the request has ended.
String	getDistinguishedName() Returned the distinguished name for the authenticated user.
long	getId() Returns this session identifier.
long	getLastAccessTime() Returns the time when the last request was completed by calling endRequest() on the current session.
LibrarySession	getLibrarySession() Returns the LibrarySession associated with this user session.
String	getSessionIdentifier() Get a String that identifies a user session.
long	getSessionTimeout() Returns the session timeout, in seconds, for this session.
Object	getState(Object key) Returns the value stored at the given key using setState().
String	getTrustedApplicationName() Returns the name of the trusted application or null if the session was not created by a truested application.
Item	getUser(AttributeRequest[] attributes) Returns the user for this session.
String	getUserIdentifier() Get a String that identifies a user.
String	getUsername() Returns the username for the authenticated user.
void	httpBind() Respond to a bind notification from the HttpSession
void	httpUnbind() Respond to an unbind notification from the HttpSession
boolean	isConnected() Returns true if this session is connected.
boolean	isGuest() Returns true if the session is a guest/anonymous session.
boolean	isRequestInProgress() Returns true if there is a request being serviced by this session.
boolean	isSystem() Returns true if the session is a system session.
boolean	isTrustedApplication() Returns true if the session was created by a trusted application.
void	setLastAccessTimeUpdate(boolean update) Sets whether the last access time will be updated when endRequest() is called on the current session.
void	setSessionTimeout(long timeout) Sets the automatic session timeout for inactivity.
void	setState(Object key, Object value) Sets a value representing a piece of state that makes sense to the application.
boolean	verifyCredential(Credential credential) Verifies that the given credential is valid for the user represented by this session.

Methods inherited from class oracle.ifs.fdk.impl.FdkSessionImpl

beginTransaction, commitTransaction, disconnect, getInternalSession, getManagersFactory, isTransactionInProgress, registerForEvents, rollbackTransaction, rollbackTransactionStack, unregisterForEvents

Methods inherited from class oracle.ifs.fdk.FdkSession

beginRequestCommon, getCreationTime, getCurrentSession, getTag, requestCleanup

Methods inherited from class java.lang.Object

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

Constructor Detail

FdkSystemSessionImpl

public FdkSystemSessionImpl()
                     throws FdkException

Creates a new FdkSystemSessionImpl using a LibrarySession retrieved from the SystemSessionPool.

Throws:

FdkException

Method Detail

getId

public long getId()

Description copied from class: FdkSession

Returns this session identifier. The identifier is not persisted, it is unique in the context of a Java Virtual Machine and it may be the same between different runs of the software.

Specified by:

getId in class FdkSession

getLastAccessTime

public long getLastAccessTime()

Description copied from class: FdkSession

Returns the time when the last request was completed by calling endRequest() on the current session. The time format is the same as System.currentTimeMillis().

Specified by:

getLastAccessTime in class FdkSession

setLastAccessTimeUpdate

public void setLastAccessTimeUpdate(boolean update)

Description copied from class: FdkSession

Sets whether the last access time will be updated when endRequest() is called on the current session. This is useful behavior for requests that are not sent by the true end-user but rather by a polling process for example.

Note that the behavior is changed on a per request basis, the default behavior if the method is not called during a request is to always update the last access time and the behavior is reset to the default when a request is completed by calling endRequest().

Specified by:

setLastAccessTimeUpdate in class FdkSession

Parameters:

update - If false the last access time will not be updated, otherwise it will be updated.

isConnected

public boolean isConnected()

Description copied from class: FdkSession

Returns true if this session is connected.

Specified by:

isConnected in class FdkSession

getUsername

public String getUsername()

Description copied from class: FdkSession

Returns the username for the authenticated user. It is recommended that implementations cache the value so that a call to this method will not block if for example the underlying session is busy.

Specified by:

getUsername in class FdkSession

getDistinguishedName

public String getDistinguishedName()

Description copied from class: FdkSession

Returned the distinguished name for the authenticated user. For OID users this is equivalent to the OID GUID. It is recommended that implementations cache the value so that a call to this method will not block if for example the underlying session is busy.

Specified by:

getDistinguishedName in class FdkSession

isGuest

public boolean isGuest()

Description copied from class: FdkSession

Returns true if the session is a guest/anonymous session.

Specified by:

isGuest in class FdkSession

isSystem

public boolean isSystem()

Returns true if the session is a system session.

Specified by:

isSystem in class FdkSession

isTrustedApplication

public boolean isTrustedApplication()

Returns true if the session was created by a trusted application.

Specified by:

isTrustedApplication in class FdkSession

getTrustedApplicationName

public String getTrustedApplicationName()

Returns the name of the trusted application or null if the session was not created by a truested application.

Specified by:

getTrustedApplicationName in class FdkSession

verifyCredential

public boolean verifyCredential(Credential credential)

Description copied from class: FdkSession

Verifies that the given credential is valid for the user represented by this session. Returns true if the credential is valid or false otherwise. The method can also throw a FdkException if errors occur during the verification process.

Specified by:

verifyCredential in class FdkSession

Parameters:

credential - The credential to verify.

isRequestInProgress

public boolean isRequestInProgress()

Description copied from class: FdkSession

Returns true if there is a request being serviced by this session. See beginRequest() and endRequest()

Specified by:

isRequestInProgress in class FdkSession

beginRequest

public void beginRequest(boolean wait,
                         long timeout,
                         String tag)
                  throws FdkException

Description copied from class: FdkSession

Notifies the session that a new request has begun. The current thread becomes the owner of this session. endRequest() must be called from the same thread.

Specified by:

beginRequest in class FdkSession

Parameters:

wait - Whether the calling thread should wait for the session to finish any existing requests or should fail right away if the session is busy. If wait is false, the timeout value is ignored.

timeout - If the caller chooses to wait, this is the timeout in milliseconds before an error is returned if the session is still busy. If the parameter is 0, the wait is indefinite. If the timeout is -1 or any negative value the wait is defaulted to a system chosen, sensible value.

tag - A tag describing the application that is currently using this session. The tag can be retrieved later on by calling getTag(). Must not be null.

Throws:

FdkException

endRequest

public boolean endRequest()

Description copied from class: FdkSession

Notifies the session that the request has ended. Returns false if there were no outstanding requests on the session or the current thread did not own the session. The caller may interpret it as an error or just ignore it, depending on its implementation.

Specified by:

endRequest in class FdkSession

setSessionTimeout

public void setSessionTimeout(long timeout)

Description copied from class: FdkSession

Sets the automatic session timeout for inactivity. A session that has a timeout greater than zero will automatically be disconnected if there is no activity for the specified number of seconds.

In addition, if the timeout is greater than zero, the session will not be disconnected when it gets the unbind even from the HttpSession, as it is assumed it is being managed by a different entity.

Specified by:

setSessionTimeout in class FdkSession

Parameters:

timeout - Number of seconds to set the timeout to.

getSessionTimeout

public long getSessionTimeout()

Description copied from class: FdkSession

Returns the session timeout, in seconds, for this session. A zero return value means the session is not timed out by this framework. Note that the return value is meaningful only if the session is fully managed by the framework as there could be external entities (such as an HttpSession) that could have their own session timeouts which would in turn trigger this session to timeout.

Specified by:

getSessionTimeout in class FdkSession

setState

public void setState(Object key,
                     Object value)

Description copied from class: FdkSession

Sets a value representing a piece of state that makes sense to the application. The value can be retrieved using getState().

It is recommended that applications store only one object as their state. The object can be a Map that contains other pieces of state.

Specified by:

setState in class FdkSession

Parameters:

key - The key that identifies the piece of state. The namespace for the key is not specified. It is recommended that a package-like key name be used in order to avoid potential conflicts.

value - The value to store at the given key. If null, the key will be removed.

getState

public Object getState(Object key)

Description copied from class: FdkSession

Returns the value stored at the given key using setState(). See the documentation of setState().

Specified by:

getState in class FdkSession

Parameters:

key - The key to retrieve the value for.

getUser

public Item getUser(AttributeRequest[] attributes)
             throws FdkException

Description copied from class: FdkSessionImpl

Returns the user for this session. Optional attributes about the user can be requested.

Specified by:

getUser in class FdkSessionImpl

Parameters:

attributes - Optional attributes to be returned.

Throws:

FdkException

getLibrarySession

public LibrarySession getLibrarySession()

Description copied from class: FdkSessionImpl

Returns the LibrarySession associated with this user session.

WARNING!

This method should not be called from client code, except for exceptional circumstances where the caller understands the implications of using the LibrarySession directly and opts out of using the framework.

If you need to use this method, please check with the developers of the framework for possible alternate ways of achieving the same result.

Specified by:

getLibrarySession in class FdkSessionImpl

disconnectNotify

public void disconnectNotify()
                      throws FdkException

Description copied from class: FdkSessionImpl

Disconnects this user session. Subclasses must do their cleanup in the implementation of this method.

Throws:

FdkException

httpUnbind

public void httpUnbind()

Description copied from class: FdkSession

Respond to an unbind notification from the HttpSession

Overrides:

httpUnbind in class FdkSession

httpBind

public void httpBind()

Description copied from class: FdkSession

Respond to a bind notification from the HttpSession

Overrides:

httpBind in class FdkSession

getUserIdentifier

public String getUserIdentifier()

Description copied from interface: LogInfo

Get a String that identifies a user. The user identifier can be used to track the related log recoreds across multiple requests.

Returns:

a string that uniquely identifies a user

getSessionIdentifier

public String getSessionIdentifier()

Description copied from interface: LogInfo

Get a String that identifies a user session. The session identifier can be used to track related log entries across multiple requests.

Returns:

a string that uniquely identifies a user session