Package com.helger.photon.audit.v2

Class AuditEventBuilder

java.lang.Object

com.helger.photon.audit.v2.AuditEventBuilder

@NotThreadSafe
public class AuditEventBuilder
extends Object

Builder for AuditEvent objects.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
AuditEventBuilder()

Method Summary

Modifier and Type	Method	Description
AuditEventBuilder	addField(AuditField aField)
AuditEventBuilder	addField(String sFieldName, String sFieldValue)
AuditEventBuilder	addFieldHiddenValue(String sFieldName)
AuditEvent	build()	Build a new AuditEvent based on the provided parameters.
String	getRealActorID()
AuditEventBuilder	setAction(EAuditActionType eAction)
AuditEventBuilder	setActor(String sActor)
AuditEventBuilder	setCurrentUserIDProvider(com.helger.security.authentication.subject.user.ICurrentUserIDProvider aCurrentUserIDProvider)
AuditEventBuilder	setOrigin(String sOrigin)
AuditEventBuilder	setSettings(IAuditSettings aSettings)
AuditEventBuilder	setSucces(com.helger.commons.state.ESuccess eSuccess)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditEventBuilder

public AuditEventBuilder()

Method Detail

setSettings

@Nonnull
public AuditEventBuilder setSettings(@Nonnull
                                     IAuditSettings aSettings)

setCurrentUserIDProvider

@Nonnull
public AuditEventBuilder setCurrentUserIDProvider(@Nullable
                                                  com.helger.security.authentication.subject.user.ICurrentUserIDProvider aCurrentUserIDProvider)

setActor

@Nonnull
public AuditEventBuilder setActor(@Nullable
                                  String sActor)

setOrigin

@Nonnull
public AuditEventBuilder setOrigin(@Nullable
                                   String sOrigin)

setAction

@Nonnull
public AuditEventBuilder setAction(@Nullable
                                   EAuditActionType eAction)

setSucces

@Nonnull
public AuditEventBuilder setSucces(@Nullable
                                   com.helger.commons.state.ESuccess eSuccess)

addField

@Nonnull
public AuditEventBuilder addField(@Nullable
                                  AuditField aField)

addField

@Nonnull
public AuditEventBuilder addField(@Nullable
                                  String sFieldName,
                                  @Nullable
                                  String sFieldValue)

addFieldHiddenValue

@Nonnull
public AuditEventBuilder addFieldHiddenValue(@Nullable
                                             String sFieldName)

getRealActorID

@Nullable
public String getRealActorID()

build

@Nonnull
public AuditEvent build()

Build a new AuditEvent based on the provided parameters. Each invocation creates a new instance. The ID and the date time are retrieved from the providers registered in the IAuditSettings.

Returns:

The created AuditEvent and never null.