org.rvpf.som.queue

Class QueueServerImpl

Object

SessionFactoryImpl

SOMServerImpl

QueueServerImpl

All Implemented Interfaces:

Remote, QueueServer, SOMServer, SessionFactory

public final class QueueServerImpl
extends SOMServerImpl
implements QueueServer

Queue server implementation.

Nested Class Summary

Nested classes/interfaces inherited from class SOMServerImpl

SOMServerImpl.Descriptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	BACKUP_ALL_PROPERTY True will backup messages on all queues.
static String	DEFAULT_ROOT Default queue root directory.
static String	LOCK_DISABLED_PROPERTY The lock disabled property.
static String	MEMORY_PROPERTY Memory property.
static String	MERGE_LIMIT_ALL_PROPERTY Merge limit for all queues.
static String	MERGE_SPLIT_ALL_PROPERTY Merge split for all queues.
static String	ROOT_ALL_PROPERTY The root directory for the SOM queues.

Fields inherited from class SOMServerImpl

DEFAULT_KEEP_ALIVE, DEFAULT_KEEP_ALIVE_PROPERTY, KEEP_ALIVE_PROPERTY, READ_ROLE, READ_ROLE_PROPERTY, WRITE_ROLE, WRITE_ROLE_PROPERTY

Fields inherited from interface SOMServer

BINDING_PROPERTY, DEFAULT_QUEUE_BINDING_PREFIX, DEFAULT_TOPIC_BINDING_PREFIX, NAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
QueueServerImpl(Optional<SessionSecurityContext> securityContext) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the sessions.
ReceiverSession	createReceiverSession(UUID uuid, String clientName) Creates a receiver session.
ReceiverWrapper	createReceiverWrapper() Creates a receiver wrapper.
SenderSession	createSenderSession(UUID uuid, String clientName) Creates a sender session.
SenderWrapper	createSenderWrapper() Creates a sender wrapper.
QueueInfo	getInfo() Gets the queue info.
Queue	getQueue() Gets the queue.
protected Session	newSession(Session.ConnectionMode connectionMode, Optional<RMIClientSocketFactory> clientSocketFactory, Optional<RMIServerSocketFactory> serverSocketFactory, Object reference) Returns a new session
boolean	removeSession(SessionImpl session) Removes a session from the set.
boolean	setUp(Config config, KeyedGroups queueProperties) Sets up this server.
void	tearDown() Tears down what has been set up.

Methods inherited from class SOMServerImpl

bind, fillRolesMap, getKeepAlive, getName, getURI, setUp, setUp, stop, toString

Methods inherited from class SessionFactoryImpl

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

Methods inherited from class Object

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

Methods inherited from interface SOMServer

getKeepAlive, getName

Field Detail

BACKUP_ALL_PROPERTY

public static final String BACKUP_ALL_PROPERTY

True will backup messages on all queues.

See Also:

Constant Field Values

DEFAULT_ROOT

public static final String DEFAULT_ROOT

Default queue root directory.

See Also:

Constant Field Values

LOCK_DISABLED_PROPERTY

public static final String LOCK_DISABLED_PROPERTY

The lock disabled property.

See Also:

Constant Field Values

MEMORY_PROPERTY

public static final String MEMORY_PROPERTY

Memory property.

See Also:

Constant Field Values

MERGE_LIMIT_ALL_PROPERTY

public static final String MERGE_LIMIT_ALL_PROPERTY

Merge limit for all queues.

See Also:

Constant Field Values

MERGE_SPLIT_ALL_PROPERTY

public static final String MERGE_SPLIT_ALL_PROPERTY

Merge split for all queues.

See Also:

Constant Field Values

ROOT_ALL_PROPERTY

public static final String ROOT_ALL_PROPERTY

The root directory for the SOM queues. It can be specified as a relative or absolute path.

See Also:

Constant Field Values

Constructor Detail

QueueServerImpl

public QueueServerImpl(@Nonnull
                       Optional<SessionSecurityContext> securityContext)

Constructs an instance.

Parameters:

securityContext - The optional security context.

Method Detail

close

public void close()

Closes the sessions.

Overrides:

close in class SessionFactoryImpl

createReceiverSession

public ReceiverSession createReceiverSession(UUID uuid,
                                             String clientName)
                                      throws SessionException

Creates a receiver session.

Specified by:

createReceiverSession in interface QueueServer

Parameters:

uuid - A UUID used to locate the RMI client instance.

clientName - A descriptive name for the client.

Returns:

The receiver session.

Throws:

SessionException - When the session creation fails.

createReceiverWrapper

@Nonnull
 @CheckReturnValue
public ReceiverWrapper createReceiverWrapper()
                                                                    throws ReceiverActiveException

Creates a receiver wrapper.

Returns:

The receiver wrapper.

Throws:

ReceiverActiveException - When a receiver is already active.

createSenderSession

public SenderSession createSenderSession(UUID uuid,
                                         String clientName)
                                  throws SessionException

Creates a sender session.

Specified by:

createSenderSession in interface QueueServer

Parameters:

uuid - A UUID used to locate the RMI client instance.

clientName - A descriptive name for the client.

Returns:

The sender session.

Throws:

SessionException - When the session creation fails.

createSenderWrapper

@Nonnull
 @CheckReturnValue
public SenderWrapper createSenderWrapper()

Creates a sender wrapper.

Returns:

The sender wrapper.

getInfo

public QueueInfo getInfo()

Gets the queue info.

Specified by:

getInfo in interface QueueServer

Returns:

The queue info.

getQueue

@Nonnull
 @CheckReturnValue
public Queue getQueue()

Gets the queue.

Returns:

The queue.

removeSession

public boolean removeSession(SessionImpl session)

Removes a session from the set.

Specified by:

removeSession in interface SessionFactory

Overrides:

removeSession in class SOMServerImpl

Parameters:

session - The session.

Returns:

True if the session was in the set.

setUp

public boolean setUp(Config config,
                     KeyedGroups queueProperties)

Sets up this server.

Specified by:

setUp in class SOMServerImpl

Parameters:

config - The configuration.

queueProperties - The queue properties.

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.

Overrides:

tearDown in class SOMServerImpl

newSession

protected Session newSession(Session.ConnectionMode connectionMode,
                             Optional<RMIClientSocketFactory> clientSocketFactory,
                             Optional<RMIServerSocketFactory> serverSocketFactory,
                             Object reference)
                      throws ReceiverActiveException

Returns a new session

Specified by:

newSession in class SessionFactoryImpl

Parameters:

connectionMode - The connection mode.

clientSocketFactory - The optional client socket factory.

serverSocketFactory - The optional server socket factory.

reference - A reference object.

Returns:

The session.

Throws:

ReceiverActiveException