MessagesFilesModule (RVPF-Core API Documentation)

Object
- ForwarderModule.Abstract
- - InputModule
  - - MessagesFilesModule

All Implemented Interfaces:

ForwarderModule, ServiceThread.Target
```
public final class MessagesFilesModule
extends InputModule
```
Messages files 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`	`COMPRESSED_SUFFIX_PROPERTY` The file name suffix for compressed input files.
`static String`	`DATA_PREFIX_PROPERTY` The file prefix for data entries.
`static String`	`DATA_SUFFIX_PROPERTY` The file suffix for data entries.
`static String`	`DEFAULT_COMPRESSED_SUFFIX` Default compressed file suffix.
`static String`	`DEFAULT_DATA_SUFFIX` Default file suffix for data entries.
`static String`	`DEFAULT_DONE_SUFFIX` Default file suffix for done entries.
`static ElapsedTime`	`DEFAULT_SCAN_INTERVAL` Default input directory scan interval.
`static String`	`DONE_PREFIX_PROPERTY` The file prefix for data entries.
`static String`	`DONE_SUFFIX_PROPERTY` The file suffix for done entries.
`static String`	`INPUT_DIR_PROPERTY` The module's input directory.
`static String`	`SCAN_INTERVAL_PROPERTY` The time in millis between scans of the input directory.
`static String`	`SEM_DIR_PROPERTY` Semaphore directory property.
`static String`	`SEM_MATCH_ENABLED_PROPERTY` Semaphore files match enabled property.
`static String`	`SEM_PREFIX_PROPERTY` Semaphore file name prefix property.
`static String`	`SEM_PURGE_ENABLED_PROPERTY` Semaphore files purge enabled property.
`static String`	`SEM_SUFFIX_PROPERTY` The file suffix for semaphore entries.

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

MessagesFilesModule()

Constructors
Constructor and Description
`MessagesFilesModule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 InputModule
getDefaultBatchLimit, getInput, output, run, setInput

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
  - COMPRESSED_SUFFIX_PROPERTY
```
public static final String COMPRESSED_SUFFIX_PROPERTY
```
    The file name suffix for compressed input files.
    
    See Also:
    
    Constant Field Values
  - DATA_PREFIX_PROPERTY
```
public static final String DATA_PREFIX_PROPERTY
```
    The file prefix for data entries.
    
    See Also:
    
    Constant Field Values
  - DATA_SUFFIX_PROPERTY
```
public static final String DATA_SUFFIX_PROPERTY
```
    The file suffix for data entries.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COMPRESSED_SUFFIX
```
public static final String DEFAULT_COMPRESSED_SUFFIX
```
    Default compressed file suffix.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DATA_SUFFIX
```
public static final String DEFAULT_DATA_SUFFIX
```
    Default file suffix for data entries.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DONE_SUFFIX
```
public static final String DEFAULT_DONE_SUFFIX
```
    Default file suffix for done entries.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SCAN_INTERVAL
```
public static final ElapsedTime DEFAULT_SCAN_INTERVAL
```
    Default input directory scan interval.
  - DONE_PREFIX_PROPERTY
```
public static final String DONE_PREFIX_PROPERTY
```
    The file prefix for data entries.
    
    See Also:
    
    Constant Field Values
  - DONE_SUFFIX_PROPERTY
```
public static final String DONE_SUFFIX_PROPERTY
```
    The file suffix for done entries.
    
    See Also:
    
    Constant Field Values
  - INPUT_DIR_PROPERTY
```
public static final String INPUT_DIR_PROPERTY
```
    The module's input directory.
    
    See Also:
    
    Constant Field Values
  - SCAN_INTERVAL_PROPERTY
```
public static final String SCAN_INTERVAL_PROPERTY
```
    The time in millis between scans of the input directory.
    
    See Also:
    
    Constant Field Values
  - SEM_DIR_PROPERTY
```
public static final String SEM_DIR_PROPERTY
```
    Semaphore directory property.
    
    See Also:
    
    Constant Field Values
  - SEM_MATCH_ENABLED_PROPERTY
```
public static final String SEM_MATCH_ENABLED_PROPERTY
```
    Semaphore files match enabled property.
    
    See Also:
    
    Constant Field Values
  - SEM_PREFIX_PROPERTY
```
public static final String SEM_PREFIX_PROPERTY
```
    Semaphore file name prefix property.
    
    See Also:
    
    Constant Field Values
  - SEM_PURGE_ENABLED_PROPERTY
```
public static final String SEM_PURGE_ENABLED_PROPERTY
```
    Semaphore files purge enabled property.
    
    See Also:
    
    Constant Field Values
  - SEM_SUFFIX_PROPERTY
```
public static final String SEM_SUFFIX_PROPERTY
```
    The file suffix for semaphore entries.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MessagesFilesModule
```
public MessagesFilesModule()
```
- Method Detail
  - start
```
public void start()
```
    Starts this module.
    
    Specified by:
    
    start in interface ForwarderModule
    
    Overrides:
    
    start in class InputModule
  - stop
```
public void stop()
```
    Stops this module.
    
    Specified by:
    
    stop in interface ForwarderModule
    
    Overrides:
    
    stop in class InputModule
  - tearDown
```
public void tearDown()
```
    Tears down what has been set up.
    
    Specified by:
    
    tearDown in interface ForwarderModule
    
    Overrides:
    
    tearDown in class InputModule
  - setUp
```
protected boolean setUp(KeyedGroups moduleProperties)
```
    Sets up this module.
    
    Overrides:
    
    setUp in class InputModule
    
    Parameters:
    
    moduleProperties - The module properties.
    
    Returns:
    
    True on success.

Class MessagesFilesModule

Nested Class Summary

Nested classes/interfaces inherited from class InputModule

Nested classes/interfaces inherited from class ForwarderModule.Abstract

Nested classes/interfaces inherited from interface ForwarderModule

Field Summary

Fields inherited from class ForwarderModule.Abstract

Constructor Summary

Method Summary

Methods inherited from class InputModule

Methods inherited from class ForwarderModule.Abstract

Methods inherited from class Object

Field Detail

COMPRESSED_SUFFIX_PROPERTY

DATA_PREFIX_PROPERTY

DATA_SUFFIX_PROPERTY

DEFAULT_COMPRESSED_SUFFIX

DEFAULT_DATA_SUFFIX

DEFAULT_DONE_SUFFIX

DEFAULT_SCAN_INTERVAL

DONE_PREFIX_PROPERTY

DONE_SUFFIX_PROPERTY

INPUT_DIR_PROPERTY

SCAN_INTERVAL_PROPERTY

SEM_DIR_PROPERTY

SEM_MATCH_ENABLED_PROPERTY

SEM_PREFIX_PROPERTY

SEM_PURGE_ENABLED_PROPERTY

SEM_SUFFIX_PROPERTY

Constructor Detail

MessagesFilesModule

Method Detail

start

stop

tearDown

setUp