Class LogEvent

java.lang.Object

com.soklet.LogEvent

@ThreadSafe
public final class LogEvent
extends Object

An informational "loggable" event that occurs during Soklet's internal processing - for example, if an error occurs while handling a request.

These events are exposed via LifecycleInterceptor.didReceiveLogEvent(LogEvent).

Instances can be acquired via the with(LogEventType, String) builder factory method.

Documentation is available at https://www.soklet.com/docs/request-lifecycle#event-logging.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LogEvent.Builder	Builder used to construct instances of LogEvent via with(LogEventType, String).
static final class	LogEvent.Copier	Builder used to copy instances of LogEvent via copy().

Method Summary

Modifier and Type	Method	Description
LogEvent.Copier	copy()	Vends a mutable copier seeded with this instance's data, suitable for building new instances.
boolean	equals(Object object)
LogEventType	getLogEventType()	The type of log event this is.
Optional<MarshaledResponse>	getMarshaledResponse()	The response associated with this log event, if available.
String	getMessage()	The message for this log event.
Optional<Request>	getRequest()	The request associated with this log event, if available.
Optional<ResourceMethod>	getResourceMethod()	The Resource Method associated with this log event, if available.
Optional<Throwable>	getThrowable()	The throwable for this log event, if available.
int	hashCode()
String	toString()
static LogEvent.Builder	with(LogEventType logEventType, String message)	Acquires a builder for LogEvent instances.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

with

@Nonnull
public static LogEvent.Builder with(@Nonnull
 LogEventType logEventType,
 @Nonnull
 String message)

Acquires a builder for LogEvent instances.

Parameters:

logEventType - what kind of log event this is

message - the message for this log event

Returns:

the builder

copy

@Nonnull
public LogEvent.Copier copy()

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

Returns:

a copier for this instance

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable
 Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getLogEventType

@Nonnull
public LogEventType getLogEventType()

The type of log event this is.

Returns:

the log event type

getMessage

@Nonnull
public String getMessage()

The message for this log event.

Returns:

the message

getThrowable

@Nonnull
public Optional<Throwable> getThrowable()

The throwable for this log event, if available.

Returns:

the throwable, or Optional.empty() if not available

getRequest

@Nonnull
public Optional<Request> getRequest()

The request associated with this log event, if available.

Returns:

the request, or Optional.empty() if not available

getResourceMethod

@Nonnull
public Optional<ResourceMethod> getResourceMethod()

The Resource Method associated with this log event, if available.

Returns:

the Resource Method, or Optional.empty() if not available

getMarshaledResponse

@Nonnull
public Optional<MarshaledResponse> getMarshaledResponse()

The response associated with this log event, if available.

Returns:

the response, or Optional.empty() if not available