oracle.toplink.essentials.threetier

Class ClientSession

java.lang.Object

oracle.toplink.essentials.internal.sessions.AbstractSession

oracle.toplink.essentials.threetier.ClientSession

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Session

Direct Known Subclasses:

IsolatedClientSession

public class ClientSession
extends AbstractSession

Purpose: Acts as a client to the server session.

Description: This session is brokered by the server session for use in three-tiered applications. It is used to store the context of the connection, i.e. the login to be used for this cleint. This allows each client connected to the server to contain its own user login.

Responsibilities:

• Allow units of work to be acquired and pass them the client login's exclusive connection.
• Forward all requests and queries to its parent server session.

This class is an implementation of Session. Please refer to that class for a full API. The public interface should be used.

See Also:

Server, UnitOfWork, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ConnectionPolicy	connectionPolicy
protected boolean	isActive
protected ServerSession	parent
protected Sequencing	sequencing
protected Accessor	writeConnection

Fields inherited from class oracle.toplink.essentials.internal.sessions.AbstractSession

accessor, broker, commitManager, ejbqlPlaceHolderQueries, eventManager, exceptionHandler, externalTransactionController, identityMapAccessor, integrityChecker, isInProfile, lastDescriptorAccessed, logSessionString, name, numberOfActiveUnitsOfWork, platform, profiler, project, properties, queries, sessionLog, transactionMutex, wasJTSTransactionInternallyStarted

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientSession(Project project)
	ClientSession(ServerSession parent, ConnectionPolicy connectionPolicy) INTERNAL: Create and return a new client session.

Method Summary

Modifier and Type	Method and Description
void	afterTransaction(boolean committed, boolean isExternalTransaction) INTERNAL: Called after transaction is completed (committed or rolled back)
void	basicBeginTransaction() INTERNAL: This is internal to the unit of work and should never be called otherwise.
void	basicCommitTransaction() INTERNAL: This is internal to the unit of work and should not be called otherwise.
void	basicRollbackTransaction() INTERNAL: This is internal to the unit of work and should not be called otherwise.
void	connect() INTERNAL: Connect the session only (this must be the write connection as the read is shared).
boolean	containsQuery(java.lang.String queryName) INTERNAL: Was PUBLIC: customer will be redirected to Session.
void	disconnect() INTERNAL: Disconnect the accessor only (this must be the write connection as the read is shared).
protected void	finalize() INTERNAL: Release in case not released.
Accessor	getAccessor() INTERNAL: Return the read or write connection depending on the transaction state.
ConnectionPolicy	getConnectionPolicy() ADVANCED: This method will return the connection policy that was used during the acquisition of this client session.
java.util.Map	getDescriptors() INTERNAL: Was PUBLIC: customer will be redirected to Session.
AbstractSession	getExecutionSession(DatabaseQuery query) INTERNAL: Gets the session which this query will be executed on.
ServerSession	getParent() INTERNAL: Return the parent.
AbstractSession	getParentIdentityMapSession(DatabaseQuery query, boolean canReturnSelf, boolean terminalOnly) INTERNAL: Gets the next link in the chain of sessions followed by a query's check early return, the chain of sessions with identity maps all the way up to the root session.
DatabaseQuery	getQuery(java.lang.String name) INTERNAL: Was PUBLIC: customer will be redirected to Session.
DatabaseQuery	getQuery(java.lang.String name, java.util.Vector args) INTERNAL:
Sequencing	getSequencing() INTERNAL: Return the Sequencing object used by the session.
ServerPlatform	getServerPlatform() INTERNAL: Marked internal as this is not customer API but helper methods for accessing the server platform from within TopLink's other sessions types (ie not DatabaseSession)
java.lang.String	getSessionTypeString() INTERNAL: Returns the type of session, its class.
Accessor	getWriteConnection() INTERNAL: Return the connection to be used for database modification.
protected boolean	hasWriteConnection() INTERNAL: Return if this session has been connected.
void	initializeIdentityMapAccessor() INTERNAL: Set up the IdentityMapManager.
void	initializeSequencing() INTERNAL: was ADVANCED: Creates sequencing object for the session.
boolean	isActive() INTERNAL: Was PUBLIC: customer will be redirected to Session.
boolean	isClientSession() INTERNAL: Return if this session is a client session.
boolean	isConnected() INTERNAL: Was PUBLIC: customer will be redirected to Session.
void	release() INTERNAL: Was PUBLIC: customer will be redirected to Session.
protected void	releaseWriteConnection() INTERNAL: This is internal to the unit of work and should not be called otherwise.
protected void	setConnectionPolicy(ConnectionPolicy connectionPolicy) INTERNAL: Set the connection policy.
protected void	setIsActive(boolean isActive) INTERNAL: Set if the client session is actvie (has not been released).
protected void	setParent(ServerSession parent) INTERNAL: Set the parent.
void	setWriteConnection(Accessor writeConnection) INTERNAL: Set the connection to be used for database modification.
java.lang.String	toString() INTERNAL: Print the connection status with the session.

Methods inherited from class oracle.toplink.essentials.internal.sessions.AbstractSession

acquireNonSynchronizedUnitOfWork, acquireUnitOfWork, addAlias, addEjbqlPlaceHolderQuery, addQuery, addQuery, beginExternalTransaction, beginTransaction, clearIntegrityChecker, clearLastDescriptorAccessed, clearProfile, clone, commitExternalTransaction, commitTransaction, compareObjects, compareObjectsDontMatch, config, copyObject, copyObject, copyReadOnlyClasses, deleteAllObjects, deleteAllObjects, deleteObject, doesObjectExist, dontLogMessages, endOperationProfile, executeCall, executeNonSelectingCall, executeNonSelectingSQL, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeSelectingCall, executeSQL, fine, finer, finest, getAccessor, getAccessor, getActiveSession, getActiveUnitOfWork, getAliasDescriptors, getAllQueries, getBroker, getClassDescriptor, getClassDescriptor, getClassDescriptorForAlias, getCommitManager, getDatasourceLogin, getDatasourcePlatform, getDefaultReadOnlyClasses, getDescriptor, getDescriptor, getDescriptorForAlias, getEjbqlPlaceHolderQueries, getEventManager, getExceptionHandler, getExceptionHandlerClass, getExternalTransactionController, getIdentityMapAccessor, getIdentityMapAccessorInstance, getIntegrityChecker, getLog, getLogin, getLogLevel, getLogLevel, getLogSessionString, getName, getNextQueryId, getNextSequenceNumberValue, getNumberOfActiveUnitsOfWork, getParentIdentityMapSession, getPlatform, getPlatform, getProfiler, getProject, getProperties, getProperty, getQueries, getRootSession, getSessionForClass, getSessionLog, getTransactionMutex, handleException, handleSevere, hasBroker, hasDescriptor, hasExceptionHandler, hasExternalTransactionController, hasProperties, incrementProfile, info, insertObject, internalExecuteQuery, isBroker, isClassReadOnly, isClassReadOnly, isDatabaseSession, isDistributedSession, isInBroker, isInProfile, isInTransaction, isRemoteSession, isRemoteUnitOfWork, isServerSession, isSessionBroker, isUnitOfWork, keyFromObject, keyFromObject, log, log, log, log, log, log, log, log, log, log, logMessage, logThrowable, prepareDatabaseQuery, processEJBQLQueries, processEJBQLQueries, readAllObjects, readAllObjects, readAllObjects, readAllObjects, readObject, readObject, readObject, readObject, readObject, refreshAndLockObject, refreshAndLockObject, refreshObject, releaseUnitOfWork, removeProperty, removeQuery, removeQuery, rollbackExternalTransaction, rollbackTransaction, setAccessor, setBroker, setCommitManager, setDatasourceLogin, setEventManager, setExceptionHandler, setExternalTransactionController, setIntegrityChecker, setIsInProfile, setLog, setLogin, setLogin, setLogLevel, setName, setNumberOfActiveUnitsOfWork, setProfiler, setProject, setProperties, setProperty, setQueries, setSessionLog, setTransactionMutex, setWasJTSTransactionInternallyStarted, severe, shouldLog, shouldLogMessages, startOperationProfile, unwrapObject, updateObject, updateProfile, validateQuery, verifyDelete, warning, wasJTSTransactionInternallyStarted, wrapObject, writeAllObjects, writeAllObjectsWithChangeSet, writeObject, writesCompleted

Methods inherited from class java.lang.Object

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

Field Detail

parent

protected ServerSession parent

connectionPolicy

protected ConnectionPolicy connectionPolicy

writeConnection

protected Accessor writeConnection

isActive

protected boolean isActive

sequencing

protected Sequencing sequencing

Constructor Detail

ClientSession

public ClientSession(ServerSession parent,
                     ConnectionPolicy connectionPolicy)

INTERNAL: Create and return a new client session.

ClientSession

protected ClientSession(Project project)

Method Detail

afterTransaction

public void afterTransaction(boolean committed,
                             boolean isExternalTransaction)

INTERNAL: Called after transaction is completed (committed or rolled back)

Overrides:

afterTransaction in class AbstractSession

basicBeginTransaction

public void basicBeginTransaction()

INTERNAL: This is internal to the unit of work and should never be called otherwise.

Overrides:

basicBeginTransaction in class AbstractSession

basicCommitTransaction

public void basicCommitTransaction()

INTERNAL: This is internal to the unit of work and should not be called otherwise.

Overrides:

basicCommitTransaction in class AbstractSession

basicRollbackTransaction

public void basicRollbackTransaction()

INTERNAL: This is internal to the unit of work and should not be called otherwise.

Overrides:

basicRollbackTransaction in class AbstractSession

connect

public void connect()
             throws DatabaseException

INTERNAL: Connect the session only (this must be the write connection as the read is shared).

Throws:

DatabaseException

containsQuery

public boolean containsQuery(java.lang.String queryName)

INTERNAL: Was PUBLIC: customer will be redirected to Session. Return true if the pre-defined query is defined on the session.

Specified by:

containsQuery in interface Session

Overrides:

containsQuery in class AbstractSession

disconnect

public void disconnect()
                throws DatabaseException

INTERNAL: Disconnect the accessor only (this must be the write connection as the read is shared).

Throws:

DatabaseException

finalize

protected void finalize()
                 throws DatabaseException

INTERNAL: Release in case not released.

Overrides:

finalize in class java.lang.Object

Throws:

DatabaseException

getAccessor

public Accessor getAccessor()

INTERNAL: Return the read or write connection depending on the transaction state.

Overrides:

getAccessor in class AbstractSession

getConnectionPolicy

public ConnectionPolicy getConnectionPolicy()

ADVANCED: This method will return the connection policy that was used during the acquisition of this client session. The properties within the ConnectionPolicy may be used when acquiring an exclusive connection for an IsolatedSession.

getDescriptors

public java.util.Map getDescriptors()

INTERNAL: Was PUBLIC: customer will be redirected to Session. Return all registered descriptors. The clients session inherits its parent's descriptors.

Specified by:

getDescriptors in interface Session

Overrides:

getDescriptors in class AbstractSession

getParentIdentityMapSession

public AbstractSession getParentIdentityMapSession(DatabaseQuery query,
                                                   boolean canReturnSelf,
                                                   boolean terminalOnly)

INTERNAL: Gets the next link in the chain of sessions followed by a query's check early return, the chain of sessions with identity maps all the way up to the root session.

Used for session broker which delegates to registered sessions, or UnitOfWork which checks parent identity map also.

Overrides:

getParentIdentityMapSession in class AbstractSession

Parameters:

canReturnSelf - true when method calls itself. If the path starting at this is acceptable. Sometimes true if want to move to the first valid session, i.e. executing on ClientSession when really should be on ServerSession.

terminalOnly - return the session we will execute the call on, not the next step towards it.

Returns:

this if there is no next link in the chain

getExecutionSession

public AbstractSession getExecutionSession(DatabaseQuery query)

INTERNAL: Gets the session which this query will be executed on. Generally will be called immediately before the call is translated, which is immediately before session.executeCall.

Since the execution session also knows the correct datasource platform to execute on, it is often used in the mappings where the platform is needed for type conversion, or where calls are translated.

Is also the session with the accessor. Will return a ClientSession if it is in transaction and has a write connection.

Overrides:

getExecutionSession in class AbstractSession

Parameters:

query - may store session name or reference class for brokers case

Returns:

a session with a live accessor

getParent

public ServerSession getParent()

INTERNAL: Return the parent. This is a server session.

getQuery

public DatabaseQuery getQuery(java.lang.String name)

INTERNAL: Was PUBLIC: customer will be redirected to Session. Return the query from the session pre-defined queries with the given name. This allows for common queries to be pre-defined, reused and executed by name.

Specified by:

getQuery in interface Session

Overrides:

getQuery in class AbstractSession

getQuery

public DatabaseQuery getQuery(java.lang.String name,
                              java.util.Vector args)

INTERNAL:

Specified by:

getQuery in interface Session

Overrides:

getQuery in class AbstractSession

See Also:

AbstractSession.getQuery(String)

initializeSequencing

public void initializeSequencing()

INTERNAL: was ADVANCED: Creates sequencing object for the session. Typically there is no need for the user to call this method - it is called from the constructor.

getSequencing

public Sequencing getSequencing()

INTERNAL: Return the Sequencing object used by the session. Lazy init sequencing to defer from client session creation to improve creation performance.

Overrides:

getSequencing in class AbstractSession

getServerPlatform

public ServerPlatform getServerPlatform()

INTERNAL: Marked internal as this is not customer API but helper methods for accessing the server platform from within TopLink's other sessions types (ie not DatabaseSession)

Overrides:

getServerPlatform in class AbstractSession

getSessionTypeString

public java.lang.String getSessionTypeString()

INTERNAL: Returns the type of session, its class.

Override to hide from the user when they are using an internal subclass of a known class.

A user does not need to know that their UnitOfWork is a non-deferred UnitOfWork, or that their ClientSession is an IsolatedClientSession.

Overrides:

getSessionTypeString in class AbstractSession

getWriteConnection

public Accessor getWriteConnection()

INTERNAL: Return the connection to be used for database modification.

hasWriteConnection

protected boolean hasWriteConnection()

INTERNAL: Return if this session has been connected.

initializeIdentityMapAccessor

public void initializeIdentityMapAccessor()

INTERNAL: Set up the IdentityMapManager. This method allows subclasses of Session to override the default IdentityMapManager functionality.

Overrides:

initializeIdentityMapAccessor in class AbstractSession

isActive

public boolean isActive()

INTERNAL: Was PUBLIC: customer will be redirected to Session. Return if the client session is actvie (has not been released).

isClientSession

public boolean isClientSession()

INTERNAL: Return if this session is a client session.

Specified by:

isClientSession in interface Session

Overrides:

isClientSession in class AbstractSession

isConnected

public boolean isConnected()

INTERNAL: Was PUBLIC: customer will be redirected to Session. Return if this session has been connected to the database.

Specified by:

isConnected in interface Session

Overrides:

isConnected in class AbstractSession

release

public void release()
             throws DatabaseException

INTERNAL: Was PUBLIC: customer will be redirected to Session. Release the client session. This releases the client session back to it server. Normally this will logout of the client session's connection, and allow the client session to garbage collect.

Specified by:

release in interface Session

Overrides:

release in class AbstractSession

Throws:

DatabaseException

releaseWriteConnection

protected void releaseWriteConnection()

INTERNAL: This is internal to the unit of work and should not be called otherwise.

setConnectionPolicy

protected void setConnectionPolicy(ConnectionPolicy connectionPolicy)

INTERNAL: Set the connection policy.

setIsActive

protected void setIsActive(boolean isActive)

INTERNAL: Set if the client session is actvie (has not been released).

setParent

protected void setParent(ServerSession parent)

INTERNAL: Set the parent. This is a server session.

setWriteConnection

public void setWriteConnection(Accessor writeConnection)

INTERNAL: Set the connection to be used for database modification.

toString

public java.lang.String toString()

INTERNAL: Print the connection status with the session.

Overrides:

toString in class AbstractSession