org.rvpf.base.tool

Class Traces

Object

Traces

@ThreadSafe
public final class Traces
extends Object

Traces.

Adds entries to a traces file. Each entry tells the time the entry was added, then the description of a value. Each service using traces has a dedicated directory. Within that directory, individual directories are used to segregate entries by category, traces for each category. Within these directories, a new traces file is created each day.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Traces.Context Context.
static interface	Traces.Listener Tracer listener.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPRESSED_PROPERTY Requests that the service traces be compressed.
static String	COMPRESSED_SUFFIX_PROPERTY The file name suffix for compressed traces files.
static String	DEFAULT_COMPRESSED_SUFFIX Default compressed file suffix.
static String	DEFAULT_PREFIX Default traces prefix.
static String	DEFAULT_ROOT Default traces root directory.
static String	DEFAULT_SUFFIX Default traces suffix.
static String	DIR_PROPERTY The directory name for the service traces.
static String	DISABLED_PROPERTY Disables the service traces.
static String	PREFIX_PROPERTY The file name prefix for traces files.
static String	ROOT_PROPERTY The root directory for the service traces.
static String	SUFFIX_PROPERTY The file name suffix for traces files.
static String	TRACES_PROPERTIES Traces properties.

Constructor Summary

Constructors

Constructor and Description
Traces() Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	add(Object value) Adds a value to the traces.
void	add(Optional<String> classifier, Object value) Adds a value to the traces.
boolean	addListener(Traces.Listener listener) Adds a listener for this.
void	commit() Commits the accumulated entries to file.
boolean	isEnabled() Asks if this is enabled.
boolean	removeListener(Traces.Listener listener) Removes a listener for this.
void	rollback() Forgets about the accumulated entries.
void	setCompressed(boolean compressed) Sets the compressed files indicator.
void	setPrefix(String prefix) Sets the prefix for the traces files.
void	setSuffix(String suffix) Sets the suffix for the traces files.
boolean	setUp(File where, KeyedGroups how, UUID who, Optional<String> what) 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

COMPRESSED_PROPERTY

public static final String COMPRESSED_PROPERTY

Requests that the service traces be compressed.

See Also:

Constant Field Values

COMPRESSED_SUFFIX_PROPERTY

public static final String COMPRESSED_SUFFIX_PROPERTY

The file name suffix for compressed traces files.

See Also:

Constant Field Values

DEFAULT_COMPRESSED_SUFFIX

public static final String DEFAULT_COMPRESSED_SUFFIX

Default compressed file suffix.

See Also:

Constant Field Values

DEFAULT_PREFIX

public static final String DEFAULT_PREFIX

Default traces prefix.

See Also:

Constant Field Values

DEFAULT_ROOT

public static final String DEFAULT_ROOT

Default traces root directory.

See Also:

Constant Field Values

DEFAULT_SUFFIX

public static final String DEFAULT_SUFFIX

Default traces suffix.

See Also:

Constant Field Values

DIR_PROPERTY

public static final String DIR_PROPERTY

The directory name for the service traces.

See Also:

Constant Field Values

DISABLED_PROPERTY

public static final String DISABLED_PROPERTY

Disables the service traces.

See Also:

Constant Field Values

PREFIX_PROPERTY

public static final String PREFIX_PROPERTY

The file name prefix for traces files.

See Also:

Constant Field Values

ROOT_PROPERTY

public static final String ROOT_PROPERTY

The root directory for the service traces. It can be specified as a relative or absolute path.

See Also:

Constant Field Values

SUFFIX_PROPERTY

public static final String SUFFIX_PROPERTY

The file name suffix for traces files.

See Also:

Constant Field Values

TRACES_PROPERTIES

public static final String TRACES_PROPERTIES

Traces properties.

See Also:

Constant Field Values

Constructor Detail

Traces

public Traces()

Constructs an instance.

Method Detail

add

public void add(@Nonnull
                Object value)

Adds a value to the traces.

Parameters:

value - The value.

add

public void add(@Nonnull
                Optional<String> classifier,
                @Nonnull
                Object value)

Adds a value to the traces.

Parameters:

classifier - An optional classifier.

value - The value.

addListener

@CheckReturnValue
public boolean addListener(@Nonnull
                                              Traces.Listener listener)

Adds a listener for this.

Parameters:

listener - The listener.

Returns:

True unless already added.

commit

public void commit()

Commits the accumulated entries to file.

isEnabled

@CheckReturnValue
public boolean isEnabled()

Asks if this is enabled.

Returns:

True if enabled.

removeListener

@CheckReturnValue
public boolean removeListener(@Nonnull
                                                 Traces.Listener listener)

Removes a listener for this.

Parameters:

listener - The listener.

Returns:

True if it was present.

rollback

public void rollback()

Forgets about the accumulated entries.

setCompressed

public void setCompressed(boolean compressed)

Sets the compressed files indicator.

Parameters:

compressed - The compressed files indicator.

setPrefix

public void setPrefix(@Nonnull
                      String prefix)

Sets the prefix for the traces files.

Parameters:

prefix - The prefix.

setSuffix

public void setSuffix(@Nonnull
                      String suffix)

Sets the suffix for the traces files.

Parameters:

suffix - The suffix.

setUp

@CheckReturnValue
public boolean setUp(@Nonnull
                                        File where,
                                        @Nonnull
                                        KeyedGroups how,
                                        @Nonnull
                                        UUID who,
                                        @Nonnull
                                        Optional<String> what)

Sets up this.

Parameters:

where - The destination's parent directory (data directory).

how - The traces properties.

who - Who is tracing (used as default directory name).

what - What will be traced (subdirectory).

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.