com.helger.photon.audit

Class SimpleAuditManager

java.lang.Object

com.helger.dao.AbstractDAO

com.helger.dao.wal.AbstractWALDAO<DATATYPE>

com.helger.photon.app.dao.AbstractPhotonWALDAO<AuditItem>

com.helger.photon.audit.SimpleAuditManager

All Implemented Interfaces:

com.helger.dao.IAutoSaveAware, com.helger.dao.IDAO, IAuditor

@ThreadSafe
public class SimpleAuditManager
extends com.helger.photon.app.dao.AbstractPhotonWALDAO<AuditItem>
implements IAuditor

The class handles audit actions in a very simple way. All actions are synchronously written to a single large file.

Author:

Philip Helger

Nested Class Summary

Nested classes/interfaces inherited from interface com.helger.dao.IDAO

com.helger.dao.IDAO.EMode

Field Summary

Fields inherited from class com.helger.dao.wal.AbstractWALDAO

DEFAULT_WAITING_TIME, WAL_XWS, WRITE_XWS

Fields inherited from class com.helger.dao.AbstractDAO

DEFAULT_AUTO_SAVE_ENABLED, FILENAME_EXTENSION_NEW, FILENAME_EXTENSION_PREV, m_aRWLock, RW_LOCK

Constructor Summary

Constructors

Constructor and Description
SimpleAuditManager(String sFilename, com.helger.security.authentication.subject.user.ICurrentUserIDProvider aCurrentUserIDProvider) Constructor

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.
protected com.helger.xml.microdom.IMicroDocument	createWriteData()
boolean	equals(Object o)
com.helger.commons.collection.impl.ICommonsList<IAuditItem>	getAllAuditItems()
int	getAuditItemCount()
List<IAuditItem>	getLastAuditItems(int nMaxItems)
int	hashCode()
protected com.helger.commons.state.EChange	onRead(com.helger.xml.microdom.IMicroDocument aDoc)
protected void	onRecoveryCreate(AuditItem aItem)
protected void	onRecoveryDelete(AuditItem aElement)
protected void	onRecoveryUpdate(AuditItem aElement)
String	toString()

Methods inherited from class com.helger.dao.wal.AbstractWALDAO

convertNativeToWALString, convertWALStringToNative, getDataTypeClass, getFilenameProvider, getInitCount, getIO, getLastFilename, getLastInitDateTime, getLastReadDateTime, getLastWriteDateTime, getReadCount, getSafeFile, getWaitingTime, getWALXMLWriterSettings, getWriteCount, getXMLWriterSettings, initialRead, markAsChanged, markAsChanged, modifyWriteData, onBetweenReadAndWAL, onFilenameChange, onInit, onRecoveryErrorConvertToNative, setWaitingTime, triggerExceptionHandlersRead, triggerExceptionHandlersWrite, writeToFileOnPendingChanges

Methods inherited from class com.helger.dao.AbstractDAO

beginWithoutAutoSave, checkFileAccess, endWithoutAutoSave, exceptionHandlersRead, exceptionHandlersWrite, hasPendingChanges, internalHasPendingChanges, internalIsAutoSaveEnabled, internalSetPendingChanges, isAutoSaveEnabled, isSilentMode, setSilentMode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Methods inherited from interface com.helger.dao.IDAO

isReloadable, reload

Methods inherited from interface com.helger.dao.IAutoSaveAware

performWithoutAutoSave, performWithoutAutoSave, performWithoutAutoSaveThrowing, performWithoutAutoSaveThrowing

Constructor Detail

SimpleAuditManager

public SimpleAuditManager(@Nullable
                          String sFilename,
                          @Nonnull
                          com.helger.security.authentication.subject.user.ICurrentUserIDProvider aCurrentUserIDProvider)
                   throws com.helger.dao.DAOException

Constructor

Parameters:

sFilename - The filename to write the audits to. May be null to indicate an in-memory auditor only.

aCurrentUserIDProvider - The current user ID provider. May not be null.

Throws:

com.helger.dao.DAOException - In case reading failed

Method Detail

onRecoveryCreate

@IsLocked(value=WRITE)
protected void onRecoveryCreate(@Nonnull
                                                        AuditItem aItem)

Specified by:

onRecoveryCreate in class com.helger.dao.wal.AbstractWALDAO<AuditItem>

onRecoveryUpdate

@IsLocked(value=WRITE)
protected void onRecoveryUpdate(@Nonnull
                                                        AuditItem aElement)

Specified by:

onRecoveryUpdate in class com.helger.dao.wal.AbstractWALDAO<AuditItem>

onRecoveryDelete

@IsLocked(value=WRITE)
protected void onRecoveryDelete(@Nonnull
                                                        AuditItem aElement)

Specified by:

onRecoveryDelete in class com.helger.dao.wal.AbstractWALDAO<AuditItem>

onRead

@Nonnull
protected com.helger.commons.state.EChange onRead(@Nonnull
                                                            com.helger.xml.microdom.IMicroDocument aDoc)

Specified by:

onRead in class com.helger.dao.wal.AbstractWALDAO<AuditItem>

createWriteData

protected com.helger.xml.microdom.IMicroDocument createWriteData()

Specified by:

createWriteData in class com.helger.dao.wal.AbstractWALDAO<AuditItem>

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.

getAuditItemCount

@Nonnegative
public int getAuditItemCount()

getAllAuditItems

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<IAuditItem> getAllAuditItems()

getLastAuditItems

@Nonnull
 @ReturnsMutableCopy
public List<IAuditItem> getLastAuditItems(@Nonnegative
                                                                          int nMaxItems)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class com.helger.dao.wal.AbstractWALDAO<AuditItem>