com.helger.photon.audit

Class AbstractAuditor

java.lang.Object

com.helger.photon.audit.AbstractAuditor

All Implemented Interfaces:

IAuditor

Direct Known Subclasses:

AsynchronousAuditor, DoNothingAuditor, LoggingAuditor

@NotThreadSafe
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(com.helger.security.authentication.subject.user.ICurrentUserIDProvider aCurrentUserIDProvider)
protected	AbstractAuditor(com.helger.security.authentication.subject.user.ICurrentUserIDProvider aCurrentUserIDProvider, IAuditActionStringProvider aActionStringProvider)

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.
IAuditActionStringProvider	getActionStringProvider()
com.helger.security.authentication.subject.user.ICurrentUserIDProvider	getCurrentUserIDProvider()
protected abstract void	handleAuditItem(IAuditItem aAuditItem) Implement this method to handle the created audit items.
void	setActionStringProvider(IAuditActionStringProvider aActionStringProvider)
void	setCurrentUserIDProvider(com.helger.security.authentication.subject.user.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.audit.IAuditor

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

Constructor Detail

AbstractAuditor

public AbstractAuditor(@Nonnull
                       com.helger.security.authentication.subject.user.ICurrentUserIDProvider aCurrentUserIDProvider)

AbstractAuditor

protected AbstractAuditor(@Nonnull
                          com.helger.security.authentication.subject.user.ICurrentUserIDProvider aCurrentUserIDProvider,
                          @Nonnull
                          IAuditActionStringProvider aActionStringProvider)

Method Detail

getCurrentUserIDProvider

@Nonnull
public final com.helger.security.authentication.subject.user.ICurrentUserIDProvider getCurrentUserIDProvider()

setCurrentUserIDProvider

public final void setCurrentUserIDProvider(@Nonnull
                                           com.helger.security.authentication.subject.user.ICurrentUserIDProvider aCurrentUserIDProvider)

getActionStringProvider

@Nonnull
public final IAuditActionStringProvider getActionStringProvider()

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,
                            @Nullable
                            com.helger.commons.type.ObjectType aActionObjectType,
                            @Nullable
                            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.

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.