org.rvpf.forwarder.output

Class OutputModule

Object

ForwarderModule.Abstract

OutputModule

All Implemented Interfaces:

ForwarderModule

Direct Known Subclasses:

MessagesPortClientModule, SOMPublisherModule, SOMSenderModule, StoreUpdaterModule, ToAlerterModule

public abstract class OutputModule
extends ForwarderModule.Abstract

Output module.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OutputModule.AbstractOutput Abstract output.
protected static interface	OutputModule.ModuleOutput Module output.

Nested classes/interfaces inherited from class ForwarderModule.Abstract

ForwarderModule.Abstract.AbstractInputOutput, ForwarderModule.Abstract.ModuleInputOutput

Nested classes/interfaces inherited from interface ForwarderModule

ForwarderModule.Abstract

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BATCH_LIMIT Default batch limit.

Fields inherited from class ForwarderModule.Abstract

BATCH_LIMIT_PROPERTY, CONNECTION_RETRY_DELAY_PROPERTY, DEFAULT_CONNECTION_RETRY_DELAY, FILTER_CLASS_PROPERTY, FILTER_PROPERTIES, MODULE_UUID_PROPERTY, PASSWORD_PROPERTY, RELIABLE_PROPERTY, TRACES_PROPERTY, USER_PROPERTY

Constructor Summary

Constructors

Constructor and Description
OutputModule()

Method Summary

Modifier and Type	Method and Description
boolean	commit() Commits the messages transmission.
protected int	getDefaultBatchLimit() Gets the default batch limit.
protected boolean	isAlone() Asks if this module is alone.
protected void	open(OutputModule.ModuleOutput output) Opens the output.
boolean	output(Serializable[] messages) Outputs messages.
protected void	setOutput(OutputModule.ModuleOutput output) Sets the output.
protected boolean	setUp(KeyedGroups moduleProperties) Sets up this module.
void	start() Starts this module.
void	stop() Stops this module.
void	tearDown() Tears down what has been set up.

Methods inherited from class ForwarderModule.Abstract

filter, getBatchControl, getConfig, getConfigProperties, getConnectionRetryDelay, getDefaultBatchWait, getForwarderAppImpl, getMetadata, getReliable, getService, getThisLogger, getTraces, isReliable, loadMetadata, needsMetadata, onMetadataRefreshed, setReliable, setUp

Methods inherited from class Object

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

Field Detail

DEFAULT_BATCH_LIMIT

public static final int DEFAULT_BATCH_LIMIT

Default batch limit.

See Also:

Constant Field Values

Constructor Detail

OutputModule

public OutputModule()

Method Detail

commit

@CheckReturnValue
public boolean commit()
                                  throws InterruptedException,
                                         ServiceNotAvailableException

Commits the messages transmission.

Returns:

True on success.

Throws:

InterruptedException - When the service is stopped.

ServiceNotAvailableException - When the service is not available.

output

@CheckReturnValue
public boolean output(@Nonnull
                                         Serializable[] messages)
                                  throws InterruptedException,
                                         ServiceNotAvailableException

Outputs messages.

Parameters:

messages - The messages.

Returns:

True on success.

Throws:

InterruptedException - When the module output is stopped.

ServiceNotAvailableException - When the service is not available.

start

public void start()
           throws InterruptedException,
                  ServiceNotAvailableException

Starts this module.

Throws:

InterruptedException - When appropriate.

ServiceNotAvailableException - When the service is not available.

stop

public void stop()

Stops this module.

tearDown

public void tearDown()

Tears down what has been set up.

Specified by:

tearDown in interface ForwarderModule

Overrides:

tearDown in class ForwarderModule.Abstract

getDefaultBatchLimit

protected int getDefaultBatchLimit()

Gets the default batch limit.

Specified by:

getDefaultBatchLimit in class ForwarderModule.Abstract

Returns:

The default batch limit.

isAlone

protected final boolean isAlone()

Asks if this module is alone.

Returns:

True if this module is alone.

open

protected final void open(@Nonnull
                          OutputModule.ModuleOutput output)
                   throws InterruptedException,
                          ServiceNotAvailableException

Opens the output.

Parameters:

output - The output.

Throws:

InterruptedException - When appropriate.

ServiceNotAvailableException - When the service is not available.

setOutput

protected final void setOutput(@Nonnull
                               OutputModule.ModuleOutput output)

Sets the output.

Parameters:

output - The output.

setUp

protected boolean setUp(KeyedGroups moduleProperties)

Sets up this module.

Specified by:

setUp in class ForwarderModule.Abstract

Parameters:

moduleProperties - The module properties.

Returns:

True on success.