com.helger.photon.basic.audit

Class AbstractAuditor

java.lang.Object

com.helger.photon.basic.audit.AbstractAuditor

All Implemented Interfaces:

IAuditor

Direct Known Subclasses:

AsynchronousAuditor, DoNothingAuditor, LoggingAuditor

@Immutable
public abstract class AbstractAuditor
extends Object
implements IAuditor

Abstract base class for interface IAuditor.

Author:

Philip Helger

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractAuditor(ICurrentUserIDProvider aCurrentUserIDProvider)
protected	AbstractAuditor(ICurrentUserIDProvider aCurrentUserIDProvider, IAuditActionStringProvider aActionStringProvider)

Method Summary

Modifier and Type	Method and Description
void	createAuditItem(EAuditActionType eActionType, com.helger.commons.state.ESuccess eSuccess, String sAction, Object... aArgs) Create a new audit item.
protected abstract void	handleAuditItem(IAuditItem aAuditItem) Implement this method to handle the created audit items.
void	setActionStringProvider(IAuditActionStringProvider aActionStringProvider)
void	setCurrentUserIDProvider(ICurrentUserIDProvider aCurrentUserIDProvider)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.photon.basic.audit.IAuditor

onCreateFailure, onCreateSuccess, onDeleteFailure, onDeleteSuccess, onExecuteFailure, onExecuteFailure, onExecuteSuccess, onExecuteSuccess, onModifyFailure, onModifySuccess, onUndeleteFailure, onUndeleteSuccess

Constructor Detail

AbstractAuditor

public AbstractAuditor(@Nonnull
                       ICurrentUserIDProvider aCurrentUserIDProvider)

AbstractAuditor

protected AbstractAuditor(@Nonnull
                          ICurrentUserIDProvider aCurrentUserIDProvider,
                          @Nonnull
                          IAuditActionStringProvider aActionStringProvider)

Method Detail

setCurrentUserIDProvider

public final void setCurrentUserIDProvider(@Nonnull
                                           ICurrentUserIDProvider aCurrentUserIDProvider)

setActionStringProvider

public final void setActionStringProvider(@Nonnull
                                          IAuditActionStringProvider aActionStringProvider)

handleAuditItem

@OverrideOnDemand
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.

createAuditItem

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

Description copied from interface: IAuditor

Create a new audit item.

Specified by:

createAuditItem in interface IAuditor

Parameters:

eActionType - Action type. May not be null.

eSuccess - Success or failure? May not be null.

sAction - The performed action. May not be null.

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