org.rvpf.forwarder

Class ForwarderModule.Abstract

Object

ForwarderModule.Abstract

All Implemented Interfaces:

ForwarderModule

Direct Known Subclasses:

InputModule, OutputModule

Enclosing interface:

ForwarderModule

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

Abstract forwarder module.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ForwarderModule.Abstract.AbstractInputOutput Abstract input/output.
protected static interface	ForwarderModule.Abstract.ModuleInputOutput Module input/output.

Nested classes/interfaces inherited from interface ForwarderModule

ForwarderModule.Abstract

Field Summary

Fields

Modifier and Type	Field and Description
static String	BATCH_LIMIT_PROPERTY Specifies the maximum number of messages in a transaction.
static String	CONNECTION_RETRY_DELAY_PROPERTY The time in millis before trying to reconnect to the service.
static ElapsedTime	DEFAULT_CONNECTION_RETRY_DELAY Default connection retry delay.
static String	FILTER_CLASS_PROPERTY The filter class property.
static String	FILTER_PROPERTIES The filter properties group.
static String	MODULE_UUID_PROPERTY A UUID for the module.
static String	PASSWORD_PROPERTY Password property.
static String	RELIABLE_PROPERTY Reliable property.
static String	TRACES_PROPERTY The names of the subdirectory holding traces for this module.
static String	USER_PROPERTY User property.

Constructor Summary

Constructors

Constructor and Description
Abstract()

Method Summary

Modifier and Type	Method and Description
protected Serializable[]	filter(Serializable[] messages) Filters messages.
BatchControl	getBatchControl() Gets the batch control.
Config	getConfig() Gets the configuration.
KeyedGroups	getConfigProperties() Gets the configuration properties.
protected ElapsedTime	getConnectionRetryDelay() Gets the service connection retry delay.
protected abstract int	getDefaultBatchLimit() Gets the default batch limit.
protected Optional<ElapsedTime>	getDefaultBatchWait() Gets the default batch wait.
protected ForwarderServiceAppImpl	getForwarderAppImpl() Gets the owner of this module.
protected Metadata	getMetadata() Gets the metadata.
protected Optional<Boolean>	getReliable() Gets the reliable indicator.
Service	getService() Gets the owner of this module.
Logger	getThisLogger() Gets the logger.
Traces	getTraces() Gets the traces.
boolean	isReliable() Asks if the module is reliable.
protected boolean	loadMetadata(MetadataFilter metadataFilter) Loads the metadata.
boolean	needsMetadata() Asks if this module needs metadata.
boolean	onMetadataRefreshed() Called when the metadata should be refreshed.
protected void	setReliable(Boolean reliable) Sets the reliable indicator.
boolean	setUp(ForwarderServiceAppImpl forwarderApp, KeyedGroups moduleProperties) Sets up this module.
protected abstract boolean	setUp(KeyedGroups moduleProperties) Sets up this module.
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

Methods inherited from interface ForwarderModule

start, stop

Field Detail

BATCH_LIMIT_PROPERTY

public static final String BATCH_LIMIT_PROPERTY

Specifies the maximum number of messages in a transaction.

See Also:

Constant Field Values

CONNECTION_RETRY_DELAY_PROPERTY

public static final String CONNECTION_RETRY_DELAY_PROPERTY

The time in millis before trying to reconnect to the service.

See Also:

Constant Field Values

DEFAULT_CONNECTION_RETRY_DELAY

public static final ElapsedTime DEFAULT_CONNECTION_RETRY_DELAY

Default connection retry delay.

FILTER_CLASS_PROPERTY

public static final String FILTER_CLASS_PROPERTY

The filter class property.

See Also:

Constant Field Values

FILTER_PROPERTIES

public static final String FILTER_PROPERTIES

The filter properties group.

See Also:

Constant Field Values

MODULE_UUID_PROPERTY

public static final String MODULE_UUID_PROPERTY

A UUID for the module. This is needed when the module is a client of the metadata server.

See Also:

Constant Field Values

PASSWORD_PROPERTY

public static final String PASSWORD_PROPERTY

Password property.

See Also:

Constant Field Values

RELIABLE_PROPERTY

public static final String RELIABLE_PROPERTY

Reliable property.

See Also:

Constant Field Values

TRACES_PROPERTY

public static final String TRACES_PROPERTY

The names of the subdirectory holding traces for this module.

See Also:

Constant Field Values

USER_PROPERTY

public static final String USER_PROPERTY

User property.

See Also:

Constant Field Values

Constructor Detail

Abstract

public Abstract()

Method Detail

getBatchControl

public final BatchControl getBatchControl()

Gets the batch control.

Specified by:

getBatchControl in interface ForwarderModule

Returns:

The batch control.

getConfig

public final Config getConfig()

Gets the configuration.

Specified by:

getConfig in interface ForwarderModule

Returns:

The configuration.

getConfigProperties

@Nonnull
 @CheckReturnValue
public final KeyedGroups getConfigProperties()

Gets the configuration properties.

Returns:

The configuration properties.

getService

public final Service getService()

Gets the owner of this module.

Specified by:

getService in interface ForwarderModule

Returns:

The owner of this module.

getThisLogger

@Nonnull
 @CheckReturnValue
public final Logger getThisLogger()

Gets the logger.

Returns:

The logger.

getTraces

@Nonnull
 @CheckReturnValue
public final Traces getTraces()

Gets the traces.

Returns:

The traces.

isReliable

public boolean isReliable()

Asks if the module is reliable.

Specified by:

isReliable in interface ForwarderModule

Returns:

True if the module is reliable.

needsMetadata

public boolean needsMetadata()

Asks if this module needs metadata.

Specified by:

needsMetadata in interface ForwarderModule

Returns:

True if it does.

onMetadataRefreshed

public boolean onMetadataRefreshed()

Called when the metadata should be refreshed.

Specified by:

onMetadataRefreshed in interface ForwarderModule

Returns:

False if a restart is needed.

setUp

public final boolean setUp(ForwarderServiceAppImpl forwarderApp,
                           KeyedGroups moduleProperties)

Sets up this module.

Specified by:

setUp in interface ForwarderModule

Parameters:

forwarderApp - The owner of this module.

moduleProperties - The module properties.

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.

Specified by:

tearDown in interface ForwarderModule

filter

@Nonnull
 @CheckReturnValue
protected final Serializable[] filter(@Nonnull
                                                                    Serializable[] messages)
                                                             throws InterruptedException,
                                                                    ServiceNotAvailableException

Filters messages.

Parameters:

messages - The messages to be filtered.

Returns:

The filtered messages.

Throws:

InterruptedException - When the service is stopped.

ServiceNotAvailableException - When the service is not available.

getConnectionRetryDelay

@Nonnull
 @CheckReturnValue
protected final ElapsedTime getConnectionRetryDelay()

Gets the service connection retry delay.

Returns:

The service connection retry delay.

getDefaultBatchLimit

@CheckReturnValue
protected abstract int getDefaultBatchLimit()

Gets the default batch limit.

Returns:

The default batch limit.

getDefaultBatchWait

@Nonnull
 @CheckReturnValue
protected Optional<ElapsedTime> getDefaultBatchWait()

Gets the default batch wait.

Returns:

The optional default batch wait.

getForwarderAppImpl

@Nonnull
 @CheckReturnValue
protected final ForwarderServiceAppImpl getForwarderAppImpl()

Gets the owner of this module.

Returns:

The owner of this module.

getMetadata

@Nonnull
 @CheckReturnValue
protected final Metadata getMetadata()

Gets the metadata.

Returns:

The metadata.

getReliable

@Nonnull
 @CheckReturnValue
protected Optional<Boolean> getReliable()

Gets the reliable indicator.

Returns:

The optional reliable indicator.

loadMetadata

@CheckReturnValue
protected final boolean loadMetadata(@Nonnull
                                                        MetadataFilter metadataFilter)

Loads the metadata.

Parameters:

metadataFilter - The metadata filter.

Returns:

True on success.

setReliable

protected void setReliable(@Nonnull
                           Boolean reliable)

Sets the reliable indicator.

Parameters:

reliable - The reliable indicator.

setUp

@CheckReturnValue
protected abstract boolean setUp(@Nonnull
                                                    KeyedGroups moduleProperties)

Sets up this module.

Parameters:

moduleProperties - The module properties.

Returns:

True on success.