org.rvpf.base.rmi

Class SessionClientContext

Object

SessionClientContext

@ThreadSafe
public final class SessionClientContext
extends Object

Session client context.

Holds a client context by keeping a reference to a server URI and by generating an identifying UUID.

The generated UUID is used to establish a relation between RMI server sessions and the client's context for socket creation. This is needed because the framework allows configurations where mutiple services are running within the same process, each with its own client / server properties.

Constructor Summary

Constructors

Constructor and Description
SessionClientContext(RegistryEntry registryEntry, Logger logger) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
ClientSecurityContext	getSecurityContext() Gets the security context.
String	getServerName() Gets the server name.
URI	getServerURI() Gets the server URI.
int	getTimeout() Gets the timeout.
UUID	getUUID() Gets the identifying UUID.
boolean	isPrivate() Asks if this context is private.
boolean	isRemote() Asks if the server is remote.
Remote	lookup(String sessionMode) Performs a lookup of the registry entry.
boolean	register() Registers itself.
void	setTimeout(int timeout) Sets the timeout.
boolean	unregister() Unregisters itself.

Methods inherited from class Object

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

Constructor Detail

SessionClientContext

public SessionClientContext(@Nonnull
                            RegistryEntry registryEntry,
                            @Nonnull
                            Logger logger)

Constructs an instance.

Parameters:

registryEntry - The registry entry.

logger - The logger instance to use.

Method Detail

getSecurityContext

@Nonnull
 @CheckReturnValue
public ClientSecurityContext getSecurityContext()

Gets the security context.

Returns:

The security context.

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.

getTimeout

@Nonnegative
 @CheckReturnValue
public int getTimeout()

Gets the timeout.

Returns:

The timeout.

getUUID

@Nonnull
 @CheckReturnValue
public UUID getUUID()

Gets the identifying UUID.

Returns:

The identifying UUID.

isPrivate

@CheckReturnValue
public boolean isPrivate()

Asks if this context is private.

Returns:

True if this context is private.

isRemote

@CheckReturnValue
public boolean isRemote()

Asks if the server is remote.

Returns:

True if the server is remote.

lookup

@Nonnull
 @CheckReturnValue
public Remote lookup(@Nonnull
                                                   String sessionMode)
                                            throws AccessException,
                                                   RemoteException,
                                                   NotBoundException

Performs a lookup of the registry entry.

Parameters:

sessionMode - The session mode name.

Returns:

The remote instance.

Throws:

NotBoundException - When the server name is not currently bound.

RemoteException - When the communication with the registry failed.

AccessException - When access is denied.

register

public boolean register()

Registers itself.

Returns:

False if already registered.

setTimeout

public void setTimeout(@Nonnegative
                       int timeout)

Sets the timeout.

Parameters:

timeout - The timeout.

unregister

public boolean unregister()

Unregisters itself.

Returns:

False if not registered.