Class FrozenLogEvent

java.lang.Object

org.jpos.util.LogEvent

org.jpos.util.FrozenLogEvent

All Implemented Interfaces:

Serializable

public class FrozenLogEvent
extends LogEvent
implements Serializable

An immutable, serializable snapshot of a LogEvent.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FrozenLogEvent(String frozen)	Creates a FrozenLogEvent from a pre-rendered string.
FrozenLogEvent(LogEvent evt)	Creates a FrozenLogEvent by capturing the current dump of the given LogEvent.

Method Summary

Modifier and Type	Method	Description
void	dump(PrintStream ps, String indent)	Dumps the full log event to the given PrintStream.
String	toString()	Renders this event to a string with no leading indent.

Methods inherited from class LogEvent

add, addMessage, addMessage, dumpHeader, dumpTrailer, getCreatedAt, getDumpedAt, getPayLoad, getRealm, getSource, getTag, getTags, getTraceId, hasException, isHonorSourceLogger, setNoArmor, setSource, setTag, toString, withSource, withTag, withTags, withTraceId, withTraceId, withTraceId

Modifier and Type	Method	Description
LogEvent	add(Object o)	Appends a payload entry and returns this event for chaining.
void	addMessage(Object msg)	Adds a message or object to this event's payload.
void	addMessage(String tagname, String message)	Adds a message wrapped in an XML tag to this event's payload.
protected String	dumpHeader(PrintStream p, String indent)	Writes the log event header to the given PrintStream.
protected void	dumpTrailer(PrintStream p, String indent)	Writes the log event trailer to the given PrintStream.
Instant	getCreatedAt()	Returns the time at which this event was constructed.
Instant	getDumpedAt()	Returns the time at which this event was first dumped, capturing it on first call.
List<Object>	getPayLoad()	WARNING: payLoad is a SynchronizedList.
String	getRealm()	Returns the realm of the associated source, or empty when no source is set.
LogSource	getSource()	Returns the LogSource associated with this event, if any.
String	getTag()	Returns the log tag.
Map<String,String>	getTags()	Returns an unmodifiable view of this event's tags.
String	getTraceId()	Returns the current trace-id, generating one if absent.
boolean	hasException()	Indicates whether the payload contains a Throwable.
boolean	isHonorSourceLogger()	This is a hack for backward compatibility after accepting PR67
void	setNoArmor(boolean noArmor)	Controls whether the XML wrapper is suppressed in log output.
void	setSource(LogSource source)	Replaces the LogSource associated with this event.
void	setTag(String tag)	Sets the log tag for this event.
String	toString(String indent)	Renders this event to a string with the given indent prefix.
LogEvent	withSource(LogSource source)	Sets the LogSource associated with this event and returns it for chaining.
LogEvent	withTag(String key, String value)	Adds or overwrites a tag on this event.
LogEvent	withTags(Map<String,String> map)	Adds the supplied tags to this event.
LogEvent	withTraceId()	Ensures a trace-id tag is present, generating one if needed.
LogEvent	withTraceId(String traceId)	Sets the trace-id tag explicitly.
LogEvent	withTraceId(UUID uuid)	Sets the trace-id tag from a UUID (dashes stripped).

Methods inherited from class Object

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

Constructor Details

FrozenLogEvent

public FrozenLogEvent(String frozen)

Creates a FrozenLogEvent from a pre-rendered string.

Parameters:

frozen - the pre-rendered log event string

FrozenLogEvent

public FrozenLogEvent(LogEvent evt)

Creates a FrozenLogEvent by capturing the current dump of the given LogEvent.

Parameters:

evt - the LogEvent to freeze

Method Details

dump

public void dump(PrintStream ps,
 String indent)

Description copied from class: LogEvent

Dumps the full log event to the given PrintStream.

Overrides:

dump in class LogEvent

Parameters:

ps - the PrintStream to dump to

indent - the outer indentation string

toString

public String toString()

Description copied from class: LogEvent

Renders this event to a string with no leading indent.

Overrides:

toString in class LogEvent

Returns:

string rendering of this event