org.rvpf.base.rmi

Class SessionProxy

Object

SessionProxy

All Implemented Interfaces:

Remote, Session

Direct Known Subclasses:

AgentSessionProxy, RemoteEngineProxy, SOMProxy, StoreSessionProxy

@ThreadSafe
public abstract class SessionProxy
extends Object
implements Session

Session proxy.

A session proxy wraps the communication with a remote session object. This includes the creation of that object thru the appropriate session factory.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SessionProxy.Builder Builder.
static interface	SessionProxy.Listener Listener.
static class	SessionProxy.SessionConnectVetoException Connect veto exception.

Nested classes/interfaces inherited from interface Session

Session.ConnectionMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SessionProxy(String clientName, Optional<LoginInfo> loginInfo, SessionClientContext context, Optional<SessionProxy.Listener> listener, boolean autoconnect) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	connect() Connects to a session.
protected abstract Session	createSession() Creates a session.
void	disconnect() Disconnects from the session.
protected String	getClientName() Gets the clientName.
Session.ConnectionMode	getConnectionMode() Gets the connection mode.
SessionClientContext	getContext() Gets the context.
UUID	getContextUUID() Gets the context UUID.
protected Remote	getFactory() Gets the session factory.
String	getServerName() Gets the server name.
URI	getServerURI() Gets the server URI.
protected Session	getSession() Gets the session.
protected Logger	getThisLogger() Gets the logger for this instance.
boolean	hasLoginInfo() Asks if login info is available.
boolean	isConnected() Asks if the session is connected.
boolean	isPrivate() Asks if this is a private session.
boolean	isRemote() Asks if this is a remote session.
protected void	lockConnect() Locks connect.
protected void	lockConnectInterruptibly() Locks connect interruptibly.
void	login(String identifier, char[] password) Identifies and authenticates the identity associated with the Session.
void	logout() Logs out.
protected SessionException	sessionException(Exception exception) Throws a session exception.
protected String	sessionMode() Returns some session mode identifying text.
void	tearDown() Tears down what has been set up.
protected void	unlockConnect() Unlocks connect.

Methods inherited from class Object

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

Constructor Detail

SessionProxy

protected SessionProxy(@Nonnull
                       String clientName,
                       @Nonnull
                       Optional<LoginInfo> loginInfo,
                       @Nonnull
                       SessionClientContext context,
                       @Nonnull
                       Optional<SessionProxy.Listener> listener,
                       boolean autoconnect)

Constructs an instance.

Parameters:

clientName - The client name.

loginInfo - The optional login informations.

context - The session client context.

listener - The optional listener.

autoconnect - The autoconnect indicator.

Method Detail

connect

public void connect()
             throws SessionConnectFailedException

Connects to a session.

This method may be called redundantly.

Throws:

SessionConnectFailedException - When connect fails.

disconnect

public void disconnect()

Disconnects from the session.

This method may be called redundantly.

getConnectionMode

public Session.ConnectionMode getConnectionMode()

Gets the connection mode.

This method may be called before or after Session.login(java.lang.String, char[]).

Specified by:

getConnectionMode in interface Session

Returns:

The connection mode.

getContext

@Nonnull
 @CheckReturnValue
public SessionClientContext getContext()

Gets the context.

Returns:

The context.

getContextUUID

@Nonnull
 @CheckReturnValue
public UUID getContextUUID()

Gets the context UUID.

Returns:

The context UUID.

getServerName

@Nonnull
 @CheckReturnValue
public String getServerName()

Gets the server name.

Returns:

The server name.

getServerURI

@Nonnull
 @CheckReturnValue
public URI getServerURI()

Gets the server URI.

Returns:

The server URI.

hasLoginInfo

@CheckReturnValue
public final boolean hasLoginInfo()

Asks if login info is available.

Returns:

True if login info is available.

isConnected

@CheckReturnValue
public boolean isConnected()

Asks if the session is connected.

Returns:

True if connected.

isPrivate

@CheckReturnValue
public boolean isPrivate()

Asks if this is a private session.

Returns:

True if this is a private session.

isRemote

@CheckReturnValue
public boolean isRemote()

Asks if this is a remote session.

Returns:

True if this is a remote session.

login

public void login(String identifier,
                  char[] password)

Identifies and authenticates the identity associated with the Session.

Specified by:

login in interface Session

Parameters:

identifier - The identifier for the identity.

password - The password authenticating the identity.

logout

public void logout()

Logs out.

Specified by:

logout in interface Session

tearDown

public void tearDown()

Tears down what has been set up.

createSession

@Nonnull
 @CheckReturnValue
protected abstract Session createSession()
                                                                throws RemoteException,
                                                                       SessionException

Creates a session.

Returns:

The session.

Throws:

RemoteException - From RMI.

SessionException - When session creation fails.

getClientName

@Nonnull
 @CheckReturnValue
protected String getClientName()

Gets the clientName.

Returns:

The clientName.

getFactory

@Nonnull
 @CheckReturnValue
protected final Remote getFactory()
                                                         throws SessionConnectFailedException

Gets the session factory.

Returns:

The factory.

Throws:

SessionConnectFailedException - When connect fails.

getSession

@Nonnull
 @CheckReturnValue
protected final Session getSession()
                                                          throws SessionException

Gets the session.

Returns:

The session.

Throws:

SessionException - When the session can't be obtained.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger for this instance.

Returns:

The logger.

lockConnect

protected void lockConnect()

Locks connect.

lockConnectInterruptibly

protected void lockConnectInterruptibly()
                                 throws CatchedSessionException

Locks connect interruptibly.

Throws:

CatchedSessionException - When an exception is catched.

sessionException

@Nonnull
 @CheckReturnValue
protected SessionException sessionException(@Nonnull
                                                                          Exception exception)

Throws a session exception.

Parameters:

exception - A catched exception.

Returns:

A session exception.

sessionMode

@Nonnull
 @CheckReturnValue
protected String sessionMode()

Returns some session mode identifying text.

Returns:

The session mode identifying text.

unlockConnect

protected void unlockConnect()

Unlocks connect.