org.rvpf.forwarder.input

Class StoreRequestsModule

Object

ForwarderModule.Abstract

InputModule

StoreRequestsModule

All Implemented Interfaces:

ForwarderModule, ServiceThread.Target

@NotThreadSafe
public final class StoreRequestsModule
extends InputModule

Store requests module.

Nested Class Summary

Nested classes/interfaces inherited from class InputModule

InputModule.AbstractInput, InputModule.ModuleInput

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 String	CONTROL_DIR_PROPERTY The module's control directory.
static String	DELIVER_PROPERTY The deliver property.
static String	MARK_FILE_NAME The mark file name.
static String	NAME_PROPERTY The name property.
static String	NOTICES_PROPERTY The notices property.
static String	POINT_PROPERTY The point property.
static String	PULL_PROPERTY The pull property.
static String	STORE_PROPERTIES The store properties.

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

Method Summary

Modifier and Type	Method and Description
boolean	needsMetadata() Asks if this module needs metadata.
boolean	onMetadataRefreshed() Called when the metadata should be refreshed.
protected boolean	setUp(KeyedGroups moduleProperties) Sets up this module.

Methods inherited from class InputModule

getDefaultBatchLimit, getInput, output, run, setInput, start, stop, tearDown

Methods inherited from class ForwarderModule.Abstract

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

Methods inherited from class Object

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

Field Detail

CONTROL_DIR_PROPERTY

public static final String CONTROL_DIR_PROPERTY

The module's control directory.

See Also:

Constant Field Values

DELIVER_PROPERTY

public static final String DELIVER_PROPERTY

The deliver property.

See Also:

Constant Field Values

MARK_FILE_NAME

public static final String MARK_FILE_NAME

The mark file name.

See Also:

Constant Field Values

NAME_PROPERTY

public static final String NAME_PROPERTY

The name property.

See Also:

Constant Field Values

NOTICES_PROPERTY

public static final String NOTICES_PROPERTY

The notices property.

See Also:

Constant Field Values

POINT_PROPERTY

public static final String POINT_PROPERTY

The point property.

See Also:

Constant Field Values

PULL_PROPERTY

public static final String PULL_PROPERTY

The pull property.

See Also:

Constant Field Values

STORE_PROPERTIES

public static final String STORE_PROPERTIES

The store properties.

See Also:

Constant Field Values

Constructor Detail

StoreRequestsModule

public StoreRequestsModule()

Method Detail

needsMetadata

public boolean needsMetadata()

Asks if this module needs metadata.

Specified by:

needsMetadata in interface ForwarderModule

Overrides:

needsMetadata in class ForwarderModule.Abstract

Returns:

True if it does.

onMetadataRefreshed

public boolean onMetadataRefreshed()

Called when the metadata should be refreshed.

Specified by:

onMetadataRefreshed in interface ForwarderModule

Overrides:

onMetadataRefreshed in class ForwarderModule.Abstract

Returns:

False if a restart is needed.

setUp

protected boolean setUp(KeyedGroups moduleProperties)

Sets up this module.

Overrides:

setUp in class InputModule

Parameters:

moduleProperties - The module properties.

Returns:

True on success.