sirius.biz.protocol

Class AuditLog.AuditLogBuilder

java.lang.Object

sirius.biz.protocol.AuditLog.AuditLogBuilder

Enclosing class:

AuditLog

public class AuditLog.AuditLogBuilder
extends Object

Fluent builder for audit logs.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AuditLogBuilder(String message, boolean negative)

Method Summary

Modifier and Type	Method and Description
AuditLog.AuditLogBuilder	causedByCurrentUser() Marks the entry as caused by the current user in UserContext.getCurrentUser().
AuditLog.AuditLogBuilder	causedByUser(String id, String name) Marks the entry as caused by the given user.
AuditLog.AuditLogBuilder	forCurrentUser() Creates the entry for the current user in UserContext.getCurrentUser().
AuditLog.AuditLogBuilder	forTenant(String id, String name) Creates the entry for the given tenant.
AuditLog.AuditLogBuilder	forUser(String id, String name) Creates the entry for the given user.
void	log() Writes the entry into the log table.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditLogBuilder

protected AuditLogBuilder(String message,
                          boolean negative)

Method Detail

forCurrentUser

@CheckReturnValue
public AuditLog.AuditLogBuilder forCurrentUser()

Creates the entry for the current user in UserContext.getCurrentUser().

Returns:

the builder for fluent method calls

forUser

@CheckReturnValue
public AuditLog.AuditLogBuilder forUser(@Nullable
                                                          String id,
                                                          @Nullable
                                                          String name)

Creates the entry for the given user.

Parameters:

id - the ID of the user

name - the name of the user

Returns:

the builder for fluent method calls

causedByCurrentUser

@CheckReturnValue
public AuditLog.AuditLogBuilder causedByCurrentUser()

Marks the entry as caused by the current user in UserContext.getCurrentUser().

Returns:

the builder for fluent method calls

causedByUser

@CheckReturnValue
public AuditLog.AuditLogBuilder causedByUser(@Nullable
                                                               String id,
                                                               @Nullable
                                                               String name)

Marks the entry as caused by the given user.

Parameters:

id - the ID of the user

name - the name of the user

Returns:

the builder for fluent method calls

forTenant

@CheckReturnValue
public AuditLog.AuditLogBuilder forTenant(@Nullable
                                                            String id,
                                                            @Nullable
                                                            String name)

Creates the entry for the given tenant.

Parameters:

id - the ID of the tenant

name - the name of the tenant

Returns:

the builder for fluent method calls

log

public void log()

Writes the entry into the log table.