Package 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

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

    • Method Detail

      • processCommand

        org.eclipse.persistence.internal.sessions.remote.Transporter processCommand​(org.eclipse.persistence.internal.sessions.remote.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:
        remoteTransporter - The Transporter carrying the command to be executed on the remote session
        Throws:
        java.rmi.RemoteException

      • beginTransaction

        org.eclipse.persistence.internal.sessions.remote.Transporter beginTransaction()
                                                                       throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException

      • beginEarlyTransaction

        org.eclipse.persistence.internal.sessions.remote.Transporter beginEarlyTransaction()
                                                                            throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException

      • commitRootUnitOfWork

        org.eclipse.persistence.internal.sessions.remote.Transporter commitRootUnitOfWork​(org.eclipse.persistence.internal.sessions.remote.Transporter remoteUnitOfWork)
                                                                           throws java.rmi.RemoteException
        To commit remote unit of work on the server side.
        Throws:
        java.rmi.RemoteException

      • commitTransaction

        org.eclipse.persistence.internal.sessions.remote.Transporter commitTransaction()
                                                                        throws java.rmi.RemoteException
        Commit a transaction on the database.
        Throws:
        java.rmi.RemoteException

      • cursoredStreamClose

        org.eclipse.persistence.internal.sessions.remote.Transporter cursoredStreamClose​(org.eclipse.persistence.internal.sessions.remote.Transporter remoetCursoredStreamID)
                                                                          throws java.rmi.RemoteException
        Used for closing cursored streams across RMI.
        Throws:
        java.rmi.RemoteException

      • cursoredStreamNextPage

        org.eclipse.persistence.internal.sessions.remote.Transporter cursoredStreamNextPage​(org.eclipse.persistence.internal.sessions.remote.Transporter remoteCursoredStream,
                                                                                    int pageSize)
                                                                             throws java.rmi.RemoteException
        Retrieve next page size of objects from the remote cursored stream
        Throws:
        java.rmi.RemoteException

      • cursoredStreamSize

        org.eclipse.persistence.internal.sessions.remote.Transporter cursoredStreamSize​(org.eclipse.persistence.internal.sessions.remote.Transporter cursoredStream)
                                                                         throws java.rmi.RemoteException
        INTERNAL: Return the cursored stream size
        Throws:
        java.rmi.RemoteException

      • cursorSelectObjects

        org.eclipse.persistence.internal.sessions.remote.Transporter cursorSelectObjects​(org.eclipse.persistence.internal.sessions.remote.Transporter policy)
                                                                          throws java.rmi.RemoteException
        To get remote cursor stub in a transporter
        Throws:
        java.rmi.RemoteException

      • executeNamedQuery

        org.eclipse.persistence.internal.sessions.remote.Transporter executeNamedQuery​(org.eclipse.persistence.internal.sessions.remote.Transporter name,
                                                                               org.eclipse.persistence.internal.sessions.remote.Transporter theClass,
                                                                               org.eclipse.persistence.internal.sessions.remote.Transporter arguments)
                                                                        throws java.rmi.RemoteException
        A remote query after serialization is executed locally.
        Throws:
        java.rmi.RemoteException

      • executeQuery

        org.eclipse.persistence.internal.sessions.remote.Transporter executeQuery​(org.eclipse.persistence.internal.sessions.remote.Transporter query)
                                                                   throws java.rmi.RemoteException
        To execute remote query on the server side.
        Throws:
        java.rmi.RemoteException

      • getDefaultReadOnlyClasses

        org.eclipse.persistence.internal.sessions.remote.Transporter getDefaultReadOnlyClasses()
                                                                                throws java.rmi.RemoteException
        To get the default read-only classes from the server side.
        Throws:
        java.rmi.RemoteException

      • getDescriptor

        org.eclipse.persistence.internal.sessions.remote.Transporter getDescriptor​(org.eclipse.persistence.internal.sessions.remote.Transporter domainClass)
                                                                    throws java.rmi.RemoteException
        To get descriptor from the server side
        Throws:
        java.rmi.RemoteException

      • getDescriptorForAlias

        org.eclipse.persistence.internal.sessions.remote.Transporter getDescriptorForAlias​(org.eclipse.persistence.internal.sessions.remote.Transporter alias)
                                                                            throws java.rmi.RemoteException
        To get descriptor from the server side
        Throws:
        java.rmi.RemoteException

      • getLogin

        org.eclipse.persistence.internal.sessions.remote.Transporter getLogin()
                                                               throws java.rmi.RemoteException
        To get login from the server side
        Throws:
        java.rmi.RemoteException

      • getSequenceNumberNamed

        org.eclipse.persistence.internal.sessions.remote.Transporter getSequenceNumberNamed​(org.eclipse.persistence.internal.sessions.remote.Transporter remoteFunctionCall)
                                                                             throws java.rmi.RemoteException
        INTERNAL: Get the value returned by remote function call
        Throws:
        java.rmi.RemoteException

      • initializeIdentityMapsOnServerSession

        org.eclipse.persistence.internal.sessions.remote.Transporter initializeIdentityMapsOnServerSession()
                                                                                            throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException

      • instantiateRemoteValueHolderOnServer

        org.eclipse.persistence.internal.sessions.remote.Transporter instantiateRemoteValueHolderOnServer​(org.eclipse.persistence.internal.sessions.remote.Transporter remoteValueHolder)
                                                                                           throws java.rmi.RemoteException
        To instantiate remote value holder on the server side.
        Throws:
        java.rmi.RemoteException

      • rollbackTransaction

        org.eclipse.persistence.internal.sessions.remote.Transporter rollbackTransaction()
                                                                          throws java.rmi.RemoteException
        Rollback a transaction on the database.
        Throws:
        java.rmi.RemoteException

      • scrollableCursorAbsolute

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorAbsolute​(org.eclipse.persistence.internal.sessions.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

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorAfterLast​(org.eclipse.persistence.internal.sessions.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

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorBeforeFirst​(org.eclipse.persistence.internal.sessions.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

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorClose​(org.eclipse.persistence.internal.sessions.remote.Transporter remoteScrollableCursorOid)
                                                                            throws java.rmi.RemoteException
        Used for closing scrollable cursor across RMI.
        Throws:
        java.rmi.RemoteException

      • scrollableCursorCurrentIndex

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorCurrentIndex​(org.eclipse.persistence.internal.sessions.remote.Transporter remoteScrollableCursor)
                                                                                   throws java.rmi.RemoteException
        Retrieves the current row index number
        Throws:
        java.rmi.RemoteException

      • scrollableCursorFirst

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorFirst​(org.eclipse.persistence.internal.sessions.remote.Transporter remoteScrollableCursor)
                                                                            throws java.rmi.RemoteException
        Moves the cursor to the first row in the result set
        Throws:
        java.rmi.RemoteException

      • scrollableCursorIsAfterLast

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorIsAfterLast​(org.eclipse.persistence.internal.sessions.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

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorIsBeforeFirst​(org.eclipse.persistence.internal.sessions.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

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorIsFirst​(org.eclipse.persistence.internal.sessions.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

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorIsLast​(org.eclipse.persistence.internal.sessions.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

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorLast​(org.eclipse.persistence.internal.sessions.remote.Transporter remoteScrollableCursor)
                                                                           throws java.rmi.RemoteException
        Moves the cursor to the last row in the result set
        Throws:
        java.rmi.RemoteException

      • scrollableCursorNextObject

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorNextObject​(org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorOid)
                                                                                 throws java.rmi.RemoteException
        INTERNAL: Retrieve next object from the scrollable cursor
        Throws:
        java.rmi.RemoteException

      • scrollableCursorPreviousObject

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorPreviousObject​(org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorOid)
                                                                                     throws java.rmi.RemoteException
        INTERNAL: Retrieve previous object from the scrollable cursor
        Throws:
        java.rmi.RemoteException

      • scrollableCursorRelative

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorRelative​(org.eclipse.persistence.internal.sessions.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

      • scrollableCursorSize

        org.eclipse.persistence.internal.sessions.remote.Transporter scrollableCursorSize​(org.eclipse.persistence.internal.sessions.remote.Transporter cursoredStream)
                                                                           throws java.rmi.RemoteException
        INTERNAL: Return the cursor size
        Throws:
        java.rmi.RemoteException