org.rvpf.forwarder.input

Class InputModule

Object

ForwarderModule.Abstract

InputModule

All Implemented Interfaces:

ForwarderModule, ServiceThread.Target

Direct Known Subclasses:

FromAlerterModule, MessagesFilesModule, MessagesPortServerModule, SOMReceiverModule, SOMSubscriberModule, StoreRequestsModule

public abstract class InputModule
extends ForwarderModule.Abstract
implements ServiceThread.Target

Input module.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	InputModule.AbstractInput Abstract input.
protected static interface	InputModule.ModuleInput Module input.

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 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
InputModule()

Method Summary

Modifier and Type	Method and Description
protected int	getDefaultBatchLimit() Gets the default batch limit.
protected InputModule.ModuleInput	getInput() Gets the input.
protected boolean	output(Serializable[] messages) Outputs messages.
void	run() Runs.
protected void	setInput(InputModule.ModuleInput input) Sets the input.
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

Constructor Detail

InputModule

public InputModule()

Method Detail

run

public final void run()
               throws InterruptedException

Runs.

Similar to same in Runnable but may throw exceptions.

Specified by:

run in interface ServiceThread.Target

Throws:

InterruptedException

start

public void start()

Starts this module.

Specified by:

start in interface ForwarderModule

stop

public void stop()

Stops this module.

Specified by:

stop in interface ForwarderModule

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.

getInput

@Nonnull
 @CheckReturnValue
protected final InputModule.ModuleInput getInput()

Gets the input.

Returns:

Returns the input.

output

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

Outputs messages.

Parameters:

messages - The messages.

Returns:

True on success.

Throws:

InterruptedException - When the module input is stopped.

ServiceNotAvailableException - When the service is not available.

setInput

protected final void setInput(@Nonnull
                              InputModule.ModuleInput input)

Sets the input.

Parameters:

input - The input.

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.