oracle.toplink.remote
Class DistributedSession

java.lang.Object
  |
  +--oracle.toplink.publicinterface.Session
        |
        +--oracle.toplink.remote.DistributedSession

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

Direct Known Subclasses:

ProxySession, RemoteSession

public abstract class DistributedSession

extends Session

Purpose: Super class to all remote client session's.

See Also:

Serialized Form

Constructor Summary

DistributedSession(oracle.toplink.internal.remote.RemoteConnection remoteConnection)
PUBLIC: Creates a DistributedSession.

Method Summary

Type	Method
abstract UnitOfWork	acquireUnitOfWork() PUBLIC: Return a unit of work for this session.
void	beginTransaction() PUBLIC: Start a transaction on the server.
void	commitTransaction() PUBLIC: Commit a transaction on the server.
abstract java.lang.Object	executeQuery(DatabaseQuery query) Execute the database query.
java.lang.Object	executeQuery(java.lang.String queryName) PUBLIC: Execute the pre-defined query by name and return the result.
java.lang.Object	executeQuery(java.lang.String queryName, java.lang.Class domainClass) PUBLIC: Execute the pre-defined query by name and return the result.
java.lang.Object	executeQuery(java.lang.String queryName, java.lang.Class domainClass, java.util.Vector argumentValues) PUBLIC: Execute the pre-defined query by name and return the result.
java.lang.Object	executeQuery(java.lang.String queryName, java.util.Vector argumentValues) PUBLIC: Execute the pre-defined query by name and return the result.
void	initializeAllIdentityMaps() Reset the entire object cache.
boolean	isConnected() PUBLIC: Return if this session is connected.
void	rollbackTransaction() PUBLIC: Rollback a transaction on the server.
java.lang.String	toString() PUBLIC: Avoid printing the accessor and platform.

Methods inherited from class oracle.toplink.publicinterface.Session

None

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributedSession

public DistributedSession(oracle.toplink.internal.remote.RemoteConnection remoteConnection)

PUBLIC: Creates a DistributedSession.

Parameters:

remoteConnection - remote session requires a remote connection. This must be accessed remotely from the client through RMI or CORBA.

Method Detail

acquireUnitOfWork

public abstract UnitOfWork acquireUnitOfWork()

PUBLIC: Return a unit of work for this session. The unit of work is an object level transaction that allows a group of changes to be applied as a unit.

Overrides:

acquireUnitOfWork in class Session

See Also:

beginTransaction

public void beginTransaction()

PUBLIC: Start a transaction on the server. A unit of work should normally be used instead of transactions for the remote session.

Overrides:

beginTransaction in class Session

Following copied from class: oracle.toplink.publicinterface.Session

Throws:

DatabaseException - if the database connection is lost or the begin is rejected.

ConcurrencyException - if this session's transaction is aquired by another thread and a timeout occurs.

See Also:

commitTransaction

public void commitTransaction()

PUBLIC: Commit a transaction on the server. A unit of work should normally be used instead of transactions for the remote session.

Overrides:

commitTransaction in class Session

Following copied from class: oracle.toplink.publicinterface.Session

Throws:

DatabaseException - most databases validate changes as they are done, normally errors do not occur on commit unless the disk fails or the connection is lost.

ConcurrencyException - if this session is not within a transaction.

executeQuery

public java.lang.Object executeQuery(java.lang.String queryName)
                              throws DatabaseException

PUBLIC: Execute the pre-defined query by name and return the result. Queries can be pre-defined and named to allow for their reuse. The named query can be defined on the remote session or the server-side session.

Overrides:

executeQuery in class Session

See Also:

Session.addQuery(String, DatabaseQuery)

executeQuery

public java.lang.Object executeQuery(java.lang.String queryName,
                                     java.lang.Class domainClass)
                              throws DatabaseException

PUBLIC: Execute the pre-defined query by name and return the result. Queries can be pre-defined and named to allow for their reuse. The class is the descriptor in which the query was pre-defined. The query is executed on the server-side session.

Overrides:

executeQuery in class Session

See Also:

DescriptorQueryManager.addQuery(String, DatabaseQuery)

executeQuery

public java.lang.Object executeQuery(java.lang.String queryName,
                                     java.lang.Class domainClass,
                                     java.util.Vector argumentValues)
                              throws DatabaseException

PUBLIC: Execute the pre-defined query by name and return the result. Queries can be pre-defined and named to allow for their reuse. The class is the descriptor in which the query was pre-defined.

Overrides:

executeQuery in class Session

See Also:

DescriptorQueryManager.addQuery(String, DatabaseQuery)

executeQuery

public java.lang.Object executeQuery(java.lang.String queryName,
                                     java.util.Vector argumentValues)
                              throws DatabaseException

PUBLIC: Execute the pre-defined query by name and return the result. Queries can be pre-defined and named to allow for their reuse.

Overrides:

executeQuery in class Session

See Also:

Session.addQuery(String, DatabaseQuery)

executeQuery

public abstract java.lang.Object executeQuery(DatabaseQuery query)

Execute the database query.

Overrides:

executeQuery in class Session

Following copied from class: oracle.toplink.publicinterface.Session

See Also:

DatabaseQuery

initializeAllIdentityMaps

public void initializeAllIdentityMaps()

Reset the entire object cache. This method blows away both this session's and its parents caches, including the server cache or any other cache. This throws away any objects that have been read in. Extream caution should be used before doing this because object identity will no longer be maintained for any objects currently read in. This should only be called if the application knows that it no longer has references to object held in the cache.

Overrides:

initializeAllIdentityMaps in class Session

isConnected

public boolean isConnected()

PUBLIC: Return if this session is connected.

Overrides:

isConnected in class Session

rollbackTransaction

public void rollbackTransaction()

PUBLIC: Rollback a transaction on the server. A unit of work should normally be used instead of transactions for the remote session.

Overrides:

rollbackTransaction in class Session

Following copied from class: oracle.toplink.publicinterface.Session

Throws:

DatabaseException - if the database connection is lost or the rollback fails.

ConcurrencyException - if this session is not within a transaction.

toString

public java.lang.String toString()

PUBLIC: Avoid printing the accessor and platform.

Overrides:

toString in class Session