org.rvpf.forwarder

Interface ForwarderModule

All Known Implementing Classes:

ForwarderModule.Abstract, FromAlerterModule, InputModule, MessagesFilesModule, MessagesPortClientModule, MessagesPortServerModule, OutputModule, SOMPublisherModule, SOMReceiverModule, SOMSenderModule, SOMSubscriberModule, StoreRequestsModule, StoreUpdaterModule, ToAlerterModule

public interface ForwarderModule

Forwarder module.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ForwarderModule.Abstract Abstract forwarder module.

Method Summary

Modifier and Type	Method and Description
BatchControl	getBatchControl() Gets the batch control.
Config	getConfig() Gets the configuration.
Service	getService() Gets the owner of this module.
boolean	isReliable() Asks if the module is reliable.
boolean	needsMetadata() Asks if this module needs metadata.
boolean	onMetadataRefreshed() Called when the metadata should be refreshed.
boolean	setUp(ForwarderServiceAppImpl forwarderApp, 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.

Method Detail

getBatchControl

@Nonnull
 @CheckReturnValue
BatchControl getBatchControl()

Gets the batch control.

Returns:

The batch control.

getConfig

@Nonnull
 @CheckReturnValue
Config getConfig()

Gets the configuration.

Returns:

The configuration.

getService

@Nonnull
 @CheckReturnValue
Service getService()

Gets the owner of this module.

Returns:

The owner of this module.

isReliable

@CheckReturnValue
boolean isReliable()

Asks if the module is reliable.

Returns:

True if the module is reliable.

needsMetadata

@CheckReturnValue
boolean needsMetadata()

Asks if this module needs metadata.

Returns:

True if it does.

onMetadataRefreshed

@CheckReturnValue
boolean onMetadataRefreshed()

Called when the metadata should be refreshed.

Returns:

False if a restart is needed.

setUp

@CheckReturnValue
boolean setUp(@Nonnull
                                 ForwarderServiceAppImpl forwarderApp,
                                 @Nonnull
                                 KeyedGroups moduleProperties)

Sets up this module.

Parameters:

forwarderApp - The owner of this module.

moduleProperties - The module properties.

Returns:

True on success.

start

void start()
    throws InterruptedException,
           ServiceNotAvailableException

Starts this module.

Throws:

InterruptedException - When appropriate.

ServiceNotAvailableException - When the service is not available.

stop

void stop()

Stops this module.

tearDown

void tearDown()

Tears down what has been set up.