javax.microedition.ipdr.configuration
Interface ExporterConfig

public interface ExporterConfig

This interface provides the configuration of the exporter.

ETA defines that at least one implementation must be implemented by the ETA implementer. The required implementation takes all the information from the JAD/manifest

Version:

1.0

Author:

Shai Gotlib

Method Summary

CollectorConfig	findCollector(java.lang.String identifier) Returns collector configuration by identifier
SessionConfig	findSession(byte id) Returns the session configuration
TemplateConfig	findTemplate(short id) Locates template configuration by given template id
int	getAckSequenceInterval() Returns the data acknowledge message window size.
int	getAckTimeInterval() Returns the data acknowledge time interval.
boolean	getCapabilitesTemplateNegotiation() Indicates whether the exporter should support template negotiation (true if template negotiaton is supported)
boolean	getCapabilitiesMultiSession() Indicates whether multiple sessions over same connection are supported (true if multiple sessions are supported)
boolean	getCapabilitiesStructures() Indicates whether structured templates are supported
java.util.Enumeration	getCollectorList() Returns enumeration of collector configuration (the availble collectors).
long	getControllerQueryInterval() Returns the controller query interval between retry request to connect or to start session
java.lang.String	getExporterHost() Returns the exporter host in IPv4 "dotted decimal notation".
java.lang.String	getExporterIdentifier() Returns the Exporter identifier in IPv4 "dotted decimal notation".
int	getExporterProtocolVersion() Returns exporter's supported protocol version (1 for CRANE, 2 for IPDR)
boolean	getExporterSupportDiscovery() Return true if discovery is supported (UDP-based discovery as defined in the IPDR/SP) and false otherwise
int	getLocalPort() Returns local port to listen for incoming connections
int	getReceiveBufferSize() Returns default receive buffer size for the TCP layer
java.util.Enumeration	getSessionList() Returns enumeration of session configuration.
int	getUDPDiscoveryPort() Returns UDP port to listen for incoming discovery requests on.
int	getUDPDiscoveryTimeout() Returns UDP discovery timeout value.
java.lang.String	getVendorId() Returns vendor identifier

Method Detail

getExporterIdentifier

public java.lang.String getExporterIdentifier()

Returns the Exporter identifier in IPv4 "dotted decimal notation".

Returns:

the Exporter identifier in IPv4 "dotted decimal notation" (String)

getExporterHost

public java.lang.String getExporterHost()

Returns the exporter host in IPv4 "dotted decimal notation".

Returns:

the exporter host in IPv4 "dotted decimal notation" (String)

getExporterSupportDiscovery

public boolean getExporterSupportDiscovery()

Return true if discovery is supported (UDP-based discovery as defined in the IPDR/SP) and false otherwise

Returns:

true if discovery is supported (UDP-based discovery) and false otherwise (boolean)

getExporterProtocolVersion

public int getExporterProtocolVersion()

Returns exporter's supported protocol version (1 for CRANE, 2 for IPDR)

Returns:

exporter's supported protocol version (1 for CRANE, 2 for IPDR) (int)

getReceiveBufferSize

public int getReceiveBufferSize()

Returns default receive buffer size for the TCP layer

Returns:

default receive buffer size for the TCP layer (int)

getCapabilitiesStructures

public boolean getCapabilitiesStructures()

Indicates whether structured templates are supported

Returns:

false always (for future use)

getCapabilitiesMultiSession

public boolean getCapabilitiesMultiSession()

Indicates whether multiple sessions over same connection are supported (true if multiple sessions are supported)

Returns:

true if multiple sessions are supported false otherwise (boolean)

getCapabilitesTemplateNegotiation

public boolean getCapabilitesTemplateNegotiation()

Indicates whether the exporter should support template negotiation (true if template negotiaton is supported)

Returns:

true if template negotiaton is supported false otherwise (boolean)

getVendorId

public java.lang.String getVendorId()

Returns vendor identifier

Returns:

vendor id (String)

getCollectorList

public java.util.Enumeration getCollectorList()

Returns enumeration of collector configuration (the availble collectors).

Returns:

Enumeration of CollectorConfig

See Also:

CollectorConfig, CollectorConfig

findCollector

public CollectorConfig findCollector(java.lang.String identifier)

Returns collector configuration by identifier

Parameters:

identifier - collector identifier

Returns:

CollectorConfig according to its identifier

getLocalPort

public int getLocalPort()

Returns local port to listen for incoming connections

Returns:

the local port to listen for incoming connections (int)

findTemplate

public TemplateConfig findTemplate(short id)

Locates template configuration by given template id

Parameters:

id - to find template by it

Returns:

TemplateConfig with the given id

See Also:

TemplateConfig

getUDPDiscoveryPort

public int getUDPDiscoveryPort()

Returns UDP port to listen for incoming discovery requests on.

Returns:

UDP port to listen for incoming discovery requests on (int)

getUDPDiscoveryTimeout

public int getUDPDiscoveryTimeout()

Returns UDP discovery timeout value. After discovery timeoutis over, the exporter concludes that the collector does not support UDP-based discovery

Returns:

UDP discovery timeout value (int)

getControllerQueryInterval

public long getControllerQueryInterval()

Returns the controller query interval between retry request to connect or to start session

Returns:

the controller query interval in seconds

See Also:

ConnectionController

getAckTimeInterval

public int getAckTimeInterval()

Returns the data acknowledge time interval. this parameter will be send to the collection system in session start message. If Exporeter will not get data ack during this interval it can consider it as connection problems.

Returns:

the data acknowledge time interval (int)

getAckSequenceInterval

public int getAckSequenceInterval()

Returns the data acknowledge message window size. in othe words, how many data messages could be ack together

Returns:

the data acknowledge message sequence interval (int)

getSessionList

public java.util.Enumeration getSessionList()

Returns enumeration of session configuration.

Returns:

Enumeration of SessionConfig

See Also:

javax.microedition.events.ipdr.configuration.SessionConfig

findSession

public SessionConfig findSession(byte id)

Returns the session configuration

Parameters:

id - th session id

Returns:

SessionConfig according to its id (null if it not part of the configuration)

See Also:

SessionConfig