oracle.toplink.remote.ejb
Class RemoteSessionControllerBean

java.lang.Object
oracle.toplink.remote.ejb.RemoteSessionControllerBean

All Implemented Interfaces:

javax.ejb.EnterpriseBean, java.io.Serializable, javax.ejb.SessionBean

public class RemoteSessionControllerBean

extends java.lang.Object

implements javax.ejb.SessionBean

PUBLIC: This is the bean home interface of an EJB Session Bean to provde TopLink communication for remote Sessions. This bean must be subclassed to be used in your particular Application Server. Certain environment properties must be defined in the deployment descriptor

See Also:

Serialized Form

Constructor Summary

RemoteSessionControllerBean()
PUBLIC: The default session bean Contructor, required by EJB spec.

Method Summary

oracle.toplink.internal.remote.Transporter	beginTransaction() PUBLIC: Begin a transaction on the database.
oracle.toplink.internal.remote.Transporter	commitTransaction() PUBLIC: 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 an object is in the identity map
oracle.toplink.internal.remote.Transporter	containsObjectInIdentityMap(oracle.toplink.internal.remote.Transporter primaryKey, oracle.toplink.internal.remote.Transporter theClass) ADVANCED: Return if an insatnce of class with known primary key is in the identity map
oracle.toplink.internal.remote.Transporter	cursoredStreamClose(oracle.toplink.internal.remote.Transporter remoteCursoredStreamID) PUBLIC: Close cursored stream across RMI.
oracle.toplink.internal.remote.Transporter	cursoredStreamNextPage(oracle.toplink.internal.remote.Transporter remoteCursoredStream, int pageSize) PUBLIC: Retrieve next page size of objects from the cursored stream.
oracle.toplink.internal.remote.Transporter	cursoredStreamSize(oracle.toplink.internal.remote.Transporter remoteCursoredStreamOid) PUBLIC: Return the cursored stream size.
void	ejbCreate() PUBLIC: This bean allows a client to connect and obtain a RemoteSession.
void	ejbCreate(java.lang.String sessionName) PUBLIC: This bean allows a client to connect and obtain a RemoteSession.
oracle.toplink.internal.remote.Transporter	executeQuery(oracle.toplink.internal.remote.Transporter query) PUBLIC: A remote query after serialization is executed locally.
oracle.toplink.internal.remote.Transporter	getDefaultReadOnlyClasses() Get the default read-only classes
oracle.toplink.internal.remote.Transporter	getDescriptor(oracle.toplink.internal.remote.Transporter theClass) PUBLIC: Extract descriptor from the session
oracle.toplink.internal.remote.Transporter	getExceptionHandler() PUBLIC: Return the ExceptionHandler.
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 key and class.
oracle.toplink.internal.remote.Transporter	getLogin() PUBLIC: Get the associated session login.
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.
java.lang.String	getSessionName() PUBLIC: Return the server session name from the application server.
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() PUBLIC: Reset the identity map for only the instances of the class on the server-side session.
oracle.toplink.internal.remote.Transporter	log(oracle.toplink.internal.remote.Transporter entry) PUBLIC: Log the log entry.
oracle.toplink.internal.remote.Transporter	printIdentityMap(oracle.toplink.internal.remote.Transporter theClass) PUBLIC: Print all instances of the specified class in the identity map.
oracle.toplink.internal.remote.Transporter	printIdentityMaps() PUBLIC: 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() PUBLIC: Rollback a transaction on the database.
oracle.toplink.internal.remote.Transporter	scrollableCursorAbsolute(oracle.toplink.internal.remote.Transporter remoteScrollableCursorOid, int rows) PUBLIC: Move the cursor to the given row number in the result set.
oracle.toplink.internal.remote.Transporter	scrollableCursorAfterLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursorOid) PUBLIC: Move 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) PUBLIC: Move 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) PUBLIC: Close the scrollable cursor across RMI.
oracle.toplink.internal.remote.Transporter	scrollableCursorCurrentIndex(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) PUBLIC: Retrieve the current row index number.
oracle.toplink.internal.remote.Transporter	scrollableCursorFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) PUBLIC: Move the cursor to the first row in the result set.
oracle.toplink.internal.remote.Transporter	scrollableCursorIsAfterLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) PUBLIC: Indicate whether the cursor is after the last row in the result set.
oracle.toplink.internal.remote.Transporter	scrollableCursorIsBeforeFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) PUBLIC: Indicate whether the cursor is before the first row in the result set.
oracle.toplink.internal.remote.Transporter	scrollableCursorIsFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) PUBLIC: Indicate whether the cursor is on the first row of the result set.
oracle.toplink.internal.remote.Transporter	scrollableCursorIsLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) PUBLIC: Indicate whether the cursor is on the last row of the result set.
oracle.toplink.internal.remote.Transporter	scrollableCursorLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursor) PUBLIC: Move the cursor to the last row in the result set
oracle.toplink.internal.remote.Transporter	scrollableCursorNextObject(oracle.toplink.internal.remote.Transporter scrollableCursorOid) PUBLIC: Retrieve next object from the scrollable cursor.
oracle.toplink.internal.remote.Transporter	scrollableCursorPreviousObject(oracle.toplink.internal.remote.Transporter scrollableCursorOid) PUBLIC: Retrieve previous object from the scrollable cursor.
oracle.toplink.internal.remote.Transporter	scrollableCursorRelative(oracle.toplink.internal.remote.Transporter remoteScrollableCursor, int rows) PUBLIC: Move the cursor to the given row number in the result set.
oracle.toplink.internal.remote.Transporter	scrollableCursorSize(oracle.toplink.internal.remote.Transporter remoteCursorOid) PUBLIC: Return the cursor size.
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	setLogin(oracle.toplink.internal.remote.Transporter login) PUBLIC: Set the login.
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.
void	setSessionName(java.lang.String sessionName) PUBLIC: Set the server session name from the application server.
oracle.toplink.internal.remote.Transporter	setShouldLogMessages(oracle.toplink.internal.remote.Transporter shouldLogMessages) PUBLIC: Set messages logging.
oracle.toplink.internal.remote.Transporter	shouldLogMessages() PUBLIC: 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteSessionControllerBean

public RemoteSessionControllerBean()
                            throws java.rmi.RemoteException

PUBLIC: The default session bean Contructor, required by EJB spec.

Method Detail

beginTransaction

public oracle.toplink.internal.remote.Transporter beginTransaction()

PUBLIC: Begin a transaction on the database.

commitTransaction

public oracle.toplink.internal.remote.Transporter commitTransaction()

PUBLIC: Commit a transaction on the database.

compareObjects

public 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. This checks the objects attributes and their private parts.

compareObjectsDontMatch

public 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. This checks the objects attributes and their private parts.

containsObjectInIdentityMap

public oracle.toplink.internal.remote.Transporter containsObjectInIdentityMap(oracle.toplink.internal.remote.Transporter domainObject)

ADVANCED: Return if an object is in the identity map

containsObjectInIdentityMap

public oracle.toplink.internal.remote.Transporter containsObjectInIdentityMap(oracle.toplink.internal.remote.Transporter primaryKey,
                                                                              oracle.toplink.internal.remote.Transporter theClass)

ADVANCED: Return if an insatnce of class with known primary key is in the identity map

cursoredStreamClose

public oracle.toplink.internal.remote.Transporter cursoredStreamClose(oracle.toplink.internal.remote.Transporter remoteCursoredStreamID)

PUBLIC: Close cursored stream across RMI.

cursoredStreamNextPage

public oracle.toplink.internal.remote.Transporter cursoredStreamNextPage(oracle.toplink.internal.remote.Transporter remoteCursoredStream,
                                                                         int pageSize)

PUBLIC: Retrieve next page size of objects from the cursored stream.

cursoredStreamSize

public oracle.toplink.internal.remote.Transporter cursoredStreamSize(oracle.toplink.internal.remote.Transporter remoteCursoredStreamOid)

PUBLIC: Return the cursored stream size.

ejbCreate

public void ejbCreate()
               throws java.rmi.RemoteException,
                      javax.ejb.CreateException

PUBLIC: This bean allows a client to connect and obtain a RemoteSession. The create method takes the necessary database login information, and creates the remote session controller, which will be used to setup a rmi connection, and thereafter create a remote session. To deploy this bean in Weblogic, you must create new stub/skel classes for RemoteSessionControllerDispatcher. This can be done with the following command line: java weblogic.rmic oracle.toplink.remote.rmi.RemoteSessionControllerBean

Throws:

java.rmi.RemoteException

javax.ejb.CreateException

ejbCreate

public void ejbCreate(java.lang.String sessionName)
               throws java.rmi.RemoteException,
                      javax.ejb.CreateException

PUBLIC: This bean allows a client to connect and obtain a RemoteSession. The create method takes the necessary database login information, and creates the remote session controller, which will be used to setup a rmi connection, and thereafter create a remote session. To deploy this bean in Weblogic, you must create new stub/skel classes for RemoteSessionControllerDispatcher. This can be done with the following command line: java weblogic.rmic oracle.toplink.remote.rmi.RemoteSessionControllerBean sessionName is the server session name from the WebLogic server

Throws:

java.rmi.RemoteException

javax.ejb.CreateException

executeQuery

public oracle.toplink.internal.remote.Transporter executeQuery(oracle.toplink.internal.remote.Transporter query)

PUBLIC: A remote query after serialization is executed locally.

getDescriptor

public oracle.toplink.internal.remote.Transporter getDescriptor(oracle.toplink.internal.remote.Transporter theClass)

PUBLIC: Extract descriptor from the session

getDefaultReadOnlyClasses

public oracle.toplink.internal.remote.Transporter getDefaultReadOnlyClasses()

Get the default read-only classes

getExceptionHandler

public oracle.toplink.internal.remote.Transporter getExceptionHandler()

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

getFromIdentityMap

public 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.

getFromIdentityMap

public 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 key and class.

getLogin

public oracle.toplink.internal.remote.Transporter getLogin()

PUBLIC: Get the associated session login.

getProfiler

public oracle.toplink.internal.remote.Transporter getProfiler()

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.

getRemoteLog

public oracle.toplink.internal.remote.Transporter getRemoteLog()

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.

See Also:

#logMessages()

getSessionLog

public oracle.toplink.internal.remote.Transporter getSessionLog()

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.

See Also:

#logMessages()

getSessionName

public java.lang.String getSessionName()
                                throws java.rmi.RemoteException

PUBLIC: Return the server session name from the application server.

Throws:

java.rmi.RemoteException

initializeIdentityMap

public oracle.toplink.internal.remote.Transporter initializeIdentityMap(oracle.toplink.internal.remote.Transporter theClass)

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.

initializeIdentityMapsOnServerSession

public oracle.toplink.internal.remote.Transporter initializeIdentityMapsOnServerSession()

PUBLIC: Reset the identity map for only the instances of the class on the server-side session. 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.

log

public oracle.toplink.internal.remote.Transporter log(oracle.toplink.internal.remote.Transporter entry)

PUBLIC: Log the log entry.

printIdentityMap

public oracle.toplink.internal.remote.Transporter printIdentityMap(oracle.toplink.internal.remote.Transporter theClass)

PUBLIC: Print all instances of the specified class in the identity map. The output of this method will go the the Session's log.

printIdentityMaps

public oracle.toplink.internal.remote.Transporter printIdentityMaps()

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

removeFromIdentityMap

public oracle.toplink.internal.remote.Transporter removeFromIdentityMap(oracle.toplink.internal.remote.Transporter domainObject)

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 only if there are no references to the object existed.

removeFromIdentityMap

public 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. Caution should be used when calling to avoid violating object identity. The application should only call this only if there are no references to the object existed.

rollbackTransaction

public oracle.toplink.internal.remote.Transporter rollbackTransaction()

PUBLIC: Rollback a transaction on the database.

scrollableCursorAbsolute

public oracle.toplink.internal.remote.Transporter scrollableCursorAbsolute(oracle.toplink.internal.remote.Transporter remoteScrollableCursorOid,
                                                                           int rows)

PUBLIC: Move the cursor to the given row number in the result set.

scrollableCursorAfterLast

public oracle.toplink.internal.remote.Transporter scrollableCursorAfterLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursorOid)

PUBLIC: Move the cursor to the end of the result set, just after the last row.

scrollableCursorBeforeFirst

public oracle.toplink.internal.remote.Transporter scrollableCursorBeforeFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)

PUBLIC: Move the cursor to the front of the result set, just before the first row.

scrollableCursorClose

public oracle.toplink.internal.remote.Transporter scrollableCursorClose(oracle.toplink.internal.remote.Transporter remoteScrollableCursorOid)

PUBLIC: Close the scrollable cursor across RMI.

scrollableCursorCurrentIndex

public oracle.toplink.internal.remote.Transporter scrollableCursorCurrentIndex(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)

PUBLIC: Retrieve the current row index number.

scrollableCursorFirst

public oracle.toplink.internal.remote.Transporter scrollableCursorFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)

PUBLIC: Move the cursor to the first row in the result set.

scrollableCursorIsAfterLast

public oracle.toplink.internal.remote.Transporter scrollableCursorIsAfterLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)

PUBLIC: Indicate whether the cursor is after the last row in the result set.

scrollableCursorIsBeforeFirst

public oracle.toplink.internal.remote.Transporter scrollableCursorIsBeforeFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)

PUBLIC: Indicate whether the cursor is before the first row in the result set.

scrollableCursorIsFirst

public oracle.toplink.internal.remote.Transporter scrollableCursorIsFirst(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)

PUBLIC: Indicate whether the cursor is on the first row of the result set.

scrollableCursorIsLast

public oracle.toplink.internal.remote.Transporter scrollableCursorIsLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)

PUBLIC: Indicate whether the cursor is on the last row of the result set.

scrollableCursorLast

public oracle.toplink.internal.remote.Transporter scrollableCursorLast(oracle.toplink.internal.remote.Transporter remoteScrollableCursor)

PUBLIC: Move the cursor to the last row in the result set

scrollableCursorNextObject

public oracle.toplink.internal.remote.Transporter scrollableCursorNextObject(oracle.toplink.internal.remote.Transporter scrollableCursorOid)

PUBLIC: Retrieve next object from the scrollable cursor.

scrollableCursorPreviousObject

public oracle.toplink.internal.remote.Transporter scrollableCursorPreviousObject(oracle.toplink.internal.remote.Transporter scrollableCursorOid)

PUBLIC: Retrieve previous object from the scrollable cursor.

scrollableCursorRelative

public oracle.toplink.internal.remote.Transporter scrollableCursorRelative(oracle.toplink.internal.remote.Transporter remoteScrollableCursor,
                                                                           int rows)

PUBLIC: Move the cursor to the given row number in the result set.

scrollableCursorSize

public oracle.toplink.internal.remote.Transporter scrollableCursorSize(oracle.toplink.internal.remote.Transporter remoteCursorOid)

PUBLIC: Return the cursor size.

setExceptionHandler

public oracle.toplink.internal.remote.Transporter setExceptionHandler(oracle.toplink.internal.remote.Transporter exceptionHandler)

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

setLog

public 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. If not set, this reference defaults to a writer on System.out. To enable logging logMessages() is used.

See Also:

#logMessages()

setLogin

public oracle.toplink.internal.remote.Transporter setLogin(oracle.toplink.internal.remote.Transporter login)

PUBLIC: Set the login.

setProfiler

public oracle.toplink.internal.remote.Transporter setProfiler(oracle.toplink.internal.remote.Transporter profiler)

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

setSessionLog

public 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. If not set, this will default to a session log on a writer on System.out. To enable logging, logMessages must be turned on.

See Also:

#logMessages()

setSessionName

public void setSessionName(java.lang.String sessionName)
                    throws java.rmi.RemoteException

PUBLIC: Set the server session name from the application server.

Throws:

java.rmi.RemoteException

setShouldLogMessages

public oracle.toplink.internal.remote.Transporter setShouldLogMessages(oracle.toplink.internal.remote.Transporter shouldLogMessages)

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.

See Also:

#setLog(Writer)

shouldLogMessages

public oracle.toplink.internal.remote.Transporter shouldLogMessages()

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

validateCache

public oracle.toplink.internal.remote.Transporter validateCache()

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.