org.rvpf.base.som

Class SOMProxy

Object

SessionProxy

SOMProxy

All Implemented Interfaces:

Remote, Session, SOMSession

Direct Known Subclasses:

QueueProxy, TopicProxy

@ThreadSafe
public abstract class SOMProxy
extends SessionProxy
implements SOMSession

SOM proxy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SOMProxy.Builder Builder.
static class	SOMProxy.ContextProperties Context properties.

Nested classes/interfaces inherited from class SessionProxy

SessionProxy.Listener, SessionProxy.SessionConnectVetoException

Nested classes/interfaces inherited from interface Session

Session.ConnectionMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	PASSWORD_PROPERTY The user password.
static String	TIMEOUT_PROPERTY The timeout property.
static String	USER_PROPERTY The user identification.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the session.
protected void	confirmTimeout() Confirms the timeout to the context.
void	connect() Connects to a session.
void	disconnect() Disconnects from the session.
String	getSOMName() Gets the SOM name.
boolean	isClosed() Asks if this is closed.

Methods inherited from class SessionProxy

createSession, getClientName, getConnectionMode, getContext, getContextUUID, getFactory, getServerName, getServerURI, getSession, getThisLogger, hasLoginInfo, isConnected, isPrivate, isRemote, lockConnect, lockConnectInterruptibly, login, logout, sessionException, sessionMode, tearDown, unlockConnect

Methods inherited from class Object

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

Methods inherited from interface Session

getConnectionMode, login, logout

Field Detail

PASSWORD_PROPERTY

public static final String PASSWORD_PROPERTY

The user password.

See Also:

Constant Field Values

TIMEOUT_PROPERTY

public static final String TIMEOUT_PROPERTY

The timeout property.

See Also:

Constant Field Values

USER_PROPERTY

public static final String USER_PROPERTY

The user identification.

See Also:

Constant Field Values

Method Detail

close

public void close()
           throws SessionException

Closes the session.

Specified by:

close in interface SOMSession

Throws:

SessionException - When the session logout fails.

connect

public void connect()
             throws SessionConnectFailedException

Connects to a session.

This method may be called redundantly.

Overrides:

connect in class SessionProxy

Throws:

SessionConnectFailedException - When connect fails.

disconnect

public final void disconnect()

Disconnects from the session.

This method may be called redundantly.

Overrides:

disconnect in class SessionProxy

getSOMName

@Nonnull
 @CheckReturnValue
public final String getSOMName()

Gets the SOM name.

Returns:

The SOM name.

isClosed

@CheckReturnValue
public final boolean isClosed()

Asks if this is closed.

Returns:

True if closed.

confirmTimeout

protected void confirmTimeout()
                       throws RemoteException,
                              SessionConnectFailedException

Confirms the timeout to the context.

Throws:

RemoteException - From RMI.

SessionConnectFailedException - When connect fails.