Package net.tangly.commons.logger

Record Class EventData

java.lang.Object

java.lang.Record

net.tangly.commons.logger.EventData

Record Components:

event - event triggering the creation of an audit log

timestamp - timestamp when the audit log was created

component - component source of the audit log. By convention, we use the module name or if necessary the package name

status - status associated with the audit log

text - text of the audit log. It should be English and provide a concise description of the event

data - data specific to the audit log

exception - optional exception to be added to the audit log

public record EventData(@NotNull String event, @NotNull LocalDateTime timestamp, @NotNull String component, @NotNull EventData.Status status, String text, @NotNull Map<String,Object> data, Throwable exception)
extends Record

Provide a simple approach to create an audit trail for all relevant operations performed in the system. Contextual information such as user, IP address are part of the MDR context and implicitly available to the event data logging process.

Good practice is to log all incoming and outgoing data. The granularity should be an aggregate as defined in the domain-driven design approach. The goal is provide an audit trail for all relevant input and output operations performed in the system.

Statuses are:

Success

A complex operation was completed successfully. For example all entities of a TSV file could be imported.

Info

Status information of a completed system activity. For example one entity of a TSV file could be imported.

Warning

The operation encountered a problem but the data could be processed.

Error

The data could not be processed due to syntactic or semantic errors.

Failure

The operation failed due to an internal or resource problem. For example the file could be found or read.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EventData.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENTITY
static final String	EXPORT
static final String	FILENAME
static final String	IMPORT

Constructor Summary

Constructors

Constructor	Description
EventData(@NotNull String event, @NotNull LocalDateTime timestamp, @NotNull String component, @NotNull EventData.Status status, String text, @NotNull Map<String,Object> data, Throwable exception)	Creates an instance of a EventData record class.

Method Summary

Modifier and Type	Method	Description
@NotNull String	component()	Returns the value of the component record component.
@NotNull Map<String,Object>	data()	Returns the value of the data record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull String	event()	Returns the value of the event record component.
Throwable	exception()	Returns the value of the exception record component.
final int	hashCode()	Returns a hash code value for this object.
static void	log(@NotNull String event, @NotNull String component, @NotNull EventData.Status status, String reason, @NotNull Map<String,Object> data)
static void	log(@NotNull String event, @NotNull String component, @NotNull EventData.Status status, String reason, @NotNull Map<String,Object> data, Throwable exception)
static void	log(@NotNull EventData data)	Log the event data as audit log.
@NotNull EventData.Status	status()	Returns the value of the status record component.
String	text()	Returns the value of the text record component.
@NotNull LocalDateTime	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

IMPORT

public static final String IMPORT

See Also:

• Constant Field Values

EXPORT

public static final String EXPORT

See Also:

• Constant Field Values

FILENAME

public static final String FILENAME

See Also:

• Constant Field Values

ENTITY

public static final String ENTITY

See Also:

• Constant Field Values

Constructor Details

EventData

public EventData(@NotNull
 @NotNull String event,
 @NotNull
 @NotNull LocalDateTime timestamp,
 @NotNull
 @NotNull String component,
 @NotNull
 @NotNull EventData.Status status,
 String text,
 @NotNull
 @NotNull Map<String,Object> data,
 Throwable exception)

Creates an instance of a EventData record class.

Parameters:

event - the value for the event record component

timestamp - the value for the timestamp record component

component - the value for the component record component

status - the value for the status record component

text - the value for the text record component

data - the value for the data record component

exception - the value for the exception record component

Method Details

log

public static void log(@NotNull
 @NotNull String event,
 @NotNull
 @NotNull String component,
 @NotNull
 @NotNull EventData.Status status,
 String reason,
 @NotNull
 @NotNull Map<String,Object> data)

log

public static void log(@NotNull
 @NotNull String event,
 @NotNull
 @NotNull String component,
 @NotNull
 @NotNull EventData.Status status,
 String reason,
 @NotNull
 @NotNull Map<String,Object> data,
 Throwable exception)

log

public static void log(@NotNull
 @NotNull EventData data)

Log the event data as audit log.

Parameters:

data - event data to add to the audit trail

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

event

@NotNull
public @NotNull String event()

Returns the value of the event record component.

Returns:

the value of the event record component

timestamp

@NotNull
public @NotNull LocalDateTime timestamp()

Returns the value of the timestamp record component.

Returns:

the value of the timestamp record component

component

@NotNull
public @NotNull String component()

Returns the value of the component record component.

Returns:

the value of the component record component

status

@NotNull
public @NotNull EventData.Status status()

Returns the value of the status record component.

Returns:

the value of the status record component

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component

data

@NotNull
public @NotNull Map<String,Object> data()

Returns the value of the data record component.

Returns:

the value of the data record component

exception

public Throwable exception()

Returns the value of the exception record component.

Returns:

the value of the exception record component