oracle.toplink.remote.rmi
Interface RMIRemoteSessionController

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

RMIRemoteSessionControllerDispatcher

public interface RMIRemoteSessionController

extends java.rmi.Remote

Defines the public methods remote connection can invoke on the remote session controller.

Method Summary

oracle.toplink.internal.remote.Transporter	beginTransaction()
oracle.toplink.internal.remote.Transporter	commitRootUnitOfWork(oracle.toplink.internal.remote.Transporter remoteUnitOfWork) To commit remote unit of work on the server side.
oracle.toplink.internal.remote.Transporter	commitTransaction() Commit a transaction on the database.
oracle.toplink.internal.remote.Transporter	compareObjects(oracle.toplink.internal.remote.Transporter firstObject, oracle.toplink.internal.remote.Transporter secondObject) TESTING: Return if the two object match completely.
oracle.toplink.internal.remote.Transporter	compareObjectsDontMatch(oracle.toplink.internal.remote.Transporter firstObject, oracle.toplink.internal.remote.Transporter secondObject) TESTING: Return true if the object do not match.
oracle.toplink.internal.remote.Transporter	containsObjectInIdentityMap(oracle.toplink.internal.remote.Transporter domainObject) ADVANCED: Return if their is an object for the primary key.
oracle.toplink.internal.remote.Transporter	containsObjectInIdentityMap(oracle.toplink.internal.remote.Transporter primaryKey, oracle.toplink.internal.remote.Transporter theClass) ADVANCED: Return if their is an object for the primary key.
oracle.toplink.internal.remote.Transporter	cursoredStreamClose(oracle.toplink.internal.remote.Transporter remoetCursoredStreamID) Used for closing cursored streams across RMI.
oracle.toplink.internal.remote.Transporter	cursoredStreamNextPage(oracle.toplink.internal.remote.Transporter remoteCursoredStream, int pageSize) Retrieve next page size of objects from the remote cursored stream
oracle.toplink.internal.remote.Transporter	cursorSelectObjects(oracle.toplink.internal.remote.Transporter policy) To get remote cursor stub in a transporter
oracle.toplink.internal.remote.Transporter	executeNamedQuery(oracle.toplink.internal.remote.Transporter name, oracle.toplink.internal.remote.Transporter theClass, oracle.toplink.internal.remote.Transporter arguments) A remote query after serialization is executed locally.
oracle.toplink.internal.remote.Transporter	executeQuery(oracle.toplink.internal.remote.Transporter query) To execute remote query on the server side.
oracle.toplink.internal.remote.Transporter	getDefaultReadOnlyClasses() To get the default read-only classes from the server side.
oracle.toplink.internal.remote.Transporter	getDescriptor(oracle.toplink.internal.remote.Transporter domainClass) To get descriptor from the server side
oracle.toplink.internal.remote.Transporter	getExceptionHandler() PUBLIC: Return the ExceptionHandler.Exception handler can catch errors that occur on queries or during database access.
oracle.toplink.internal.remote.Transporter	getFromIdentityMap(oracle.toplink.internal.remote.Transporter domainObject) ADVANCED: Return the object from the identity with primary and class of the given object.
oracle.toplink.internal.remote.Transporter	getFromIdentityMap(oracle.toplink.internal.remote.Transporter primaryKey, oracle.toplink.internal.remote.Transporter theClass) ADVANCED: Return the object from the identity with the primary and class.
oracle.toplink.internal.remote.Transporter	getLogin() To get login from the server side
oracle.toplink.internal.remote.Transporter	getProfiler() PUBLIC: Return the profiler.
oracle.toplink.internal.remote.Transporter	getRemoteLog() PUBLIC: Return the writer to which an accessor writes logged messages and SQL.
oracle.toplink.internal.remote.Transporter	getSessionLog() PUBLIC: Return the session log to which an accessor logs messages and SQL.
oracle.toplink.internal.remote.Transporter	initializeIdentityMap(oracle.toplink.internal.remote.Transporter theClass) PUBLIC: Reset the identity map for only the instances of the class.
oracle.toplink.internal.remote.Transporter	initializeIdentityMapsOnServerSession()
oracle.toplink.internal.remote.Transporter	instantiateRemoteValueHolderOnServer(oracle.toplink.internal.remote.Transporter remoteValueHolder) To instantiate remote value holder on the server side.
oracle.toplink.internal.remote.Transporter	isConnected() Return if remote session is connected or not
oracle.toplink.internal.remote.Transporter	log(oracle.toplink.internal.remote.Transporter entry) Log the log entry.
oracle.toplink.internal.remote.Transporter	printIdentityMap(oracle.toplink.internal.remote.Transporter businessClass) PUBLIC: Used to print all the objects in the identity map of the passed in class.
oracle.toplink.internal.remote.Transporter	printIdentityMaps() PUBLIC: Used to print all the objects in every identity map in this session.
oracle.toplink.internal.remote.Transporter	removeFromIdentityMap(oracle.toplink.internal.remote.Transporter domainObject) ADVANCED: Remove the object from the object cache.
oracle.toplink.internal.remote.Transporter	removeFromIdentityMap(oracle.toplink.internal.remote.Transporter key, oracle.toplink.internal.remote.Transporter theClass) ADVANCED: Remove the object from the object cache.
oracle.toplink.internal.remote.Transporter	rollbackTransaction() Rollback a transaction on the database.
oracle.toplink.internal.remote.Transporter	scrollableCursorAbsolute(oracle.toplink.internal.remote.Transporter remoteScrollableCursorOid, int rows) Moves the cursor to the given row number in the result set
oracle.toplink.internal.remote.Transporter	scrollableCursorAfterLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursorOid) Moves the cursor to the end of the result set, just after the last row.
oracle.toplink.internal.remote.Transporter	scrollableCursorBeforeFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) Moves the cursor to the front of the result set, just before the first row
oracle.toplink.internal.remote.Transporter	scrollableCursorClose(oracle.toplink.internal.remote.Transporter remoteScrollableCursorOid) Used for closing scrollable cursor across RMI.
oracle.toplink.internal.remote.Transporter	scrollableCursorCurrentIndex(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) Retrieves the current row index number
oracle.toplink.internal.remote.Transporter	scrollableCursorFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) Moves the cursor to the first row in the result set
oracle.toplink.internal.remote.Transporter	scrollableCursorIsAfterLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) Indicates whether the cursor is after the last row in the result set.
oracle.toplink.internal.remote.Transporter	scrollableCursorIsBeforeFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) Indicates whether the cursor is before the first row in the result set.
oracle.toplink.internal.remote.Transporter	scrollableCursorIsFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) Indicates whether the cursor is on the first row of the result set.
oracle.toplink.internal.remote.Transporter	scrollableCursorIsLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) Indicates whether the cursor is on the last row of the result set.
oracle.toplink.internal.remote.Transporter	scrollableCursorLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) Moves the cursor to the last row in the result set
oracle.toplink.internal.remote.Transporter	scrollableCursorRelative(oracle.toplink.internal.remote.Transporter remoteScrollableCursor, int rows) Moves the cursor to the given row number in the result set
oracle.toplink.internal.remote.Transporter	setExceptionHandler(oracle.toplink.internal.remote.Transporter exceptionHandler) PUBLIC: Set the exceptionHandler.
oracle.toplink.internal.remote.Transporter	setLog(oracle.toplink.internal.remote.Transporter log) PUBLIC: Set the writer to which an accessor writes logged messages and SQL.
oracle.toplink.internal.remote.Transporter	setProfiler(oracle.toplink.internal.remote.Transporter profiler) PUBLIC: Set the profiler for the session.
oracle.toplink.internal.remote.Transporter	setSessionLog(oracle.toplink.internal.remote.Transporter sessionLog) PUBLIC: Set the session log to which an accessor logs messages and SQL.
oracle.toplink.internal.remote.Transporter	setShouldLogMessages(oracle.toplink.internal.remote.Transporter shouldLogMessages) PUBLIC: Set messages logging.
oracle.toplink.internal.remote.Transporter	shouldLogMessages() Return if all messages such as executed SQL commands should be logged.
oracle.toplink.internal.remote.Transporter	validateCache() ADVANCED: This can be used to help debugging an object identity problem.

Method Detail

beginTransaction

public oracle.toplink.internal.remote.Transporter beginTransaction()
                                                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

commitRootUnitOfWork

public oracle.toplink.internal.remote.Transporter commitRootUnitOfWork(oracle.toplink.internal.remote.Transporter remoteUnitOfWork)
                                                                throws java.rmi.RemoteException

To commit remote unit of work on the server side.

Throws:

java.rmi.RemoteException

commitTransaction

public oracle.toplink.internal.remote.Transporter commitTransaction()
                                                             throws java.rmi.RemoteException

Commit a transaction on the database.

Throws:

java.rmi.RemoteException

compareObjects

public oracle.toplink.internal.remote.Transporter compareObjects(oracle.toplink.internal.remote.Transporter firstObject,
                                                                 oracle.toplink.internal.remote.Transporter secondObject)
                                                          throws java.rmi.RemoteException

TESTING: Return if the two object match completely. This checks the objects attributes and their private parts.

Throws:

java.rmi.RemoteException

compareObjectsDontMatch

public oracle.toplink.internal.remote.Transporter compareObjectsDontMatch(oracle.toplink.internal.remote.Transporter firstObject,
                                                                          oracle.toplink.internal.remote.Transporter secondObject)
                                                                   throws java.rmi.RemoteException

TESTING: Return true if the object do not match. This checks the objects attributes and their private parts.

Throws:

java.rmi.RemoteException

containsObjectInIdentityMap

public oracle.toplink.internal.remote.Transporter containsObjectInIdentityMap(oracle.toplink.internal.remote.Transporter domainObject)
                                                                       throws java.rmi.RemoteException

ADVANCED: Return if their is an object for the primary key.

Throws:

java.rmi.RemoteException

containsObjectInIdentityMap

public oracle.toplink.internal.remote.Transporter containsObjectInIdentityMap(oracle.toplink.internal.remote.Transporter primaryKey,
                                                                              oracle.toplink.internal.remote.Transporter theClass)
                                                                       throws java.rmi.RemoteException

ADVANCED: Return if their is an object for the primary key.

Throws:

java.rmi.RemoteException

cursoredStreamClose

public oracle.toplink.internal.remote.Transporter cursoredStreamClose(oracle.toplink.internal.remote.Transporter remoetCursoredStreamID)
                                                               throws java.rmi.RemoteException

Used for closing cursored streams across RMI.

Throws:

java.rmi.RemoteException

cursoredStreamNextPage

public oracle.toplink.internal.remote.Transporter cursoredStreamNextPage(oracle.toplink.internal.remote.Transporter remoteCursoredStream,
                                                                         int pageSize)
                                                                  throws java.rmi.RemoteException

Retrieve next page size of objects from the remote cursored stream

Throws:

java.rmi.RemoteException

cursorSelectObjects

public oracle.toplink.internal.remote.Transporter cursorSelectObjects(oracle.toplink.internal.remote.Transporter policy)
                                                               throws java.rmi.RemoteException

To get remote cursor stub in a transporter

Throws:

java.rmi.RemoteException

executeNamedQuery

public oracle.toplink.internal.remote.Transporter executeNamedQuery(oracle.toplink.internal.remote.Transporter name,
                                                                    oracle.toplink.internal.remote.Transporter theClass,
                                                                    oracle.toplink.internal.remote.Transporter arguments)
                                                             throws java.rmi.RemoteException

A remote query after serialization is executed locally.

Throws:

java.rmi.RemoteException

executeQuery

public oracle.toplink.internal.remote.Transporter executeQuery(oracle.toplink.internal.remote.Transporter query)
                                                        throws java.rmi.RemoteException

To execute remote query on the server side.

Throws:

java.rmi.RemoteException

getDefaultReadOnlyClasses

public oracle.toplink.internal.remote.Transporter getDefaultReadOnlyClasses()
                                                                     throws java.rmi.RemoteException

To get the default read-only classes from the server side.

Throws:

java.rmi.RemoteException

getDescriptor

public oracle.toplink.internal.remote.Transporter getDescriptor(oracle.toplink.internal.remote.Transporter domainClass)
                                                         throws java.rmi.RemoteException

To get descriptor from the server side

Throws:

java.rmi.RemoteException

getExceptionHandler

public oracle.toplink.internal.remote.Transporter getExceptionHandler()
                                                               throws java.rmi.RemoteException

PUBLIC: Return the ExceptionHandler.Exception handler can catch errors that occur on queries or during database access.

Throws:

java.rmi.RemoteException

getFromIdentityMap

public oracle.toplink.internal.remote.Transporter getFromIdentityMap(oracle.toplink.internal.remote.Transporter domainObject)
                                                              throws java.rmi.RemoteException

ADVANCED: Return the object from the identity with primary and class of the given object.

Throws:

java.rmi.RemoteException

getFromIdentityMap

public oracle.toplink.internal.remote.Transporter getFromIdentityMap(oracle.toplink.internal.remote.Transporter primaryKey,
                                                                     oracle.toplink.internal.remote.Transporter theClass)
                                                              throws java.rmi.RemoteException

ADVANCED: Return the object from the identity with the primary and class.

Throws:

java.rmi.RemoteException

getLogin

public oracle.toplink.internal.remote.Transporter getLogin()
                                                    throws java.rmi.RemoteException

To get login from the server side

Throws:

java.rmi.RemoteException

getProfiler

public oracle.toplink.internal.remote.Transporter getProfiler()
                                                       throws java.rmi.RemoteException

PUBLIC: Return the profiler. The profiler is a tool that can be used to determine performance bottlenecks. The profiler can be queries to print summaries and configure for logging purposes.

Throws:

java.rmi.RemoteException

getRemoteLog

public oracle.toplink.internal.remote.Transporter getRemoteLog()
                                                        throws java.rmi.RemoteException

PUBLIC: Return the writer to which an accessor writes logged messages and SQL. If not set, this reference defaults to a writer on System.out. To enable logging, logMessages must be turned on.

Throws:

java.rmi.RemoteException

See Also:

#logMessages()

getSessionLog

public oracle.toplink.internal.remote.Transporter getSessionLog()
                                                         throws java.rmi.RemoteException

PUBLIC: Return the session log to which an accessor logs messages and SQL. If not set, this will default to a session log on a writer on System.out. To enable logging, logMessages must be turned on.

Throws:

java.rmi.RemoteException

See Also:

#logMessages()

initializeIdentityMap

public oracle.toplink.internal.remote.Transporter initializeIdentityMap(oracle.toplink.internal.remote.Transporter theClass)
                                                                 throws java.rmi.RemoteException

PUBLIC: Reset the identity map for only the instances of the class. For inheritance the user must make sure that they only use the root class. Caution must be used in doing this to ensure that the objects within the identity map are not referenced from other objects of other classes or from the application.

Throws:

java.rmi.RemoteException

initializeIdentityMapsOnServerSession

public oracle.toplink.internal.remote.Transporter initializeIdentityMapsOnServerSession()
                                                                                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

instantiateRemoteValueHolderOnServer

public oracle.toplink.internal.remote.Transporter instantiateRemoteValueHolderOnServer(oracle.toplink.internal.remote.Transporter remoteValueHolder)
                                                                                throws java.rmi.RemoteException

To instantiate remote value holder on the server side.

Throws:

java.rmi.RemoteException

isConnected

public oracle.toplink.internal.remote.Transporter isConnected()
                                                       throws java.rmi.RemoteException

Return if remote session is connected or not

Throws:

java.rmi.RemoteException

log

public oracle.toplink.internal.remote.Transporter log(oracle.toplink.internal.remote.Transporter entry)
                                               throws java.rmi.RemoteException

Log the log entry.

Throws:

java.rmi.RemoteException

printIdentityMap

public oracle.toplink.internal.remote.Transporter printIdentityMap(oracle.toplink.internal.remote.Transporter businessClass)
                                                            throws java.rmi.RemoteException

PUBLIC: Used to print all the objects in the identity map of the passed in class. The output of this method will go the the Session's log.

Throws:

java.rmi.RemoteException

printIdentityMaps

public oracle.toplink.internal.remote.Transporter printIdentityMaps()
                                                             throws java.rmi.RemoteException

PUBLIC: Used to print all the objects in every identity map in this session. The output of this method will go to the Session's log.

Throws:

java.rmi.RemoteException

removeFromIdentityMap

public oracle.toplink.internal.remote.Transporter removeFromIdentityMap(oracle.toplink.internal.remote.Transporter domainObject)
                                                                 throws java.rmi.RemoteException

ADVANCED: Remove the object from the object cache. Caution should be used when calling to avoid violating object identity. The application should only call this is it knows that no references to the object exist.

Throws:

java.rmi.RemoteException

removeFromIdentityMap

public oracle.toplink.internal.remote.Transporter removeFromIdentityMap(oracle.toplink.internal.remote.Transporter key,
                                                                        oracle.toplink.internal.remote.Transporter theClass)
                                                                 throws java.rmi.RemoteException

ADVANCED: Remove the object from the object cache. Caution should be used when calling to avoid violating object identity. The application should only call this is it knows that no references to the object exist.

Throws:

java.rmi.RemoteException

rollbackTransaction

public oracle.toplink.internal.remote.Transporter rollbackTransaction()
                                                               throws java.rmi.RemoteException

Rollback a transaction on the database.

Throws:

java.rmi.RemoteException

scrollableCursorAbsolute

public oracle.toplink.internal.remote.Transporter scrollableCursorAbsolute(oracle.toplink.internal.remote.Transporter remoteScrollableCursorOid,
                                                                           int rows)
                                                                    throws java.rmi.RemoteException

Moves the cursor to the given row number in the result set

Throws:

java.rmi.RemoteException

scrollableCursorAfterLast

public oracle.toplink.internal.remote.Transporter scrollableCursorAfterLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursorOid)
                                                                     throws java.rmi.RemoteException

Moves the cursor to the end of the result set, just after the last row.

Throws:

java.rmi.RemoteException

scrollableCursorBeforeFirst

public oracle.toplink.internal.remote.Transporter scrollableCursorBeforeFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)
                                                                       throws java.rmi.RemoteException

Moves the cursor to the front of the result set, just before the first row

Throws:

java.rmi.RemoteException

scrollableCursorClose

public oracle.toplink.internal.remote.Transporter scrollableCursorClose(oracle.toplink.internal.remote.Transporter remoteScrollableCursorOid)
                                                                 throws java.rmi.RemoteException

Used for closing scrollable cursor across RMI.

Throws:

java.rmi.RemoteException

scrollableCursorCurrentIndex

public oracle.toplink.internal.remote.Transporter scrollableCursorCurrentIndex(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)
                                                                        throws java.rmi.RemoteException

Retrieves the current row index number

Throws:

java.rmi.RemoteException

scrollableCursorFirst

public oracle.toplink.internal.remote.Transporter scrollableCursorFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)
                                                                 throws java.rmi.RemoteException

Moves the cursor to the first row in the result set

Throws:

java.rmi.RemoteException

scrollableCursorIsAfterLast

public oracle.toplink.internal.remote.Transporter scrollableCursorIsAfterLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)
                                                                       throws java.rmi.RemoteException

Indicates whether the cursor is after the last row in the result set.

Throws:

java.rmi.RemoteException

scrollableCursorIsBeforeFirst

public oracle.toplink.internal.remote.Transporter scrollableCursorIsBeforeFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)
                                                                         throws java.rmi.RemoteException

Indicates whether the cursor is before the first row in the result set.

Throws:

java.rmi.RemoteException

scrollableCursorIsFirst

public oracle.toplink.internal.remote.Transporter scrollableCursorIsFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)
                                                                   throws java.rmi.RemoteException

Indicates whether the cursor is on the first row of the result set.

Throws:

java.rmi.RemoteException

scrollableCursorIsLast

public oracle.toplink.internal.remote.Transporter scrollableCursorIsLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)
                                                                  throws java.rmi.RemoteException

Indicates whether the cursor is on the last row of the result set.

Throws:

java.rmi.RemoteException

scrollableCursorLast

public oracle.toplink.internal.remote.Transporter scrollableCursorLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)
                                                                throws java.rmi.RemoteException

Moves the cursor to the last row in the result set

Throws:

java.rmi.RemoteException

scrollableCursorRelative

public oracle.toplink.internal.remote.Transporter scrollableCursorRelative(oracle.toplink.internal.remote.Transporter remoteScrollableCursor,
                                                                           int rows)
                                                                    throws java.rmi.RemoteException

Moves the cursor to the given row number in the result set

Throws:

java.rmi.RemoteException

setExceptionHandler

public oracle.toplink.internal.remote.Transporter setExceptionHandler(oracle.toplink.internal.remote.Transporter exceptionHandler)
                                                               throws java.rmi.RemoteException

PUBLIC: Set the exceptionHandler. Exception handler can catch errors that occur on queries or during database access.

Throws:

java.rmi.RemoteException

setLog

public oracle.toplink.internal.remote.Transporter setLog(oracle.toplink.internal.remote.Transporter log)
                                                  throws java.rmi.RemoteException

PUBLIC: Set the writer to which an accessor writes logged messages and SQL. If not set, this reference defaults to a writer on System.out. To enable logging logMessages() is used.

Throws:

java.rmi.RemoteException

See Also:

#logMessages()

setProfiler

public oracle.toplink.internal.remote.Transporter setProfiler(oracle.toplink.internal.remote.Transporter profiler)
                                                       throws java.rmi.RemoteException

PUBLIC: Set the profiler for the session. This allows for performance operations to be profiled.

Throws:

java.rmi.RemoteException

setSessionLog

public oracle.toplink.internal.remote.Transporter setSessionLog(oracle.toplink.internal.remote.Transporter sessionLog)
                                                         throws java.rmi.RemoteException

PUBLIC: Set the session log to which an accessor logs messages and SQL. If not set, this will default to a session log on a writer on System.out. To enable logging, logMessages must be turned on.

Throws:

java.rmi.RemoteException

See Also:

#logMessages()

setShouldLogMessages

public oracle.toplink.internal.remote.Transporter setShouldLogMessages(oracle.toplink.internal.remote.Transporter shouldLogMessages)
                                                                throws java.rmi.RemoteException

PUBLIC: Set messages logging. Message logging will dump all SQL executed through TopLink to the session's log. By default this is System.out, but can be set to any Writer.

Throws:

java.rmi.RemoteException

See Also:

#setLog(Writer)

shouldLogMessages

public oracle.toplink.internal.remote.Transporter shouldLogMessages()
                                                             throws java.rmi.RemoteException

Return if all messages such as executed SQL commands should be logged.

Throws:

java.rmi.RemoteException

validateCache

public oracle.toplink.internal.remote.Transporter validateCache()
                                                         throws java.rmi.RemoteException

ADVANCED: This can be used to help debugging an object identity problem. An object identity problem is when an object in the cache references an object not in the cache. This method will validate that all cached objects are in a correct state.

Throws:

java.rmi.RemoteException