org.tentackle.persist.rmi

Class RemoteDbSessionImpl

java.lang.Object

org.tentackle.persist.rmi.RemoteDbSessionImpl

All Implemented Interfaces:

Remote, Exportable, RemoteDbSession

public abstract class RemoteDbSessionImpl
extends Object
implements RemoteDbSession, Exportable

User session within the application server.

Author:

harald

Constructor Summary

Constructors

Constructor and Description
RemoteDbSessionImpl(RemoteDbConnectionImpl con, SessionInfo clientInfo, SessionInfo serverInfo) Creates a session on a given connection.

Method Summary

Modifier and Type	Method and Description
protected void	cleanup(boolean crashed) Cleanup the session.
void	close() Closes a session.
protected void	closeDb(boolean cleanup) Closes the database connection (and thus rolls back any pending transaction).
void	countMethodInvocation(Method method, Class<?> servicedClass, Duration duration) Counts the invocation of a delegate method.
<T extends org.tentackle.persist.rmi.RemoteDelegate,I extends org.tentackle.persist.rmi.RemoteDelegateImpl<?>> T	createRemoteDelegate(Class<T> delegateClass, Class<I> delegateImplClass, Class<?> clazz, Class<?> effectiveClass, Object... configArgs) Creates a remote delegate for the given class. Same as createRemoteDelegateInstance(java.lang.Class<T>, java.lang.Class<I>, java.lang.Class<?>, java.lang.Class<?>, java.lang.Object...) but with dynamic proxy to allow intercepting.
String	createRemoteDelegateClassName(String className) Creates the classname of the remote delegate interface from the serviced classname. The default implementation returns: packagename + ".rmi." + classbasename + "RemoteDelegate"
String	createRemoteDelegateImplClassName(String className) Creates the classname of the remote delegate implementation from the serviced classname. The default implementation returns + "Impl".
<T extends org.tentackle.persist.rmi.RemoteDelegate,I extends org.tentackle.persist.rmi.RemoteDelegateImpl<?>> T	createRemoteDelegateInstance(Class<T> delegateClass, Class<I> delegateImplClass, Class<?> clazz, Class<?> effectiveClass, Object... configArgs) Creates a remote delegate for the given class.
protected void	doLogStatistics(Logger.Level level, boolean clear) Logs the statistics.
void	exportMe() Exports this remote object.
void	exportRemoteDelegate(org.tentackle.persist.rmi.RemoteDelegate delegate) Exports the given delegate.
protected void	finalize() Cleanup in case someone forgot to logoff().
protected void	forceCleanup() Forces a cleanup if all cleanup and closing failed.
String	getClientHostString() Gets the string representation of the client host connected to this session.
SessionInfo	getClientSessionInfo() Gets the client user info.
RMIClientSocketFactory	getClientSocketFactory() Gets the default client socket factory for all delegates.
long	getClosedSince() Gets the epochal time when the session was closed.
RemoteDbConnectionImpl	getConnection() Gets the server connection.
org.tentackle.persist.rmi.DbRemoteDelegate	getDbRemoteDelegate() Gets the delegate for the remote db-connection.
static Collection<RemoteDbSessionImpl>	getOpenSessions() Returns a list of all open sessions.
String	getOptions() Returns an application-specific option string. For diagnostic purposes only.
int	getPort() Gets the port for all delegates.
<T extends org.tentackle.persist.rmi.RemoteDelegate> T	getRemoteDelegate(String classname) Gets the delegate for a given classname. Per class the rmi-clients request a remote access there must be a RemoteDelegate.
String	getServerName() Gets the application name of the server.
SessionInfo	getServerSessionInfo() Gets the server user info.
RMIServerSocketFactory	getServerSocketFactory() Gets the default server socket factory for all delegates.
Db	getSession() Gets the session db connection
long	getSessionNumber() Gets the unique session number.
int	getTimeout() Gets the session timeout.
boolean	hasTimedOut() Checks for timeout.
boolean	isGrouped() Returns whether this is grouped session. By default, user sessions are grouped, i.e.
boolean	isOpen() Determines whether the session is open.
static SessionInfo	isUserLoggedIn(SessionInfo userInfo) Checks if the user is already logged in.
void	log(Logger.Level level, String message) Sends text based logging infos to the RMI-Server.
void	logStatistics(Logger.Level level, boolean clear) Logs the statistics.
protected Db	openDb() Opens a new Db. The default implementation opens a new Db.
void	polled() Sets this session as being polled for timeout.
void	setClientSocketFactory(RMIClientSocketFactory csf) Sets the client socket factory for all delegates.
void	setPort(int port) Sets Gets the port for all delegates.
void	setServerSocketFactory(RMIServerSocketFactory ssf) Sets the server socket factory for all delegates.
void	setTimeout(int timeout) Sets the session timeout.
static void	startCleanupThread(long checkInterval) Starts the optional cleanup thread that will monitor the sessions for db-activity.
static void	stopCleanupThread() Stops the cleanup thread.
String	toString()
void	unexportMe() Unexports this remote object.
void	unexportRemoteDelegate(org.tentackle.persist.rmi.RemoteDelegate delegate) Unexports given remote delegate.
abstract void	verifySessionInfo(SessionInfo sessionInfo) Verifies and updates the client's session info. Needs to be implemented by the application. Checks login credentials and sets the user id.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteDbSessionImpl

public RemoteDbSessionImpl(RemoteDbConnectionImpl con,
                           SessionInfo clientInfo,
                           SessionInfo serverInfo)
                    throws RemoteException

Creates a session on a given connection.

Parameters:

con - the connection

clientInfo - the SessionInfo from the client

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

Throws:

RemoteException - if the session could not initiated.

Method Detail

startCleanupThread

public static void startCleanupThread(long checkInterval)

Starts the optional cleanup thread that will monitor the sessions for db-activity.

Parameters:

checkInterval - is the interval in ms

stopCleanupThread

public static void stopCleanupThread()

Stops the cleanup thread.

getOpenSessions

public static Collection<RemoteDbSessionImpl> getOpenSessions()

Returns a list of all open sessions.

Returns:

the sessions, never null

isUserLoggedIn

public static SessionInfo isUserLoggedIn(SessionInfo userInfo)

Checks if the user is already logged in.

Parameters:

userInfo - the user's info

Returns:

the userinfo if already logged in, null if not logged in

exportMe

public void exportMe()
              throws RemoteException

Description copied from interface: Exportable

Exports this remote object.

Specified by:

exportMe in interface Exportable

Throws:

RemoteException - if export failed

unexportMe

public void unexportMe()
                throws RemoteException

Description copied from interface: Exportable

Unexports this remote object.

Specified by:

unexportMe in interface Exportable

Throws:

RemoteException - if unexport failed

exportRemoteDelegate

public void exportRemoteDelegate(org.tentackle.persist.rmi.RemoteDelegate delegate)
                          throws RemoteException

Exports the given delegate.

Notice that the delegate must not extend UnicastRemoteObject!

Parameters:

delegate - the delegate

Throws:

RemoteException - if export failed

unexportRemoteDelegate

public void unexportRemoteDelegate(org.tentackle.persist.rmi.RemoteDelegate delegate)
                            throws RemoteException

Unexports given remote delegate.

Notice: when the session is closed, all still exported objects will be unexported. This method is only necessary if a delegate must be explicitly unexported.

Parameters:

delegate - the delegate

Throws:

RemoteException - if object not exported

verifySessionInfo

public abstract void verifySessionInfo(SessionInfo sessionInfo)
                                throws LoginFailedException

Verifies and updates the client's session info.
Needs to be implemented by the application.
Checks login credentials and sets the user id.

Parameters:

sessionInfo - the session info

Throws:

LoginFailedException - if login is not allowed for whatever reason

getSessionNumber

public long getSessionNumber()

Gets the unique session number.

Returns:

the number of this session

getTimeout

public int getTimeout()

Gets the session timeout.

Returns:

the timeout in timeout intervals

setTimeout

public void setTimeout(int timeout)

Sets the session timeout.

Parameters:

timeout - the timeout in timeout intervals

getSession

public Db getSession()

Gets the session db connection

Returns:

the db connection

getConnection

public RemoteDbConnectionImpl getConnection()

Gets the server connection.

Returns:

the connection

getClientSessionInfo

public SessionInfo getClientSessionInfo()

Gets the client user info.

Specified by:

getClientSessionInfo in interface RemoteDbSession

Returns:

the client user info

getServerSessionInfo

public SessionInfo getServerSessionInfo()

Gets the server user info.

Returns:

the server user info

getClosedSince

public long getClosedSince()

Gets the epochal time when the session was closed.

Returns:

the time when closed, 0 if still open

getPort

public int getPort()

Gets the port for all delegates.

Returns:

the port for all delegates

setPort

public void setPort(int port)

Sets Gets the port for all delegates.

Parameters:

port - the port

getClientSocketFactory

public RMIClientSocketFactory getClientSocketFactory()

Gets the default client socket factory for all delegates.

Returns:

the default csf for all delegates

setClientSocketFactory

public void setClientSocketFactory(RMIClientSocketFactory csf)

Sets the client socket factory for all delegates.

Parameters:

csf - the socket factory

getServerSocketFactory

public RMIServerSocketFactory getServerSocketFactory()

Gets the default server socket factory for all delegates.

Returns:

the default ssf for all delegates

setServerSocketFactory

public void setServerSocketFactory(RMIServerSocketFactory ssf)

Sets the server socket factory for all delegates.

Parameters:

ssf - the socket factory

countMethodInvocation

public void countMethodInvocation(Method method,
                                  Class<?> servicedClass,
                                  Duration duration)

Counts the invocation of a delegate method.

Parameters:

method - the method invoked

servicedClass - the serviced class

duration - execution duration

openDb

protected Db openDb()
             throws LoginFailedException

Opens a new Db.
The default implementation opens a new Db. Can be overridden if, for example, pools are used instead.

Returns:

the db connection

Throws:

LoginFailedException - if opening the db failed

cleanup

protected void cleanup(boolean crashed)

Cleanup the session.

The method is invoked whenever the session is closed due to an ordinary logout or client crash. The default implementation rolls back any pending transaction.

Parameters:

crashed - true if client crashed, else regular logout

doLogStatistics

protected void doLogStatistics(Logger.Level level,
                               boolean clear)

Logs the statistics.

Parameters:

level - the logging level

clear - true if clear statistics after dump

closeDb

protected void closeDb(boolean cleanup)

Closes the database connection (and thus rolls back any pending transaction). If the db is pooled, it will be returned to the pool instead of being closed.

Parameters:

cleanup - true if db must be physically closed even if pooled, due to cleanup

forceCleanup

protected void forceCleanup()

Forces a cleanup if all cleanup and closing failed.

Simply marks the session closed and moves all references to GC.

getClientHostString

public String getClientHostString()

Gets the string representation of the client host connected to this session.

Returns:

the client host string

getOptions

public String getOptions()

Returns an application-specific option string.
For diagnostic purposes only.

Returns:

null if no options

toString

public String toString()

Overrides:

toString in class Object

isOpen

public boolean isOpen()

Determines whether the session is open.

Returns:

true if session is open

isGrouped

public boolean isGrouped()

Returns whether this is grouped session.
By default, user sessions are grouped, i.e. one for the modification thread and one for the AWT/FX thread.

Returns:

true if user session

finalize

protected void finalize()
                 throws Throwable

Cleanup in case someone forgot to logoff().

Overrides:

finalize in class Object

Throws:

Throwable

getServerName

public String getServerName()
                     throws RemoteException

Description copied from interface: RemoteDbSession

Gets the application name of the server.

Specified by:

getServerName in interface RemoteDbSession

Returns:

the application name

Throws:

RemoteException

close

public void close()
           throws RemoteException

Description copied from interface: RemoteDbSession

Closes a session.

Specified by:

close in interface RemoteDbSession

Throws:

RemoteException

log

public void log(Logger.Level level,
                String message)
         throws RemoteException

Description copied from interface: RemoteDbSession

Sends text based logging infos to the RMI-Server.

Specified by:

log in interface RemoteDbSession

Parameters:

level - the logging level

message - the message

Throws:

RemoteException

logStatistics

public void logStatistics(Logger.Level level,
                          boolean clear)
                   throws RemoteException

Description copied from interface: RemoteDbSession

Logs the statistics.

Specified by:

logStatistics in interface RemoteDbSession

Parameters:

level - the logging level

clear - true if clear statistics after dump

Throws:

RemoteException - if logging failed

See Also:

RemoteDelegateInvocationHandler.collectStatistics

getRemoteDelegate

public <T extends org.tentackle.persist.rmi.RemoteDelegate> T getRemoteDelegate(String classname)
                                                                         throws RemoteException

Description copied from interface: RemoteDbSession

Gets the delegate for a given classname.
Per class the rmi-clients request a remote access there must be a RemoteDelegate. The delegate is determined from the classname of the client class as follows:
<package>.rmi.<last-element-of-classname>.class on the client-side and
<package>.rmi.<last-element-of-classname>Impl.class on the server-side.
The delegates are cached on the client side in order to speed up access. Delegates are bound to a session, i.e. there will be one delegate for each session and class.

Specified by:

getRemoteDelegate in interface RemoteDbSession

Parameters:

classname - is the name of class

Returns:

the delegate

Throws:

RemoteException

getDbRemoteDelegate

public org.tentackle.persist.rmi.DbRemoteDelegate getDbRemoteDelegate()
                                                               throws RemoteException

Description copied from interface: RemoteDbSession

Gets the delegate for the remote db-connection.

Specified by:

getDbRemoteDelegate in interface RemoteDbSession

Returns:

the delegate

Throws:

RemoteException

createRemoteDelegateClassName

public String createRemoteDelegateClassName(String className)

Creates the classname of the remote delegate interface from the serviced classname.
The default implementation returns: packagename + ".rmi." + classbasename + "RemoteDelegate"

Parameters:

className - the name of the class to look for a delegate

Returns:

the classname of the remote delegate for given class

createRemoteDelegateImplClassName

public String createRemoteDelegateImplClassName(String className)

Creates the classname of the remote delegate implementation from the serviced classname.
The default implementation returns + "Impl".

Parameters:

className - the name of the class to look for a delegate

Returns:

the classname of the remote delegate for given class

createRemoteDelegateInstance

public <T extends org.tentackle.persist.rmi.RemoteDelegate,I extends org.tentackle.persist.rmi.RemoteDelegateImpl<?>> T createRemoteDelegateInstance(Class<T> delegateClass,
                                                                                                                                                     Class<I> delegateImplClass,
                                                                                                                                                     Class<?> clazz,
                                                                                                                                                     Class<?> effectiveClass,
                                                                                                                                                     Object... configArgs)
                                                                                                                                              throws InstantiationException,
                                                                                                                                                     NoSuchMethodException,
                                                                                                                                                     IllegalAccessException,
                                                                                                                                                     IllegalArgumentException,
                                                                                                                                                     InvocationTargetException

Creates a remote delegate for the given class.

If the optional configuration arguments are given, the delegate must provide a method with the following signature:

  public void configureDelegate(Object... args) {
    // whatever args stands for
  }
 

The optional configuration parameters allow passing additional objects to the delegate without having to declare the setters in the remote interface.

Type Parameters:

T - the delegate class

I - the delegate implementation class

Parameters:

delegateClass - the interface class

delegateImplClass - the implementing class

clazz - the serviced class

effectiveClass - the optional effective serviced class, null if clazz

configArgs - optional arguments to configure the delegate

Returns:

the created

Throws:

InstantiationException

NoSuchMethodException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

createRemoteDelegate

public <T extends org.tentackle.persist.rmi.RemoteDelegate,I extends org.tentackle.persist.rmi.RemoteDelegateImpl<?>> T createRemoteDelegate(Class<T> delegateClass,
                                                                                                                                             Class<I> delegateImplClass,
                                                                                                                                             Class<?> clazz,
                                                                                                                                             Class<?> effectiveClass,
                                                                                                                                             Object... configArgs)
                                                                                                                                      throws InstantiationException,
                                                                                                                                             NoSuchMethodException,
                                                                                                                                             IllegalAccessException,
                                                                                                                                             IllegalArgumentException,
                                                                                                                                             InvocationTargetException

Creates a remote delegate for the given class.
Same as createRemoteDelegateInstance(java.lang.Class<T>, java.lang.Class<I>, java.lang.Class<?>, java.lang.Class<?>, java.lang.Object...) but with dynamic proxy to allow intercepting.

Type Parameters:

T - the remote delegate class

I - the delegate implementation class

Parameters:

delegateClass - the interface class

delegateImplClass - the implementing class

clazz - the serviced class

effectiveClass - the effectively serviced class, null if clazz

configArgs - optional configuration arguments passed to createRemoteDelegateInstance(java.lang.Class<T>, java.lang.Class<I>, java.lang.Class<?>, java.lang.Class<?>, java.lang.Object...)

Returns:

the created

Throws:

InstantiationException

NoSuchMethodException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

hasTimedOut

public boolean hasTimedOut()

Checks for timeout. Will internally increment a counter until timeout has reached.

Returns:

true if timed out

polled

public void polled()

Sets this session as being polled for timeout.