org.rvpf.service.rmi

Class SessionImpl

Object

SessionImpl

All Implemented Interfaces:

Remote, Unreferenced, Session

Direct Known Subclasses:

ExportedSessionImpl

@ThreadSafe
public abstract class SessionImpl
extends Object
implements Session, Unreferenced

Session implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface Session

Session.ConnectionMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SessionImpl(String clientName, SessionFactory sessionFactory, Session.ConnectionMode connectionMode) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the session.
protected String	getClientName() Gets the client name.
Session.ConnectionMode	getConnectionMode() Gets the connection mode.
protected Identity	getIdentity(Optional<String> identifier) Gets the identity for an identifier.
SessionFactory	getSessionFactory() Gets the session factory.
protected Logger	getThisLogger() Gets the logger.
protected Optional<String>	getUser() Gets the user.
boolean	isClosed() Asks if the service is closed.
void	login(String identifier, char[] password) Identifies and authenticates the identity associated with the Session.
void	logout() Logs out.
void	open() Opens the session.
void	securityCheck(String requiredRole) Performs security checks.
protected void	setLogID() Sets the log ID.
protected void	setUser(Optional<String> identifier) Sets the user.
String	toString()
void	unreferenced()

Methods inherited from class Object

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

Constructor Detail

SessionImpl

protected SessionImpl(@Nonnull
                      String clientName,
                      @Nonnull
                      SessionFactory sessionFactory,
                      @Nonnull
                      Session.ConnectionMode connectionMode)

Constructs an instance.

Parameters:

clientName - A descriptive name for the client.

sessionFactory - The factory creating this.

connectionMode - The connection mode.

Method Detail

close

public void close()

Closes the session.

getConnectionMode

public final Session.ConnectionMode getConnectionMode()

Gets the connection mode.

Specified by:

getConnectionMode in interface Session

Returns:

The connection mode.

getSessionFactory

@Nonnull
 @CheckReturnValue
public final SessionFactory getSessionFactory()

Gets the session factory.

Returns:

The session factory.

isClosed

@CheckReturnValue
public boolean isClosed()

Asks if the service is closed.

Returns:

True if the service is closed.

login

public final void login(String identifier,
                        char[] password)
                 throws LoginFailedException,
                        ServiceClosedException

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.

Throws:

LoginFailedException

ServiceClosedException

logout

public final void logout()

Logs out.

Specified by:

logout in interface Session

open

public void open()

Opens the session.

securityCheck

public final void securityCheck(@Nonnull
                                String requiredRole)
                         throws UnauthorizedAccessException,
                                ServiceClosedException

Performs security checks.

Parameters:

requiredRole - The required role.

Throws:

UnauthorizedAccessException - When access is not authorized.

ServiceClosedException - When the service is closed.

toString

public String toString()

Overrides:

toString in class Object

unreferenced

public final void unreferenced()

Specified by:

unreferenced in interface Unreferenced

getClientName

@Nonnull
 @CheckReturnValue
protected final String getClientName()

Gets the client name.

Returns:

The client name.

getIdentity

@Nonnull
 @CheckReturnValue
protected final Identity getIdentity(@Nonnull
                                                                   Optional<String> identifier)

Gets the identity for an identifier.

Parameters:

identifier - The optional identifier for the identity.

Returns:

The roles of an identity.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.

getUser

@Nonnull
 @CheckReturnValue
protected Optional<String> getUser()

Gets the user.

Returns:

The user.

setLogID

protected void setLogID()

Sets the log ID.

setUser

protected void setUser(@Nonnull
                       Optional<String> identifier)

Sets the user.

Parameters:

identifier - The optional user identifier.