org.rvpf.processor.receptionist

Class Receptionist.Abstract

Object

Receptionist.Abstract

All Implemented Interfaces:

Receptionist

Direct Known Subclasses:

SOMReceptionist, StoreListenerReceptionist

Enclosing interface:

Receptionist

@NotThreadSafe
public abstract static class Receptionist.Abstract
extends Object
implements Receptionist

Abstract receptionist.

Nested Class Summary

Nested classes/interfaces inherited from interface Receptionist

Receptionist.Abstract

Field Summary

Fields

Modifier and Type	Field and Description
static ElapsedTime	DEFAULT_WAIT Default wait.
static String	WAIT_PROPERTY The maximum time in millis to wait for an additional notice when at least one has been accepted for processing.

Constructor Summary

Constructors

Constructor and Description
Abstract()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the input Queue.
void	commit() Registers that the notices have been processed.
protected abstract void	doClose() Closes the input Queue.
protected abstract void	doCommit() Registers that the notices have been processed.
protected abstract Optional<PointValue>	doFetchNotice(int limit, long wait) Fetches a notice.
protected abstract void	doOpen() Opens the input Queue.
protected abstract void	doRollback() Forgets that the notices have been received.
List<PointValue>	fetchNotices(int limit, long wait) Fetches notices.
protected Metadata	getMetadata() Gets the metadata.
protected Logger	getThisLogger() Gets the logger.
void	open() Opens the input Queue.
long	receptionTime() Returns and resets the reception time.
void	rollback() Forgets that the notices have been received.
boolean	setUp(Metadata metadata) Sets up access to the messaging system.
void	tearDown() Tears down what has been set up.

Methods inherited from class Object

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

Field Detail

DEFAULT_WAIT

public static final ElapsedTime DEFAULT_WAIT

Default wait.

WAIT_PROPERTY

public static final String WAIT_PROPERTY

The maximum time in millis to wait for an additional notice when at least one has been accepted for processing.

See Also:

Constant Field Values

Constructor Detail

Abstract

public Abstract()

Method Detail

close

public final void close()

Closes the input Queue.

Specified by:

close in interface Receptionist

commit

public final void commit()
                  throws InterruptedException,
                         ServiceNotAvailableException

Registers that the notices have been processed.

Specified by:

commit in interface Receptionist

Throws:

InterruptedException - When the service is stopped.

ServiceNotAvailableException - When the service is not available.

fetchNotices

public List<PointValue> fetchNotices(int limit,
                                     long wait)
                              throws InterruptedException,
                                     ServiceNotAvailableException

Fetches notices.

Specified by:

fetchNotices in interface Receptionist

Parameters:

limit - The limit for the number of notices.

wait - Negative is forever, 0 is no wait, other is milliseconds.

Returns:

The notices.

Throws:

InterruptedException - When the service is stopped.

ServiceNotAvailableException - When the service is not available.

open

public final void open()

Opens the input Queue.

Specified by:

open in interface Receptionist

receptionTime

public final long receptionTime()

Returns and resets the reception time.

Specified by:

receptionTime in interface Receptionist

Returns:

The reception time.

rollback

public final void rollback()
                    throws InterruptedException,
                           ServiceNotAvailableException

Forgets that the notices have been received.

Specified by:

rollback in interface Receptionist

Throws:

InterruptedException - When the service is stopped.

ServiceNotAvailableException - When the service is not available.

setUp

public boolean setUp(Metadata metadata)

Sets up access to the messaging system.

Specified by:

setUp in interface Receptionist

Parameters:

metadata - The processor metadata.

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.

Specified by:

tearDown in interface Receptionist

doClose

protected abstract void doClose()

Closes the input Queue.

Called while synchronized on this. May be called while already closed.

doCommit

protected abstract void doCommit()
                          throws InterruptedException,
                                 ServiceNotAvailableException

Registers that the notices have been processed.

Called while synchronized on this.

Throws:

InterruptedException - When the Service is stopped.

ServiceNotAvailableException - When the service is not available.

doFetchNotice

@Nonnull
 @CheckReturnValue
protected abstract Optional<PointValue> doFetchNotice(int limit,
                                                                                    long wait)
                                                                             throws InterruptedException,
                                                                                    ServiceNotAvailableException

Fetches a notice.

Parameters:

limit - The read ahead limit.

wait - Negative is forever, 0 is no wait, other is milliseconds.

Returns:

A point value (empty on timeout).

Throws:

InterruptedException - When the Service is stopped.

ServiceNotAvailableException - When the service is not available.

doOpen

protected abstract void doOpen()

Opens the input Queue.

Called while synchronized on this.

doRollback

protected abstract void doRollback()
                            throws InterruptedException,
                                   ServiceNotAvailableException

Forgets that the notices have been received.

Throws:

InterruptedException - When the Service is stopped.

ServiceNotAvailableException - When the service is not available.

getMetadata

@Nonnull
 @CheckReturnValue
protected Metadata getMetadata()

Gets the metadata.

Returns:

The metadata.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.