com.helger.photon.basic.security.audit

Class AbstractAuditor

java.lang.Object

com.helger.photon.basic.security.audit.AbstractAuditor

All Implemented Interfaces:

IAuditor

Direct Known Subclasses:

AsynchronousAuditor, IgnoringAuditor, LoggingAuditor

@Immutable
public abstract class AbstractAuditor
extends Object
implements IAuditor

Abstract base class for interface IAuditor.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AbstractAuditor(ICurrentUserIDProvider aCurrentUserIDProvider)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	createAuditString(String sObjectType, Object[] aArgs)
protected abstract void	handleAuditItem(IAuditItem aAuditItem) Implement this method to handle the created audit items.
void	onCreateFailure(com.helger.commons.type.ObjectType aObjectType, Object... aArgs) The creation of an object failed.
void	onCreateSuccess(com.helger.commons.type.ObjectType aObjectType, Object... aArgs) The creation of an object succeeded.
void	onDeleteFailure(com.helger.commons.type.ObjectType aObjectType, Object... aArgs) The deletion of an object failed.
void	onDeleteSuccess(com.helger.commons.type.ObjectType aObjectType, Object... aArgs) The deletion of an object succeeded.
void	onExecuteFailure(com.helger.commons.type.ObjectType aObjectType, String sWhat, Object... aArgs) The execution of something on an object failed.
void	onExecuteFailure(String sWhat, Object... aArgs) The execution of something failed.
void	onExecuteSuccess(com.helger.commons.type.ObjectType aObjectType, String sWhat, Object... aArgs) The execution of something on an object succeeded.
void	onExecuteSuccess(String sWhat, Object... aArgs) The execution of something succeeded.
void	onModifyFailure(com.helger.commons.type.ObjectType aObjectType, String sWhat, Object... aArgs) The modification of an object failed.
void	onModifySuccess(com.helger.commons.type.ObjectType aObjectType, String sWhat, Object... aArgs) The modification of an object succeeded.
void	onUndeleteFailure(com.helger.commons.type.ObjectType aObjectType, Object... aArgs) The undeletion of an object failed.
void	onUndeleteSuccess(com.helger.commons.type.ObjectType aObjectType, Object... aArgs) The undeletion of an object succeeded.
void	setCurrentUserIDProvider(ICurrentUserIDProvider aCurrentUserIDProvider)
protected boolean	useJsonNotation()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAuditor

public AbstractAuditor(@Nonnull
               ICurrentUserIDProvider aCurrentUserIDProvider)

Method Detail

setCurrentUserIDProvider

public final void setCurrentUserIDProvider(@Nonnull
                            ICurrentUserIDProvider aCurrentUserIDProvider)

useJsonNotation

@OverrideOnDemand
protected boolean useJsonNotation()

Returns:

true to create a Json string, false to create a legacy comma separated list

handleAuditItem

protected abstract void handleAuditItem(@Nonnull
                   IAuditItem aAuditItem)

Implement this method to handle the created audit items.

Parameters:

aAuditItem - The audit item to handle. Never null.

createAuditString

@Nonnull
@OverrideOnDemand
protected String createAuditString(@Nonnull
                                                String sObjectType,
                                                @Nullable
                                                Object[] aArgs)

onCreateSuccess

public void onCreateSuccess(@Nonnull
                   com.helger.commons.type.ObjectType aObjectType,
                   @Nullable
                   Object... aArgs)

Description copied from interface: IAuditor

The creation of an object succeeded.

Specified by:

onCreateSuccess in interface IAuditor

Parameters:

aObjectType - The object type

aArgs - Additional arguments

onCreateFailure

public void onCreateFailure(@Nonnull
                   com.helger.commons.type.ObjectType aObjectType,
                   @Nullable
                   Object... aArgs)

Description copied from interface: IAuditor

The creation of an object failed.

Specified by:

onCreateFailure in interface IAuditor

Parameters:

aObjectType - The object type

aArgs - Additional arguments

onModifySuccess

public void onModifySuccess(@Nonnull
                   com.helger.commons.type.ObjectType aObjectType,
                   @Nonnull
                   String sWhat,
                   @Nullable
                   Object... aArgs)

Description copied from interface: IAuditor

The modification of an object succeeded.

Specified by:

onModifySuccess in interface IAuditor

Parameters:

aObjectType - The object type

sWhat - What was modified?

aArgs - Additional arguments

onModifyFailure

public void onModifyFailure(@Nonnull
                   com.helger.commons.type.ObjectType aObjectType,
                   @Nonnull
                   String sWhat,
                   @Nullable
                   Object... aArgs)

Description copied from interface: IAuditor

The modification of an object failed.

Specified by:

onModifyFailure in interface IAuditor

Parameters:

aObjectType - The object type

sWhat - What was modified?

aArgs - Additional arguments

onDeleteSuccess

public void onDeleteSuccess(@Nonnull
                   com.helger.commons.type.ObjectType aObjectType,
                   @Nullable
                   Object... aArgs)

Description copied from interface: IAuditor

The deletion of an object succeeded.

Specified by:

onDeleteSuccess in interface IAuditor

Parameters:

aObjectType - The object type

aArgs - Additional arguments

onDeleteFailure

public void onDeleteFailure(@Nonnull
                   com.helger.commons.type.ObjectType aObjectType,
                   @Nullable
                   Object... aArgs)

Description copied from interface: IAuditor

The deletion of an object failed.

Specified by:

onDeleteFailure in interface IAuditor

Parameters:

aObjectType - The object type

aArgs - Additional arguments

onUndeleteSuccess

public void onUndeleteSuccess(@Nonnull
                     com.helger.commons.type.ObjectType aObjectType,
                     @Nullable
                     Object... aArgs)

Description copied from interface: IAuditor

The undeletion of an object succeeded.

Specified by:

onUndeleteSuccess in interface IAuditor

Parameters:

aObjectType - The object type

aArgs - Additional arguments

onUndeleteFailure

public void onUndeleteFailure(@Nonnull
                     com.helger.commons.type.ObjectType aObjectType,
                     @Nullable
                     Object... aArgs)

Description copied from interface: IAuditor

The undeletion of an object failed.

Specified by:

onUndeleteFailure in interface IAuditor

Parameters:

aObjectType - The object type

aArgs - Additional arguments

onExecuteSuccess

public void onExecuteSuccess(@Nonnull
                    String sWhat,
                    @Nullable
                    Object... aArgs)

Description copied from interface: IAuditor

The execution of something succeeded.

Specified by:

onExecuteSuccess in interface IAuditor

Parameters:

sWhat - What has been executed?

aArgs - Additional arguments

onExecuteFailure

public void onExecuteFailure(@Nonnull
                    String sWhat,
                    @Nullable
                    Object... aArgs)

Description copied from interface: IAuditor

The execution of something failed.

Specified by:

onExecuteFailure in interface IAuditor

Parameters:

sWhat - What has been executed?

aArgs - Additional arguments

onExecuteSuccess

public void onExecuteSuccess(@Nonnull
                    com.helger.commons.type.ObjectType aObjectType,
                    @Nonnull
                    String sWhat,
                    @Nullable
                    Object... aArgs)

Description copied from interface: IAuditor

The execution of something on an object succeeded.

Specified by:

onExecuteSuccess in interface IAuditor

Parameters:

aObjectType - The object type

sWhat - What has been executed?

aArgs - Additional arguments

onExecuteFailure

public void onExecuteFailure(@Nonnull
                    com.helger.commons.type.ObjectType aObjectType,
                    @Nonnull
                    String sWhat,
                    @Nullable
                    Object... aArgs)

Description copied from interface: IAuditor

The execution of something on an object failed.

Specified by:

onExecuteFailure in interface IAuditor

Parameters:

aObjectType - The object type

sWhat - What has been executed?

aArgs - Additional arguments