com.hazelcast.internal.auditlog

Interface EventBuilder<T extends EventBuilder<T>>

Type Parameters:

T - builder type

All Known Implementing Classes:

NoOpAuditlogService.Builder

public interface EventBuilder<T extends EventBuilder<T>>

Builder interface for AuditableEvent instances. The mandatory typeId is expected to be initiated by constructing the builder.

See Also:

AuditlogService.eventBuilder(String)

Method Summary

Modifier and Type	Method and Description
T	addParameter(String key, Object value) Adds single event parameter to the parameters Map.
AuditableEvent	build() Builds the AuditableEvent instance.
T	cause(Throwable throwable) Sets error/exception which caused the event (if any).
T	level(Level level) Sets the event Level.
void	log() Builds the event and logs it to the service which provided this builder (if any).
T	message(String message)
T	parameters(Map<String,Object> parameters)
T	timestamp(long timestamp) If provided value greater than zero, then it sets the event timestamp explicitly.

Method Detail

message

T message(String message)

Parameters:

message - event message. May be null

Returns:

this instance

parameters

T parameters(Map<String,Object> parameters)

Parameters:

parameters - event parameters. Must not be null

Returns:

this instance

addParameter

T addParameter(String key,
               Object value)

Adds single event parameter to the parameters Map.

Parameters:

key - Must not be null

value -

Returns:

this instance

level

T level(Level level)

Sets the event Level. The default value is Level.INFO.

Parameters:

level -

Returns:

this instance

cause

T cause(Throwable throwable)

Sets error/exception which caused the event (if any).

Parameters:

throwable -

Returns:

this instance

timestamp

T timestamp(long timestamp)

If provided value greater than zero, then it sets the event timestamp explicitly. Otherwise the timestamp is filled by calling build() method.

Parameters:

throwable -

Returns:

this instance

build

AuditableEvent build()

Builds the AuditableEvent instance. If the timestamp is not configured explicitly, then the call sets event timestamp too.

Returns:

not-null event instance ready to be logged

log

void log()

Builds the event and logs it to the service which provided this builder (if any).

See Also:

AuditlogService.eventBuilder(String)