com.esf.protocol.fielddevice.service

Interface IProtocolDeviceAcquisitionService

public interface IProtocolDeviceAcquisitionService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SERVICE_NAME Reports the class name representing this interface.

Method Summary

Methods

Modifier and Type	Method and Description
ProtocolDevice	getProtocolDevice(java.lang.String protocol) Gets the desired protocol interface if available.
ProtocolDevice	getProtocolDevice(java.lang.String protocol, java.util.Properties configureProtocol, java.util.Properties configureConnection, java.util.Properties configureDataMap) Gets the desired protocol interface if available and configures the interface.

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

Reports the class name representing this interface.

Method Detail

getProtocolDevice

ProtocolDevice getProtocolDevice(java.lang.String protocol)
                                 throws ProtocolNotAvailableException

Gets the desired protocol interface if available. Search all installed field device protocols for a name matching the protocol.

Parameters:

protocol - 'toString' name of desired protocol

Returns:

ProtocolDevice implementation of the selected protocol, ready to connect and use

Throws:

ProtocolNotAvailableException - the selected protocol is not installed in this system

getProtocolDevice

ProtocolDevice getProtocolDevice(java.lang.String protocol,
                               java.util.Properties configureProtocol,
                               java.util.Properties configureConnection,
                               java.util.Properties configureDataMap)
                                 throws ProtocolNotAvailableException,
                                        ProtocolConfigurationInvalidException

Gets the desired protocol interface if available and configures the interface. Search all installed field device protocols for a name matching the protocol, if found then attempt to configure the protocol.

Parameters:

protocol - 'toString' name of desired protocol

configureProtocol - key/value paring directly from configuration file or may be generated.

configureConnection - key/value paring directly from configuration file or may be generated.

configureDataMap - key/value paring directly from configuration file or may be generated. Not all protocols require this configuration, this Dictionary may be null. If the selected protocol does require this configuration, a null Dictionary will cause the protocol to not configure and will throw a ProtocolConfigurationInvalidException.

Returns:

ProtocolDevice implementation of the selected protocol, ready to connect and use

Throws:

ProtocolNotAvailableException - the selected protocol is not installed in this system

ProtocolConfigurationInvalidException - one of the configurations is invalid or a required configuration is missing