org.rvpf.som

Class SOMServerImpl

Object

SessionFactoryImpl

SOMServerImpl

All Implemented Interfaces:

Remote, SOMServer, SessionFactory

Direct Known Subclasses:

QueueServerImpl, TopicServerImpl

public abstract class SOMServerImpl
extends SessionFactoryImpl
implements SOMServer

SOM server implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SOMServerImpl.Descriptor Descriptor.

Field Summary

Fields

Modifier and Type	Field and Description
static ElapsedTime	DEFAULT_KEEP_ALIVE The default keep-alive.
static String	DEFAULT_KEEP_ALIVE_PROPERTY The default keep-alive property.
static String	KEEP_ALIVE_PROPERTY The keep-alive property.
static String	READ_ROLE The read role.
static String	READ_ROLE_PROPERTY The security role needed to read from this service.
static String	WRITE_ROLE The write role.
static String	WRITE_ROLE_PROPERTY The security role needed to write to this service.

Fields inherited from interface SOMServer

BINDING_PROPERTY, DEFAULT_QUEUE_BINDING_PREFIX, DEFAULT_TOPIC_BINDING_PREFIX, NAME_PROPERTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SOMServerImpl(Optional<SessionSecurityContext> securityContext) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	bind() Binds this server to the registry.
protected void	fillRolesMap() Fills the role map.
ElapsedTime	getKeepAlive() Gets the keep-alive value.
String	getName() Gets the name of this.
URI	getURI() Gets the URI.
boolean	removeSession(SessionImpl session) Removes a session from the set.
boolean	setUp(Config config) Sets up this session factory.
abstract boolean	setUp(Config config, KeyedGroups somProperties) Sets up this server.
protected boolean	setUp(Config config, KeyedGroups somProperties, String defaultBindingPrefix) Sets up this server.
boolean	stop(int timeout) Stops this SOM service.
void	tearDown() Tears down what has been set up.
String	toString()

Methods inherited from class SessionFactoryImpl

addSession, close, createSecurityContext, createSession, createSession, equals, export, getConfig, getMappedRoles, getRealm, getSessionCount, getSessions, getThisLogger, hashCode, hasRolesMap, hasSecurityContext, isClosed, mapRoles, newSession, unexport

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_KEEP_ALIVE

public static final ElapsedTime DEFAULT_KEEP_ALIVE

The default keep-alive.

DEFAULT_KEEP_ALIVE_PROPERTY

public static final String DEFAULT_KEEP_ALIVE_PROPERTY

The default keep-alive property.

See Also:

Constant Field Values

KEEP_ALIVE_PROPERTY

public static final String KEEP_ALIVE_PROPERTY

The keep-alive property.

See Also:

Constant Field Values

READ_ROLE

public static final String READ_ROLE

The read role.

See Also:

Constant Field Values

READ_ROLE_PROPERTY

public static final String READ_ROLE_PROPERTY

The security role needed to read from this service.

See Also:

Constant Field Values

WRITE_ROLE

public static final String WRITE_ROLE

The write role.

See Also:

Constant Field Values

WRITE_ROLE_PROPERTY

public static final String WRITE_ROLE_PROPERTY

The security role needed to write to this service.

See Also:

Constant Field Values

Constructor Detail

SOMServerImpl

protected SOMServerImpl(@Nonnull
                        Optional<SessionSecurityContext> securityContext)

Constructs an instance.

Parameters:

securityContext - The optional security context.

Method Detail

getKeepAlive

public ElapsedTime getKeepAlive()

Gets the keep-alive value.

Specified by:

getKeepAlive in interface SOMServer

Returns:

The keep-alive value.

getName

public final String getName()

Gets the name of this.

Specified by:

getName in interface SOMServer

Returns:

The name of this.

getURI

@Nonnull
 @CheckReturnValue
public URI getURI()

Gets the URI.

Returns:

The URI.

removeSession

public boolean removeSession(SessionImpl session)

Removes a session from the set.

Specified by:

removeSession in interface SessionFactory

Overrides:

removeSession in class SessionFactoryImpl

Parameters:

session - The session.

Returns:

True if the session was in the set.

setUp

public final boolean setUp(Config config)

Sets up this session factory.

Overrides:

setUp in class SessionFactoryImpl

Parameters:

config - The config.

Returns:

True on success.

setUp

@CheckReturnValue
public abstract boolean setUp(@Nonnull
                                                 Config config,
                                                 @Nonnull
                                                 KeyedGroups somProperties)

Sets up this server.

Parameters:

config - The configuration.

somProperties - The queue properties.

Returns:

True on success.

stop

public final boolean stop(int timeout)

Stops this SOM service.

Parameters:

timeout - A time limit in millis to wait for clients (negative for infinite).

Returns:

True if the service has been stopped.

tearDown

public void tearDown()

Tears down what has been set up.

Overrides:

tearDown in class SessionFactoryImpl

toString

public final String toString()

Overrides:

toString in class Object

bind

@CheckReturnValue
protected boolean bind()

Binds this server to the registry.

Returns:

True on success.

fillRolesMap

protected void fillRolesMap()

Fills the role map.

This associates internal roles to external required roles.

Specified by:

fillRolesMap in class SessionFactoryImpl

setUp

@CheckReturnValue
protected boolean setUp(@Nonnull
                                           Config config,
                                           @Nonnull
                                           KeyedGroups somProperties,
                                           @Nonnull
                                           String defaultBindingPrefix)

Sets up this server.

Parameters:

config - The configuration.

somProperties - The queue properties.

defaultBindingPrefix - The default binding prefix.

Returns:

True on success.