Module org.eclipse.persistence.core

Package org.eclipse.persistence.sessions.remote.rmi

Class RMIConnection

java.lang.Object

org.eclipse.persistence.internal.sessions.remote.RemoteConnection

org.eclipse.persistence.sessions.remote.rmi.RMIConnection

All Implemented Interfaces:

Serializable

public class RMIConnection
extends RemoteConnection

This class exists on on the client side which talks to remote session controller through RMI connection.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.eclipse.persistence.internal.sessions.remote.RemoteConnection

serviceName, session

Constructor Summary

Constructors

Constructor	Description
RMIConnection(RMIRemoteSessionController controller)	PUBLIC: The connection must be create from the server-side session controllers stub.

Method Summary

Modifier and Type	Method	Description
void	beginEarlyTransaction()	INTERNAL: Begin an early unit of work transaction.
void	beginTransaction()	INTERNAL: Begin a transaction on the database.
RemoteUnitOfWork	commitRootUnitOfWork(RemoteUnitOfWork theRemoteUnitOfWork)	INTERNAL: Commit root unit of work from the client side to the server side.
void	commitTransaction()	INTERNAL: Commit a transaction on the database.
Session	createRemoteSession()	PUBLIC: Returns a remote session.
void	cursoredStreamClose(ObjID remoteCursoredStreamOid)	Used for closing cursored streams across RMI.
Vector	cursoredStreamNextPage(RemoteCursoredStream remoteCursoredStream, ReadQuery query, DistributedSession session, int pageSize)	Retrieve next page size of objects from the remote cursored stream
int	cursoredStreamSize(ObjID remoteCursoredStreamID)	Return the cursored stream size
RemoteCursoredStream	cursorSelectObjects(CursoredStreamPolicy policy, DistributedSession session)	INTERNAL: Returns remote cursor stream
RemoteScrollableCursor	cursorSelectObjects(ScrollableCursorPolicy policy, DistributedSession session)	INTERNAL: Returns remote cursor stream
Vector	getDefaultReadOnlyClasses()	INTERNAL Return the read-only classes
ClassDescriptor	getDescriptor(Class<?> domainClass)	INTERNAL: Return the table descriptor specified for the class.
ClassDescriptor	getDescriptorForAlias(String alias)	INTERNAL: Return the table descriptor specified for the alias.
Login	getLogin()	INTERNAL: Return the table descriptor specified for the class.
RMIRemoteSessionController	getRemoteSessionController()	INTERNAL: Return the remote session controller
Object	getSequenceNumberNamed(Object remoteFunctionCall)	INTERNAL: Perform remote function call
void	initializeIdentityMapsOnServerSession()	INTERNAL: Reset the cache on the server-side session.
Transporter	instantiateRemoteValueHolderOnServer(RemoteValueHolder remoteValueHolder)	INTERNAL: Instantiate remote value holder on the server
void	processCommand(RemoteCommand command)	ADVANCED: This method will send the command to the remote session for processing
Transporter	remoteExecute(DatabaseQuery query)	INTERNAL: Execute the query on the server.
Transporter	remoteExecuteNamedQuery(String name, Class<?> javaClass, Vector arguments)	INTERNAL: Execute query remotely.
void	rollbackTransaction()	INTERNAL: Rollback a transaction on the database.
boolean	scrollableCursorAbsolute(ObjID remoteScrollableCursorOid, int rows)	Moves the cursor to the given row number in the result set
void	scrollableCursorAfterLast(ObjID remoteScrollableCursorOid)	Moves the cursor to the end of the result set, just after the last row.
void	scrollableCursorBeforeFirst(ObjID remoteScrollableCursorOid)	Moves the cursor to the front of the result set, just before the first row
void	scrollableCursorClose(ObjID remoteScrollableCursorOid)	Used for closing scrollable cursor across RMI.
int	scrollableCursorCurrentIndex(ObjID remoteScrollableCursorOid)	Retrieves the current row index number
boolean	scrollableCursorFirst(ObjID remoteScrollableCursorOid)	Moves the cursor to the first row in the result set
boolean	scrollableCursorIsAfterLast(ObjID remoteScrollableCursorOid)	Indicates whether the cursor is after the last row in the result set.
boolean	scrollableCursorIsBeforeFirst(ObjID remoteScrollableCursorOid)	Indicates whether the cursor is before the first row in the result set.
boolean	scrollableCursorIsFirst(ObjID remoteScrollableCursorOid)	Indicates whether the cursor is on the first row of the result set.
boolean	scrollableCursorIsLast(ObjID remoteScrollableCursorOid)	Indicates whether the cursor is on the last row of the result set.
boolean	scrollableCursorLast(ObjID remoteScrollableCursorOid)	Moves the cursor to the last row in the result set
Object	scrollableCursorNextObject(ObjID remoteScrollableCursorOid, ReadQuery query, DistributedSession session)	Retrieve next object from the remote scrollable cursor
Object	scrollableCursorPreviousObject(ObjID remoteScrollableCursorOid, ReadQuery query, DistributedSession session)	Retrieve previous object from the remote scrollable cursor
boolean	scrollableCursorRelative(ObjID remoteScrollableCursorOid, int rows)	Moves the cursor to the given row number in the result set
int	scrollableCursorSize(ObjID cursorId)	Return the scrollable cursor size
void	setRemoteSessionController(RMIRemoteSessionController remoteSessionController)	INTERNAL: Set remote session controller

Methods inherited from class org.eclipse.persistence.internal.sessions.remote.RemoteConnection

fixObjectReferences, getServiceName, getSession, initialize, isConnected, release, setServiceName, setSession

Methods inherited from class java.lang.Object

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

Constructor Details

RMIConnection

public RMIConnection(RMIRemoteSessionController controller)

PUBLIC: The connection must be create from the server-side session controllers stub. The session in then created from the connection through createRemoteSession().

See Also:

• createRemoteSession()

Method Details

processCommand

public void processCommand(RemoteCommand command)

ADVANCED: This method will send the command to the remote session for processing

Specified by:

processCommand in class RemoteConnection

Parameters:

command - Contains a command that will be executed on the remote session

See Also:

• RemoteCommand

beginTransaction

public void beginTransaction()

INTERNAL: Begin a transaction on the database.

Specified by:

beginTransaction in class RemoteConnection

beginEarlyTransaction

public void beginEarlyTransaction()

INTERNAL: Begin an early unit of work transaction.

Specified by:

beginEarlyTransaction in class RemoteConnection

commitRootUnitOfWork

public RemoteUnitOfWork commitRootUnitOfWork(RemoteUnitOfWork theRemoteUnitOfWork)

INTERNAL: Commit root unit of work from the client side to the server side.

Specified by:

commitRootUnitOfWork in class RemoteConnection

commitTransaction

public void commitTransaction()

INTERNAL: Commit a transaction on the database.

Specified by:

commitTransaction in class RemoteConnection

createRemoteSession

public Session createRemoteSession()

PUBLIC: Returns a remote session.

Specified by:

createRemoteSession in class RemoteConnection

cursoredStreamClose

public void cursoredStreamClose(ObjID remoteCursoredStreamOid)

Used for closing cursored streams across RMI.

Specified by:

cursoredStreamClose in class RemoteConnection

cursoredStreamNextPage

public Vector cursoredStreamNextPage(RemoteCursoredStream remoteCursoredStream,
 ReadQuery query,
 DistributedSession session,
 int pageSize)

Retrieve next page size of objects from the remote cursored stream

Specified by:

cursoredStreamNextPage in class RemoteConnection

cursoredStreamSize

public int cursoredStreamSize(ObjID remoteCursoredStreamID)

Return the cursored stream size

Specified by:

cursoredStreamSize in class RemoteConnection

cursorSelectObjects

public RemoteCursoredStream cursorSelectObjects(CursoredStreamPolicy policy,
 DistributedSession session)

INTERNAL: Returns remote cursor stream

Specified by:

cursorSelectObjects in class RemoteConnection

cursorSelectObjects

public RemoteScrollableCursor cursorSelectObjects(ScrollableCursorPolicy policy,
 DistributedSession session)

INTERNAL: Returns remote cursor stream

Specified by:

cursorSelectObjects in class RemoteConnection

getDefaultReadOnlyClasses

public Vector getDefaultReadOnlyClasses()

INTERNAL Return the read-only classes

Specified by:

getDefaultReadOnlyClasses in class RemoteConnection

getDescriptor

public ClassDescriptor getDescriptor(Class<?> domainClass)

INTERNAL: Return the table descriptor specified for the class.

Specified by:

getDescriptor in class RemoteConnection

getDescriptorForAlias

public ClassDescriptor getDescriptorForAlias(String alias)

INTERNAL: Return the table descriptor specified for the alias.

Specified by:

getDescriptorForAlias in class RemoteConnection

getLogin

public Login getLogin()

INTERNAL: Return the table descriptor specified for the class.

Specified by:

getLogin in class RemoteConnection

getRemoteSessionController

public RMIRemoteSessionController getRemoteSessionController()

INTERNAL: Return the remote session controller

getSequenceNumberNamed

public Object getSequenceNumberNamed(Object remoteFunctionCall)

INTERNAL: Perform remote function call

Specified by:

getSequenceNumberNamed in class RemoteConnection

initializeIdentityMapsOnServerSession

public void initializeIdentityMapsOnServerSession()

INTERNAL: Reset the cache on the server-side session.

Specified by:

initializeIdentityMapsOnServerSession in class RemoteConnection

instantiateRemoteValueHolderOnServer

public Transporter instantiateRemoteValueHolderOnServer(RemoteValueHolder remoteValueHolder)

INTERNAL: Instantiate remote value holder on the server

Specified by:

instantiateRemoteValueHolderOnServer in class RemoteConnection

remoteExecute

public Transporter remoteExecute(DatabaseQuery query)

INTERNAL: Execute the query on the server.

Specified by:

remoteExecute in class RemoteConnection

remoteExecuteNamedQuery

public Transporter remoteExecuteNamedQuery(String name,
 Class<?> javaClass,
 Vector arguments)

INTERNAL: Execute query remotely.

Specified by:

remoteExecuteNamedQuery in class RemoteConnection

rollbackTransaction

public void rollbackTransaction()

INTERNAL: Rollback a transaction on the database.

Specified by:

rollbackTransaction in class RemoteConnection

scrollableCursorAbsolute

public boolean scrollableCursorAbsolute(ObjID remoteScrollableCursorOid,
 int rows)

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

Specified by:

scrollableCursorAbsolute in class RemoteConnection

scrollableCursorAfterLast

public void scrollableCursorAfterLast(ObjID remoteScrollableCursorOid)

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

Specified by:

scrollableCursorAfterLast in class RemoteConnection

scrollableCursorBeforeFirst

public void scrollableCursorBeforeFirst(ObjID remoteScrollableCursorOid)

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

Specified by:

scrollableCursorBeforeFirst in class RemoteConnection

scrollableCursorClose

public void scrollableCursorClose(ObjID remoteScrollableCursorOid)

Used for closing scrollable cursor across RMI.

Specified by:

scrollableCursorClose in class RemoteConnection

scrollableCursorCurrentIndex

public int scrollableCursorCurrentIndex(ObjID remoteScrollableCursorOid)

Retrieves the current row index number

Specified by:

scrollableCursorCurrentIndex in class RemoteConnection

scrollableCursorFirst

public boolean scrollableCursorFirst(ObjID remoteScrollableCursorOid)

Moves the cursor to the first row in the result set

Specified by:

scrollableCursorFirst in class RemoteConnection

scrollableCursorIsAfterLast

public boolean scrollableCursorIsAfterLast(ObjID remoteScrollableCursorOid)

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

Specified by:

scrollableCursorIsAfterLast in class RemoteConnection

scrollableCursorIsBeforeFirst

public boolean scrollableCursorIsBeforeFirst(ObjID remoteScrollableCursorOid)

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

Specified by:

scrollableCursorIsBeforeFirst in class RemoteConnection

scrollableCursorIsFirst

public boolean scrollableCursorIsFirst(ObjID remoteScrollableCursorOid)

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

Specified by:

scrollableCursorIsFirst in class RemoteConnection

scrollableCursorIsLast

public boolean scrollableCursorIsLast(ObjID remoteScrollableCursorOid)

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

Specified by:

scrollableCursorIsLast in class RemoteConnection

scrollableCursorLast

public boolean scrollableCursorLast(ObjID remoteScrollableCursorOid)

Moves the cursor to the last row in the result set

Specified by:

scrollableCursorLast in class RemoteConnection

scrollableCursorNextObject

public Object scrollableCursorNextObject(ObjID remoteScrollableCursorOid,
 ReadQuery query,
 DistributedSession session)

Retrieve next object from the remote scrollable cursor

Specified by:

scrollableCursorNextObject in class RemoteConnection

scrollableCursorPreviousObject

public Object scrollableCursorPreviousObject(ObjID remoteScrollableCursorOid,
 ReadQuery query,
 DistributedSession session)

Retrieve previous object from the remote scrollable cursor

Specified by:

scrollableCursorPreviousObject in class RemoteConnection

scrollableCursorRelative

public boolean scrollableCursorRelative(ObjID remoteScrollableCursorOid,
 int rows)

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

Specified by:

scrollableCursorRelative in class RemoteConnection

scrollableCursorSize

public int scrollableCursorSize(ObjID cursorId)

Return the scrollable cursor size

Specified by:

scrollableCursorSize in class RemoteConnection

setRemoteSessionController

public void setRemoteSessionController(RMIRemoteSessionController remoteSessionController)

INTERNAL: Set remote session controller