org.rvpf.forwarder.input.pap

Class PAPModule

Object

ForwarderModule.Abstract

InputModule

PAPModule

All Implemented Interfaces:

ForwarderModule, ServiceThread.Target

Direct Known Subclasses:

DNP3Module, ModbusModule

public abstract class PAPModule
extends InputModule

PAP module.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PAPModule.PAPInput PAP input.

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

Method Summary

Modifier and Type	Method and Description
protected boolean	loadMetadata() Loads the metadata.
boolean	needsMetadata()
protected abstract PAPModule.PAPInput	newInput(PAPServer server) Returns a new PAP input for a PAP server.
protected abstract PAPSupport	newSupport() Returns a new support instance.
boolean	onMetadataRefreshed()
protected abstract KeyedGroups	protocolProperties(KeyedGroups moduleProperties) Returns protocol properties.
protected boolean	setUp(KeyedGroups moduleProperties)
protected abstract String	usage() Returns the attributes usage.

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

Constructor Detail

PAPModule

public PAPModule()

Method Detail

needsMetadata

public boolean needsMetadata()

Specified by:

needsMetadata in interface ForwarderModule

Overrides:

needsMetadata in class ForwarderModule.Abstract

onMetadataRefreshed

public boolean onMetadataRefreshed()

Specified by:

onMetadataRefreshed in interface ForwarderModule

Overrides:

onMetadataRefreshed in class ForwarderModule.Abstract

loadMetadata

@CheckReturnValue
protected boolean loadMetadata()

Loads the metadata.

Returns:

True on success.

newInput

@Nonnull
 @CheckReturnValue
protected abstract PAPModule.PAPInput newInput(@Nonnull
                                                                             PAPServer server)

Returns a new PAP input for a PAP server.

Parameters:

server - The PAP server.

Returns:

The new PAP input.

newSupport

@Nonnull
 @CheckReturnValue
protected abstract PAPSupport newSupport()

Returns a new support instance.

Returns:

The new support instance.

protocolProperties

@Nonnull
 @CheckReturnValue
protected abstract KeyedGroups protocolProperties(@Nonnull
                                                                                KeyedGroups moduleProperties)

Returns protocol properties.

Parameters:

moduleProperties - The module properties.

Returns:

The protocol properties.

setUp

protected boolean setUp(KeyedGroups moduleProperties)

Overrides:

setUp in class InputModule

usage

@Nonnull
 @CheckReturnValue
protected abstract String usage()

Returns the attributes usage.

Returns:

The attributes usage.