org.tentackle.persist.rmi

Class RemoteDbConnectionImpl

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

org.tentackle.persist.rmi.RemoteServerObject

org.tentackle.persist.rmi.RemoteDbConnectionImpl

All Implemented Interfaces:

Serializable, Remote, RemoteDbConnection

public abstract class RemoteDbConnectionImpl
extends RemoteServerObject
implements RemoteDbConnection

Server side RMI-connection implementation.

Overview of what happens in a Tentackle RMI application server:

• client gets a reference to a RemoteDbConnection in the server
• client invokes login() on the connection and gets a reference to a RemoteDbSession.
• each session runs in its own thread (server & client) and the server session gets its own Db.
• all further client requests work through the session object and the remote delegates created within the session
• the client invokes logout() to close the session and Db.
• in case the client terminates abnormally (without invoking logout()) a timeout runs logout() via finalize().

Author:

harald

See Also:

Serialized Form

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Constructor and Description
RemoteDbConnectionImpl(DbServer server, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) Creates a connection.

Method Summary

Modifier and Type	Method and Description
void	checkClientVersionInfo(Serializable clientVersionInfo) Checks the client's version information.
abstract RemoteDbSession	createSession(SessionInfo clientInfo) Creates the session. Needs to be implemented by the application.
int	exportRemoteObject(Remote remoteObject, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) Exports the given remote object.
protected void	finalize() Overridden to detect unwanted garbage collection as this should never happen.
RMIClientSocketFactory	getClientSocketFactory(Session session, SessionInfo clientInfo, SessionInfo serverInfo) Gets the client socket factory according to the userinfos.
int	getPort(Session session, SessionInfo clientInfo, SessionInfo serverInfo) Gets the tcp port for this connection.
DbServer	getServer() Gets the DbServer.
RMIServerSocketFactory	getServerSocketFactory(Session session, SessionInfo clientInfo, SessionInfo serverInfo) Gets the server socket factory.
Serializable	getServerVersionInfo() Gets the application-specific version information of the server.
int	getSessionTimeout(Session session, SessionInfo clientInfo, SessionInfo serverInfo) Gets the session timeout count.
RemoteDbSession	login(SessionInfo clientInfo) Login to remote RMI-server.
void	logout(RemoteDbSession session) Logout from remote RMI-Server.
void	unexportRemoteObject(Remote remoteObject) Exports the given remote object.

Methods inherited from class org.tentackle.persist.rmi.RemoteServerObject

getRMICsf, getRMIPort, getRMISsf

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RemoteDbConnectionImpl

public RemoteDbConnectionImpl(DbServer server,
                              int port,
                              RMIClientSocketFactory csf,
                              RMIServerSocketFactory ssf)
                       throws RemoteException

Creates a connection.

Parameters:

server - the DbServer

port - the tcp-port, 0 = system default

csf - the client socket factory, null = system default

ssf - the server socket factory, null = system default

Throws:

RemoteException

See Also:

DbServer

Method Detail

getServer

public DbServer getServer()

Gets the DbServer.

Returns:

the db server

getSessionTimeout

public int getSessionTimeout(Session session,
                             SessionInfo clientInfo,
                             SessionInfo serverInfo)

Gets the session timeout count.

Parameters:

session - the session attached to the RemoteDbSession

clientInfo - the UserInfo from the client

serverInfo - the UserInfo to establish the connection to the database server

Returns:

the timeout

getPort

public int getPort(Session session,
                   SessionInfo clientInfo,
                   SessionInfo serverInfo)

Gets the tcp port for this connection.

Parameters:

session - the session attached to the RemoteDbSession

clientInfo - the UserInfo from the client

serverInfo - the UserInfo to establish the connection to the database server

Returns:

the tcp-port for this connection, 0 = system default

getClientSocketFactory

public RMIClientSocketFactory getClientSocketFactory(Session session,
                                                     SessionInfo clientInfo,
                                                     SessionInfo serverInfo)

Gets the client socket factory according to the userinfos.

Parameters:

session - the session attached to the RemoteDbSession

clientInfo - the UserInfo from the client

serverInfo - the UserInfo to establish the connection to the database server

Returns:

the client socket factory for this connection, null = system default

getServerSocketFactory

public RMIServerSocketFactory getServerSocketFactory(Session session,
                                                     SessionInfo clientInfo,
                                                     SessionInfo serverInfo)

Gets the server socket factory.

Parameters:

session - the session attached to the RemoteDbSession

clientInfo - the UserInfo from the client

serverInfo - the UserInfo to establish the connection to the database server

Returns:

the server socket factory for this connection, null = system default

checkClientVersionInfo

public void checkClientVersionInfo(Serializable clientVersionInfo)
                            throws VersionInfoIncompatibleException

Checks the client's version information.

The default implementation does nothing. It is invoked from Db.open() for remote connections.

Parameters:

clientVersionInfo - the server's version info from RemoteDbConnection.

Throws:

VersionInfoIncompatibleException - if versions are not compatible

createSession

public abstract RemoteDbSession createSession(SessionInfo clientInfo)
                                       throws RemoteException

Creates the session.
Needs to be implemented by the application.

Parameters:

clientInfo - the client info (login info)

Returns:

the created session

Throws:

RemoteException - if creation failed

exportRemoteObject

public int exportRemoteObject(Remote remoteObject,
                              int port,
                              RMIClientSocketFactory csf,
                              RMIServerSocketFactory ssf)
                       throws RemoteException

Exports the given remote object.

Notice that the delegate must not extend UnicastRemoteObject!

Parameters:

remoteObject - the object to export

port - the port to export the object on, 0 if auto

csf - the client-side socket factory for making calls to the remote object, null if system default

ssf - the server-side socket factory for receiving remote calls, null if system default

Returns:

the effective port, 0 if system default

Throws:

RemoteException - if export failed

unexportRemoteObject

public void unexportRemoteObject(Remote remoteObject)
                          throws RemoteException

Exports the given remote object.

Parameters:

remoteObject - the object to unexport

Throws:

RemoteException

finalize

protected void finalize()
                 throws Throwable

Overridden to detect unwanted garbage collection as this should never happen. If using DbServer, this will not happen because it keeps a reference to the connection object.

Overrides:

finalize in class Object

Throws:

Throwable

getServerVersionInfo

public Serializable getServerVersionInfo()
                                  throws RemoteException

Description copied from interface: RemoteDbConnection

Gets the application-specific version information of the server.

Specified by:

getServerVersionInfo in interface RemoteDbConnection

Returns:

the version info

Throws:

RemoteException

login

public RemoteDbSession login(SessionInfo clientInfo)
                      throws RemoteException

Description copied from interface: RemoteDbConnection

Login to remote RMI-server.

Specified by:

login in interface RemoteDbConnection

Parameters:

clientInfo - the user information

Returns:

the session

Throws:

RemoteException - if some error, for example wrong passord

logout

public void logout(RemoteDbSession session)
            throws RemoteException

Description copied from interface: RemoteDbConnection

Logout from remote RMI-Server.

Specified by:

logout in interface RemoteDbConnection

Parameters:

session - to be closed

Throws:

RemoteException - if some error