EclipseLink 1.0_1.0M2 API Reference - Incubation

org.eclipse.persistence.sessions.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
 Transporter beginTransaction()
           
 Transporter commitRootUnitOfWork(Transporter remoteUnitOfWork)
          To commit remote unit of work on the server side.
 Transporter commitTransaction()
          Commit a transaction on the database.
 Transporter cursoredStreamClose(Transporter remoetCursoredStreamID)
          Used for closing cursored streams across RMI.
 Transporter cursoredStreamNextPage(Transporter remoteCursoredStream, int pageSize)
          Retrieve next page size of objects from the remote cursored stream
 Transporter cursoredStreamSize(Transporter cursoredStream)
          INTERNAL: Return the cursored stream size
 Transporter cursorSelectObjects(Transporter policy)
          To get remote cursor stub in a transporter
 Transporter executeNamedQuery(Transporter name, Transporter theClass, Transporter arguments)
          A remote query after serialization is executed locally.
 Transporter executeQuery(Transporter query)
          To execute remote query on the server side.
 Transporter getDefaultReadOnlyClasses()
          To get the default read-only classes from the server side.
 Transporter getDescriptor(Transporter domainClass)
          To get descriptor from the server side
 Transporter getLogin()
          To get login from the server side
 Transporter getSequenceNumberNamed(Transporter remoteFunctionCall)
          INTERNAL: Get the value returned by remote function call
 Transporter initializeIdentityMapsOnServerSession()
           
 Transporter instantiateRemoteValueHolderOnServer(Transporter remoteValueHolder)
          To instantiate remote value holder on the server side.
 Transporter processCommand(Transporter remoteTransporter)
          INTERNAL: This method is intended to be used by by sessions that wish to execute a command on a remote session
 Transporter rollbackTransaction()
          Rollback a transaction on the database.
 Transporter scrollableCursorAbsolute(Transporter remoteScrollableCursorOid, int rows)
          Moves the cursor to the given row number in the result set
 Transporter scrollableCursorAfterLast(Transporter remoteScrollableCursorOid)
          Moves the cursor to the end of the result set, just after the last row.
 Transporter scrollableCursorBeforeFirst(Transporter remoteScrollableCursor)
          Moves the cursor to the front of the result set, just before the first row
 Transporter scrollableCursorClose(Transporter remoteScrollableCursorOid)
          Used for closing scrollable cursor across RMI.
 Transporter scrollableCursorCurrentIndex(Transporter remoteScrollableCursor)
          Retrieves the current row index number
 Transporter scrollableCursorFirst(Transporter remoteScrollableCursor)
          Moves the cursor to the first row in the result set
 Transporter scrollableCursorIsAfterLast(Transporter remoteScrollableCursor)
          Indicates whether the cursor is after the last row in the result set.
 Transporter scrollableCursorIsBeforeFirst(Transporter remoteScrollableCursor)
          Indicates whether the cursor is before the first row in the result set.
 Transporter scrollableCursorIsFirst(Transporter remoteScrollableCursor)
          Indicates whether the cursor is on the first row of the result set.
 Transporter scrollableCursorIsLast(Transporter remoteScrollableCursor)
          Indicates whether the cursor is on the last row of the result set.
 Transporter scrollableCursorLast(Transporter remoteScrollableCursor)
          Moves the cursor to the last row in the result set
 Transporter scrollableCursorNextObject(Transporter scrollableCursorOid)
          INTERNAL: Retrieve next object from the scrollable cursor
 Transporter scrollableCursorPreviousObject(Transporter scrollableCursorOid)
          INTERNAL: Retrieve previous object from the scrollable cursor
 Transporter scrollableCursorRelative(Transporter remoteScrollableCursor, int rows)
          Moves the cursor to the given row number in the result set
 Transporter scrollableCursorSize(Transporter cursoredStream)
          INTERNAL: Return the cursor size
 

Method Detail

processCommand

Transporter processCommand(Transporter remoteTransporter)
                           throws java.rmi.RemoteException
INTERNAL: This method is intended to be used by by sessions that wish to execute a command on a remote session

Parameters:
remoteCommand - RemoteCommand The command to be executed on the remote session
Throws:
java.rmi.RemoteException

beginTransaction

Transporter beginTransaction()
                             throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

commitRootUnitOfWork

Transporter commitRootUnitOfWork(Transporter remoteUnitOfWork)
                                 throws java.rmi.RemoteException
To commit remote unit of work on the server side.

Throws:
java.rmi.RemoteException

commitTransaction

Transporter commitTransaction()
                              throws java.rmi.RemoteException
Commit a transaction on the database.

Throws:
java.rmi.RemoteException

cursoredStreamClose

Transporter cursoredStreamClose(Transporter remoetCursoredStreamID)
                                throws java.rmi.RemoteException
Used for closing cursored streams across RMI.

Throws:
java.rmi.RemoteException

cursoredStreamNextPage

Transporter cursoredStreamNextPage(Transporter remoteCursoredStream,
                                   int pageSize)
                                   throws java.rmi.RemoteException
Retrieve next page size of objects from the remote cursored stream

Throws:
java.rmi.RemoteException

cursoredStreamSize

Transporter cursoredStreamSize(Transporter cursoredStream)
                               throws java.rmi.RemoteException
INTERNAL: Return the cursored stream size

Throws:
java.rmi.RemoteException

cursorSelectObjects

Transporter cursorSelectObjects(Transporter policy)
                                throws java.rmi.RemoteException
To get remote cursor stub in a transporter

Throws:
java.rmi.RemoteException

executeNamedQuery

Transporter executeNamedQuery(Transporter name,
                              Transporter theClass,
                              Transporter arguments)
                              throws java.rmi.RemoteException
A remote query after serialization is executed locally.

Throws:
java.rmi.RemoteException

executeQuery

Transporter executeQuery(Transporter query)
                         throws java.rmi.RemoteException
To execute remote query on the server side.

Throws:
java.rmi.RemoteException

getDefaultReadOnlyClasses

Transporter getDefaultReadOnlyClasses()
                                      throws java.rmi.RemoteException
To get the default read-only classes from the server side.

Throws:
java.rmi.RemoteException

getDescriptor

Transporter getDescriptor(Transporter domainClass)
                          throws java.rmi.RemoteException
To get descriptor from the server side

Throws:
java.rmi.RemoteException

getLogin

Transporter getLogin()
                     throws java.rmi.RemoteException
To get login from the server side

Throws:
java.rmi.RemoteException

getSequenceNumberNamed

Transporter getSequenceNumberNamed(Transporter remoteFunctionCall)
                                   throws java.rmi.RemoteException
INTERNAL: Get the value returned by remote function call

Throws:
java.rmi.RemoteException

initializeIdentityMapsOnServerSession

Transporter initializeIdentityMapsOnServerSession()
                                                  throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

instantiateRemoteValueHolderOnServer

Transporter instantiateRemoteValueHolderOnServer(Transporter remoteValueHolder)
                                                 throws java.rmi.RemoteException
To instantiate remote value holder on the server side.

Throws:
java.rmi.RemoteException

rollbackTransaction

Transporter rollbackTransaction()
                                throws java.rmi.RemoteException
Rollback a transaction on the database.

Throws:
java.rmi.RemoteException

scrollableCursorAbsolute

Transporter scrollableCursorAbsolute(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

Transporter scrollableCursorAfterLast(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

Transporter scrollableCursorBeforeFirst(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

Transporter scrollableCursorClose(Transporter remoteScrollableCursorOid)
                                  throws java.rmi.RemoteException
Used for closing scrollable cursor across RMI.

Throws:
java.rmi.RemoteException

scrollableCursorCurrentIndex

Transporter scrollableCursorCurrentIndex(Transporter remoteScrollableCursor)
                                         throws java.rmi.RemoteException
Retrieves the current row index number

Throws:
java.rmi.RemoteException

scrollableCursorFirst

Transporter scrollableCursorFirst(Transporter remoteScrollableCursor)
                                  throws java.rmi.RemoteException
Moves the cursor to the first row in the result set

Throws:
java.rmi.RemoteException

scrollableCursorIsAfterLast

Transporter scrollableCursorIsAfterLast(Transporter remoteScrollableCursor)
                                        throws java.rmi.RemoteException
Indicates whether the cursor is after the last row in the result set.

Throws:
java.rmi.RemoteException

scrollableCursorIsBeforeFirst

Transporter scrollableCursorIsBeforeFirst(Transporter remoteScrollableCursor)
                                          throws java.rmi.RemoteException
Indicates whether the cursor is before the first row in the result set.

Throws:
java.rmi.RemoteException

scrollableCursorIsFirst

Transporter scrollableCursorIsFirst(Transporter remoteScrollableCursor)
                                    throws java.rmi.RemoteException
Indicates whether the cursor is on the first row of the result set.

Throws:
java.rmi.RemoteException

scrollableCursorIsLast

Transporter scrollableCursorIsLast(Transporter remoteScrollableCursor)
                                   throws java.rmi.RemoteException
Indicates whether the cursor is on the last row of the result set.

Throws:
java.rmi.RemoteException

scrollableCursorLast

Transporter scrollableCursorLast(Transporter remoteScrollableCursor)
                                 throws java.rmi.RemoteException
Moves the cursor to the last row in the result set

Throws:
java.rmi.RemoteException

scrollableCursorNextObject

Transporter scrollableCursorNextObject(Transporter scrollableCursorOid)
                                       throws java.rmi.RemoteException
INTERNAL: Retrieve next object from the scrollable cursor

Throws:
java.rmi.RemoteException

scrollableCursorPreviousObject

Transporter scrollableCursorPreviousObject(Transporter scrollableCursorOid)
                                           throws java.rmi.RemoteException
INTERNAL: Retrieve previous object from the scrollable cursor

Throws:
java.rmi.RemoteException

scrollableCursorRelative

Transporter scrollableCursorRelative(Transporter remoteScrollableCursor,
                                     int rows)
                                     throws java.rmi.RemoteException
Moves the cursor to the given row number in the result set

Throws:
java.rmi.RemoteException

scrollableCursorSize

Transporter scrollableCursorSize(Transporter cursoredStream)
                                 throws java.rmi.RemoteException
INTERNAL: Return the cursor size

Throws:
java.rmi.RemoteException

EclipseLink 1.0_1.0M2 API Reference - Incubation