org.rvpf.base.xml.streamer

Class StreamedMessagesPortClient

Object

StreamedMessagesPortClient

Direct Known Subclasses:

XMLPointValuesPortClient

@NotThreadSafe
public class StreamedMessagesPortClient
extends Object

Streamed messages port client.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_ATTRIBUTE Client attribute.
static String	DONE_ELEMENT Done element name.
static String	EXCEPTION_ATTRIBUTE Exception attribute name.
static String	FAILED_ELEMENT Failed element name.
static String	FLUSH_ATTRIBUTE Flush attribute name.
static String	FLUSH_ELEMENT Flush element name.
static String	ID_ATTRIBUTE ID attribute.
static String	LOGIN_ELEMENT Login element name.
static String	MESSAGES_ELEMENT Messages element name.
static String	PASSWORD_ATTRIBUTE Password attribute.
static String	REF_ATTRIBUTE REF attribute.
static String	USER_ATTRIBUTE User attribute.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addMessage(Serializable message) Adds a message.
void	close() Closes the connection.
void	flush() Flushes pending entries.
boolean	isOpen() Asks if this is open.
void	login(LoginInfo loginInfo) Logs in.
void	login(Optional<String> user, Optional<char[]> password) Logs in.
void	open(String addressString, Optional<SecurityContext> securityContext) Opens a connection to the XML Port.
void	sendMessages(boolean flush) Sends messages.
boolean	setUp(Optional<KeyedGroups> configProperties, Optional<KeyedValues> moduleProperties) Sets up this.
void	tearDown() Tears down what has been set up.

Methods inherited from class Object

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

Field Detail

CLIENT_ATTRIBUTE

public static final String CLIENT_ATTRIBUTE

Client attribute.

See Also:

Constant Field Values

DONE_ELEMENT

public static final String DONE_ELEMENT

Done element name.

See Also:

Constant Field Values

EXCEPTION_ATTRIBUTE

public static final String EXCEPTION_ATTRIBUTE

Exception attribute name.

See Also:

Constant Field Values

FAILED_ELEMENT

public static final String FAILED_ELEMENT

Failed element name.

See Also:

Constant Field Values

FLUSH_ATTRIBUTE

public static final String FLUSH_ATTRIBUTE

Flush attribute name.

See Also:

Constant Field Values

FLUSH_ELEMENT

public static final String FLUSH_ELEMENT

Flush element name.

See Also:

Constant Field Values

ID_ATTRIBUTE

public static final String ID_ATTRIBUTE

ID attribute.

See Also:

Constant Field Values

LOGIN_ELEMENT

public static final String LOGIN_ELEMENT

Login element name.

See Also:

Constant Field Values

MESSAGES_ELEMENT

public static final String MESSAGES_ELEMENT

Messages element name.

See Also:

Constant Field Values

PASSWORD_ATTRIBUTE

public static final String PASSWORD_ATTRIBUTE

Password attribute.

See Also:

Constant Field Values

REF_ATTRIBUTE

public static final String REF_ATTRIBUTE

REF attribute.

See Also:

Constant Field Values

USER_ATTRIBUTE

public static final String USER_ATTRIBUTE

User attribute.

See Also:

Constant Field Values

Constructor Detail

StreamedMessagesPortClient

public StreamedMessagesPortClient(@Nonnull
                                  String client)

Constructs an instance.

Parameters:

client - The client identification.

Method Detail

addMessage

public void addMessage(@Nonnull
                       Serializable message)

Adds a message.

Parameters:

message - The message.

close

public void close()

Closes the connection.

flush

public void flush()
           throws ServiceNotAvailableException

Flushes pending entries.

Throws:

ServiceNotAvailableException - When the service is not available.

isOpen

@CheckReturnValue
public boolean isOpen()

Asks if this is open.

Returns:

True if this is open.

login

public void login(@Nonnull
                  LoginInfo loginInfo)
           throws ServiceNotAvailableException

Logs in.

Parameters:

loginInfo - The login info.

Throws:

ServiceNotAvailableException - When the service is not available.

login

public void login(@Nonnull
                  Optional<String> user,
                  @Nonnull
                  Optional<char[]> password)
           throws ServiceNotAvailableException

Logs in.

Parameters:

user - The optional user.

password - The optional password.

Throws:

ServiceNotAvailableException - When the service is not available.

open

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

Opens a connection to the XML Port.

Parameters:

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

securityContext - An optional security context.

Throws:

ServiceNotAvailableException - When the service is not available.

sendMessages

public void sendMessages(boolean flush)
                  throws ServiceNotAvailableException

Sends messages.

Parameters:

flush - True asks for a flush.

Throws:

ServiceNotAvailableException - When the service is not available.

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.