org.rvpf.base.alert

Class Alert

Object

Alert

All Implemented Interfaces:

Externalizable, Serializable, Mappable

Direct Known Subclasses:

Event, Info, Signal

@ThreadSafe
public abstract class Alert
extends Object
implements Externalizable, Mappable

Alert.

Maintains a set of the forwarders visited for loop detection.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Alert.Dispatcher Alert dispatcher.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTITY_FIELD Entity field key.
static String	INFO_FIELD Info field key.
static String	NAME_FIELD Name field key.
static String	SERVICE_FIELD Service field key.
static String	SOURCE_FIELD Source field key.
static String	STAMP_FIELD Stamp field key.
static String	UUID_FIELD UUID field key.
static String	VISITS_FIELD Visits field key.

Fields inherited from interface Mappable

SERIALIZABLE_MODE, SIMPLE_STRING_MODE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Alert() Constructs an instance.
protected	Alert(String name, Optional<String> sourceServiceName, Optional<String> sourceEntityName, Optional<UUID> sourceUUID, Optional<?> info) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
boolean	addVisit(UUID uuid) Adds a forwarder as visited by this alert.
boolean	equals(Object other)
Optional<String>	getInfo() Gets the additonal informations.
String	getName() Gets this alert's name.
Optional<String>	getSourceEntityName() Gets the name of the source entity generating this alert.
Optional<String>	getSourceServiceName() Gets the service generating this alert.
Optional<UUID>	getSourceUUID() Gets the source's UUID.
DateTime	getStamp() Gets this alert's time stamp.
protected abstract String	getTypeString() Gets a text string for this alert's type.
UUID	getUUID() Gets this alert's UUID.
int	hashCode()
void	readExternal(ObjectInput input)
void	readMap(Map<String,Serializable> map) Reads a map of the fields.
String	toString()
void	writeExternal(ObjectOutput output)
void	writeMap(Map<String,Serializable> map) Writes a map of the fields.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ENTITY_FIELD

public static final String ENTITY_FIELD

Entity field key.

See Also:

Constant Field Values

INFO_FIELD

public static final String INFO_FIELD

Info field key.

See Also:

Constant Field Values

NAME_FIELD

public static final String NAME_FIELD

Name field key.

See Also:

Constant Field Values

SERVICE_FIELD

public static final String SERVICE_FIELD

Service field key.

See Also:

Constant Field Values

SOURCE_FIELD

public static final String SOURCE_FIELD

Source field key.

See Also:

Constant Field Values

STAMP_FIELD

public static final String STAMP_FIELD

Stamp field key.

See Also:

Constant Field Values

UUID_FIELD

public static final String UUID_FIELD

UUID field key.

See Also:

Constant Field Values

VISITS_FIELD

public static final String VISITS_FIELD

Visits field key.

See Also:

Constant Field Values

Constructor Detail

Alert

protected Alert()

Constructs an instance.

This is needed for an externalizable implementation.

Alert

protected Alert(@Nonnull
                String name,
                @Nonnull
                Optional<String> sourceServiceName,
                @Nonnull
                Optional<String> sourceEntityName,
                @Nonnull
                Optional<UUID> sourceUUID,
                @Nonnull
                Optional<?> info)

Constructs an instance.

Parameters:

name - The name of this alert.

sourceServiceName - The optional service generating this alert.

sourceEntityName - The optional name of the entity associated with the source.

sourceUUID - The optional UUID of the source of this alert.

info - Additional optional informations.

Method Detail

addVisit

public final boolean addVisit(@Nonnull
                              UUID uuid)

Adds a forwarder as visited by this alert.

Parameters:

uuid - The UUID of the forwarder.

Returns:

True if the forwarder is a new visit.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getInfo

@Nonnull
 @CheckReturnValue
public final Optional<String> getInfo()

Gets the additonal informations.

Returns:

The additonal informations.

getName

@Nonnull
 @CheckReturnValue
public final String getName()

Gets this alert's name.

Returns:

The alert's name.

getSourceEntityName

@Nonnull
 @CheckReturnValue
public final Optional<String> getSourceEntityName()

Gets the name of the source entity generating this alert.

Returns:

The optional name.

getSourceServiceName

@Nonnull
 @CheckReturnValue
public final Optional<String> getSourceServiceName()

Gets the service generating this alert.

Returns:

The optional service.

getSourceUUID

@Nonnull
 @CheckReturnValue
public final Optional<UUID> getSourceUUID()

Gets the source's UUID.

Returns:

The optional source's UUID.

getStamp

@Nonnull
 @CheckReturnValue
public final DateTime getStamp()

Gets this alert's time stamp.

Returns:

The alert's time stamp.

getUUID

@Nonnull
 @CheckReturnValue
public final UUID getUUID()

Gets this alert's UUID.

Returns:

The alert's UUID.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

readExternal

public void readExternal(ObjectInput input)
                  throws IOException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

readMap

public void readMap(Map<String,Serializable> map)

Reads a map of the fields.

Specified by:

readMap in interface Mappable

Parameters:

map - The source map.

toString

public final String toString()

Overrides:

toString in class Object

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

writeMap

public void writeMap(Map<String,Serializable> map)

Writes a map of the fields.

Specified by:

writeMap in interface Mappable

Parameters:

map - The destination map.

getTypeString

@Nonnull
 @CheckReturnValue
protected abstract String getTypeString()

Gets a text string for this alert's type.

Returns:

The text string for this alert's type.