org.rvpf.base.som

Class QueueProxy.Receiver

Object

SessionProxy

SOMProxy

QueueProxy

QueueProxy.Receiver

All Implemented Interfaces:

Remote, Session, ReceiverSession, SOMSession

Enclosing class:

QueueProxy

public static final class QueueProxy.Receiver
extends QueueProxy
implements ReceiverSession

Receiver.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueueProxy.Receiver.Builder Builder.

Nested classes/interfaces inherited from class QueueProxy

QueueProxy.Receiver, QueueProxy.Sender

Nested classes/interfaces inherited from class SOMProxy

SOMProxy.ContextProperties

Nested classes/interfaces inherited from class SessionProxy

SessionProxy.Listener, SessionProxy.SessionConnectVetoException

Nested classes/interfaces inherited from interface Session

Session.ConnectionMode

Field Summary

Fields inherited from class SOMProxy

PASSWORD_PROPERTY, TIMEOUT_PROPERTY, USER_PROPERTY

Method Summary

Modifier and Type	Method and Description
void	commit() Commits uncommitted messages.
protected Session	createSession() Creates a session.
static QueueProxy.Receiver.Builder	newBuilder() Returns a new builder.
long	purge() Purges the queue.
Serializable[]	receive(int limit, long timeout) Receives messages.
void	rollback() Rolls back uncommitted messages.
protected String	sessionMode() Returns some session mode identifying text.

Methods inherited from class QueueProxy

connect, getInfo

Methods inherited from class SOMProxy

close, confirmTimeout, disconnect, getSOMName, isClosed

Methods inherited from class SessionProxy

getClientName, getConnectionMode, getContext, getContextUUID, getFactory, getServerName, getServerURI, getSession, getThisLogger, hasLoginInfo, isConnected, isPrivate, isRemote, lockConnect, lockConnectInterruptibly, login, logout, sessionException, tearDown, unlockConnect

Methods inherited from class Object

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

Methods inherited from interface SOMSession

close

Methods inherited from interface Session

getConnectionMode, login, logout

Method Detail

newBuilder

@Nonnull
 @CheckReturnValue
public static QueueProxy.Receiver.Builder newBuilder()

Returns a new builder.

Returns:

The new builder.

commit

public void commit()
            throws SessionException

Commits uncommitted messages.

Specified by:

commit in interface ReceiverSession

Throws:

SessionException - From session security check.

purge

public long purge()
           throws SessionException

Purges the queue.

Specified by:

purge in interface ReceiverSession

Returns:

The number of messages purged.

Throws:

SessionException - From session security check.

receive

public Serializable[] receive(int limit,
                              long timeout)
                       throws SessionException

Receives messages.

Specified by:

receive in interface ReceiverSession

Parameters:

limit - The maximum number of messages.

timeout - A time limit in millis to wait for the first message (negative for infinite).

Returns:

The messages.

Throws:

SessionException - From session security check.

rollback

public void rollback()
              throws SessionException

Rolls back uncommitted messages.

Specified by:

rollback in interface ReceiverSession

Throws:

SessionException - From session security check.

createSession

protected Session createSession()
                         throws RemoteException,
                                SessionException

Creates a session.

Overrides:

createSession in class QueueProxy

Returns:

The session.

Throws:

RemoteException - From RMI.

SessionException - When session creation fails.

sessionMode

protected String sessionMode()

Returns some session mode identifying text.

Overrides:

sessionMode in class SessionProxy

Returns:

The session mode identifying text.