sirius.biz.protocol

Class AuditLog

java.lang.Object

sirius.biz.protocol.AuditLog

All Implemented Interfaces:

sirius.kernel.di.Initializable

public class AuditLog
extends Object
implements sirius.kernel.di.Initializable

Inserts entries into the security log of the system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AuditLog.AuditLogBuilder Fluent builder for audit logs.

Constructor Summary

Constructors

Constructor and Description
AuditLog()

Method Summary

Modifier and Type	Method and Description
void	initialize()
AuditLog.AuditLogBuilder	negative(String messageKey) Prepares a "negative" entry to be inserted into the log.
AuditLog.AuditLogBuilder	neutral(String messageKey) Prepares a "neutral" entry to be inserted into the log.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditLog

public AuditLog()

Method Detail

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface sirius.kernel.di.Initializable

Throws:

Exception

neutral

@CheckReturnValue
public AuditLog.AuditLogBuilder neutral(String messageKey)

Prepares a "neutral" entry to be inserted into the log.

Note that a builder is returned and eventually AuditLog.AuditLogBuilder.log() has to be called.

Parameters:

messageKey - the message key (i18n key) to log

Returns:

the builder used to supply further info

negative

@CheckReturnValue
public AuditLog.AuditLogBuilder negative(String messageKey)

Prepares a "negative" entry to be inserted into the log.

Note that a builder is returned and eventually AuditLog.AuditLogBuilder.log() has to be called.

Parameters:

messageKey - the message key (i18n key) to log

Returns:

the builder used to supply further info