com.helger.photon.audit

Interface IAuditor

All Known Implementing Classes:

AbstractAuditor, AsynchronousAuditor, Audit2Bridge, DoNothingAuditor, LoggingAuditor, SimpleAuditManager

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface IAuditor

Main interface for an auditing service. Not serializable.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
void	createAuditItem(EAuditActionType eActionType, com.helger.commons.state.ESuccess eSuccess, com.helger.commons.type.ObjectType aActionObjectType, String sAction, Object... aArgs) Create a new audit item.
default void	onCreateFailure(com.helger.commons.type.ObjectType aObjectType, Object... aArgs) The creation of an object failed.
default void	onCreateSuccess(com.helger.commons.type.ObjectType aObjectType, Object... aArgs) The creation of an object succeeded.
default void	onDeleteFailure(com.helger.commons.type.ObjectType aObjectType, Object... aArgs) The deletion of an object failed.
default void	onDeleteSuccess(com.helger.commons.type.ObjectType aObjectType, Object... aArgs) The deletion of an object succeeded.
default void	onExecuteFailure(com.helger.commons.type.ObjectType aObjectType, String sWhat, Object... aArgs) The execution of something on an object failed.
default void	onExecuteFailure(String sWhat, Object... aArgs) The execution of something failed.
default void	onExecuteSuccess(com.helger.commons.type.ObjectType aObjectType, String sWhat, Object... aArgs) The execution of something on an object succeeded.
default void	onExecuteSuccess(String sWhat, Object... aArgs) The execution of something succeeded.
default void	onModifyFailure(com.helger.commons.type.ObjectType aObjectType, String sWhat, Object... aArgs) The modification of an object failed.
default void	onModifySuccess(com.helger.commons.type.ObjectType aObjectType, String sWhat, Object... aArgs) The modification of an object succeeded.
default void	onUndeleteFailure(com.helger.commons.type.ObjectType aObjectType, Object... aArgs) The undeletion of an object failed.
default void	onUndeleteSuccess(com.helger.commons.type.ObjectType aObjectType, Object... aArgs) The undeletion of an object succeeded.

Method Detail

createAuditItem

void createAuditItem(@Nonnull
                     EAuditActionType eActionType,
                     @Nonnull
                     com.helger.commons.state.ESuccess eSuccess,
                     @Nullable
                     com.helger.commons.type.ObjectType aActionObjectType,
                     @Nullable
                     String sAction,
                     @Nullable
                     Object... aArgs)

Create a new audit item.

Parameters:

eActionType - Action type. May not be null.

eSuccess - Success or failure? May not be null.

aActionObjectType - Action object type. May be null if sAction is set.

sAction - The performed action. May be null if aActionObjectType is set.

aArgs - An optional array of arguments. May be null or empty.

onCreateSuccess

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

The creation of an object succeeded.

Parameters:

aObjectType - The object type

aArgs - Additional arguments

onCreateFailure

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

The creation of an object failed.

Parameters:

aObjectType - The object type

aArgs - Additional arguments

onModifySuccess

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

The modification of an object succeeded.

Parameters:

aObjectType - The object type

sWhat - What was modified?

aArgs - Additional arguments

onModifyFailure

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

The modification of an object failed.

Parameters:

aObjectType - The object type

sWhat - What was modified?

aArgs - Additional arguments

onDeleteSuccess

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

The deletion of an object succeeded.

Parameters:

aObjectType - The object type

aArgs - Additional arguments

onDeleteFailure

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

The deletion of an object failed.

Parameters:

aObjectType - The object type

aArgs - Additional arguments

onUndeleteSuccess

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

The undeletion of an object succeeded.

Parameters:

aObjectType - The object type

aArgs - Additional arguments

onUndeleteFailure

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

The undeletion of an object failed.

Parameters:

aObjectType - The object type

aArgs - Additional arguments

onExecuteSuccess

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

The execution of something succeeded.

Parameters:

sWhat - What has been executed?

aArgs - Additional arguments

onExecuteFailure

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

The execution of something failed.

Parameters:

sWhat - What has been executed?

aArgs - Additional arguments

onExecuteSuccess

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

The execution of something on an object succeeded.

Parameters:

aObjectType - The object type

sWhat - What has been executed?

aArgs - Additional arguments

onExecuteFailure

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

The execution of something on an object failed.

Parameters:

aObjectType - The object type

sWhat - What has been executed?

aArgs - Additional arguments