org.rvpf.base.xml.streamer

Class XMLPointValuesPortClient

Object

StreamedMessagesPortClient

XMLPointValuesPortClient

@NotThreadSafe
public final class XMLPointValuesPortClient
extends StreamedMessagesPortClient

XML point values port client.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DELETED_STATE Deleted state.

Fields inherited from class StreamedMessagesPortClient

CLIENT_ATTRIBUTE, DONE_ELEMENT, EXCEPTION_ATTRIBUTE, FAILED_ELEMENT, FLUSH_ATTRIBUTE, FLUSH_ELEMENT, ID_ATTRIBUTE, LOGIN_ELEMENT, MESSAGES_ELEMENT, PASSWORD_ATTRIBUTE, REF_ATTRIBUTE, USER_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
XMLPointValuesPortClient(String client) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
void	open(String addressString, Optional<SecurityContext> securityContext) Opens a connection to the XML Port.
void	sendValue(PointValue pointValue) Sends a point value.
void	sendValue(String point, String stamp, Optional<String> state, Optional<String> value) Sends a point value.
boolean	setUp(Optional<KeyedGroups> configProperties, Optional<KeyedValues> moduleProperties) Sets up this.
void	tearDown() Tears down what has been set up.

Methods inherited from class StreamedMessagesPortClient

addMessage, flush, isOpen, login, login, sendMessages

Methods inherited from class Object

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

Field Detail

DELETED_STATE

public static final String DELETED_STATE

Deleted state.

See Also:

Constant Field Values

Constructor Detail

XMLPointValuesPortClient

public XMLPointValuesPortClient(@Nonnull
                                String client)

Constructs an instance.

Parameters:

client - The client identification.

Method Detail

close

public void close()

Closes the connection.

Overrides:

close in class StreamedMessagesPortClient

open

public void open(String addressString,
                 Optional<SecurityContext> securityContext)
          throws ServiceNotAvailableException

Opens a connection to the XML Port.

Overrides:

open in class StreamedMessagesPortClient

Parameters:

addressString - The address for the port (host:port).

securityContext - An optional security context.

Throws:

ServiceNotAvailableException - When the service is not available.

sendValue

public void sendValue(@Nonnull
                      PointValue pointValue)
               throws IOException

Sends a point value.

Parameters:

pointValue - The point value.

Throws:

IOException - When appropriate.

sendValue

public void sendValue(@Nonnull
                      String point,
                      @Nonnull
                      String stamp,
                      @Nonnull
                      Optional<String> state,
                      @Nonnull
                      Optional<String> value)
               throws IOException

Sends a point value.

Parameters:

point - The point name.

stamp - The time stamp.

state - The optional value state.

value - The optional value.

Throws:

IOException - When appropriate.

setUp

@CheckReturnValue
public boolean setUp(@Nonnull
                                        Optional<KeyedGroups> configProperties,
                                        @Nonnull
                                        Optional<KeyedValues> moduleProperties)

Sets up this.

Parameters:

configProperties - The optional configuration properties.

moduleProperties - The optional module properties.

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.