org.rvpf.base.xml.streamer

Class StreamedMessagesClient

Object

StreamedMessagesWriter

StreamedMessagesClient

@NotThreadSafe
public final class StreamedMessagesClient
extends StreamedMessagesWriter

Streamed messages client.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_SUFFIX_PROPERTY The file suffix for data entries.
static String	DEFAULT_DATA_SUFFIX Default file suffix for data entries.
static String	DEFAULT_TRANS_SUFFIX Default file suffix for transaction entries.
static String	PREFIX_PROPERTY The file name prefix.
static String	TRANS_SUFFIX_PROPERTY The file suffix for transaction entries.

Constructor Summary

Constructors

Constructor and Description
StreamedMessagesClient()

Method Summary

Modifier and Type	Method and Description
boolean	add(Serializable message) Adds a message.
void	close() Closes the current file.
void	commit() Commits the transaction.
void	flush() Flushes the output.
DateTime	getNameStamp() Gets the name stamp.
void	open(File file, Optional<Charset> charset) Opens an output.
void	rollback() Rolls back the transaction.
void	setNameSuffix(Optional<String> nameSuffix) Sets a (file) name suffix.
boolean	setUp(File directory, KeyedGroups configProperties, KeyedValues moduleProperties) Sets up this.
boolean	setUp(Optional<KeyedGroups> configProperties, Optional<KeyedValues> moduleProperties) Sets up this.
void	tearDown() Tears down what has been set up.

Methods inherited from class StreamedMessagesWriter

open, open, open

Methods inherited from class Object

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

Field Detail

DATA_SUFFIX_PROPERTY

public static final String DATA_SUFFIX_PROPERTY

The file suffix for data entries.

See Also:

Constant Field Values

DEFAULT_DATA_SUFFIX

public static final String DEFAULT_DATA_SUFFIX

Default file suffix for data entries.

See Also:

Constant Field Values

DEFAULT_TRANS_SUFFIX

public static final String DEFAULT_TRANS_SUFFIX

Default file suffix for transaction entries.

See Also:

Constant Field Values

PREFIX_PROPERTY

public static final String PREFIX_PROPERTY

The file name prefix.

See Also:

Constant Field Values

TRANS_SUFFIX_PROPERTY

public static final String TRANS_SUFFIX_PROPERTY

The file suffix for transaction entries.

See Also:

Constant Field Values

Constructor Detail

StreamedMessagesClient

public StreamedMessagesClient()

Method Detail

add

public boolean add(Serializable message)

Adds a message.

Overrides:

add in class StreamedMessagesWriter

Parameters:

message - The message.

Returns:

True value on success.

close

public void close()

Closes the current file.

Overrides:

close in class StreamedMessagesWriter

commit

public void commit()

Commits the transaction.

flush

public void flush()

Flushes the output.

Overrides:

flush in class StreamedMessagesWriter

getNameStamp

@Nonnull
 @CheckReturnValue
public DateTime getNameStamp()

Gets the name stamp.

Returns:

The name stamp.

open

public void open(File file,
                 Optional<Charset> charset)

Opens an output.

Overrides:

open in class StreamedMessagesWriter

Parameters:

file - The output file.

charset - An optional charset.

rollback

public void rollback()

Rolls back the transaction.

setNameSuffix

public void setNameSuffix(@Nonnull
                          Optional<String> nameSuffix)
                   throws Require.FailureException

Sets a (file) name suffix.

Parameters:

nameSuffix - The optional (file) name suffix.

Throws:

Require.FailureException - When a transaction is active.

setUp

@CheckReturnValue
public boolean setUp(@Nonnull
                                        File directory,
                                        @Nonnull
                                        KeyedGroups configProperties,
                                        @Nonnull
                                        KeyedValues moduleProperties)

Sets up this.

Parameters:

directory - The transactions directory.

configProperties - Configuration properties (may be null).

moduleProperties - Module properties (may be null).

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.

Overrides:

tearDown in class StreamedMessagesWriter

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.