com.helger.photon.basic.audit

Class SimpleAuditManager

java.lang.Object

com.helger.photon.basic.app.dao.impl.AbstractDAO

com.helger.photon.basic.app.dao.impl.AbstractWALDAO<AuditItem>

com.helger.photon.basic.audit.SimpleAuditManager

All Implemented Interfaces:

IAutoSaveAware, IChangeable, IDAO, IAuditor

@ThreadSafe
public class SimpleAuditManager
extends AbstractWALDAO<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.photon.basic.app.dao.IDAO

IDAO.EMode

Field Summary

Fields inherited from class com.helger.photon.basic.app.dao.impl.AbstractWALDAO

DEFAULT_WAITING_TIME, WAL_XWS, WRITE_XWS

Fields inherited from class com.helger.photon.basic.app.dao.impl.AbstractDAO

DEFAULT_AUTO_SAVE_ENABLED, m_aRWLock

Constructor Summary

Constructors

Constructor and Description
SimpleAuditManager(String sFilename, ICurrentUserIDProvider aCurrentUserIDProvider) Constructor

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 com.helger.xml.microdom.IMicroDocument	createWriteData() Create the XML document that should be saved to the file.
boolean	equals(Object o)
List<IAuditItem>	getAllAuditItems()
int	getAuditItemCount()
List<IAuditItem>	getLastAuditItems(int nMaxItems)
int	hashCode()
protected com.helger.commons.state.EChange	onRead(com.helger.xml.microdom.IMicroDocument aDoc) Fill the internal structures with from the passed XML document.
protected void	onRecoveryCreate(AuditItem aItem) Called when a recovery is needed to create a new item.
protected void	onRecoveryDelete(AuditItem aElement) Called when a recovery is needed to delete an existing item.
protected void	onRecoveryUpdate(AuditItem aElement) Called when a recovery is needed to update an existing item.
String	toString()

Methods inherited from class com.helger.photon.basic.app.dao.impl.AbstractWALDAO

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

Methods inherited from class com.helger.photon.basic.app.dao.impl.AbstractDAO

beginWithoutAutoSave, endWithoutAutoSave, getExceptionHandlersRead, getExceptionHandlersWrite, hasPendingChanges, internalHasPendingChanges, internalIsAutoSaveEnabled, internalSetPendingChanges, isAutoSaveEnabled, isDebugLogging, performWithoutAutoSave, performWithoutAutoSave, performWithoutAutoSaveThrowing, performWithoutAutoSaveThrowing

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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

SimpleAuditManager

public SimpleAuditManager(@Nullable
                          String sFilename,
                          @Nonnull
                          ICurrentUserIDProvider aCurrentUserIDProvider)
                   throws 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:

DAOException - In case reading failed

Method Detail

onRecoveryCreate

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

Description copied from class: AbstractWALDAO

Called when a recovery is needed to create a new item.

Specified by:

onRecoveryCreate in class AbstractWALDAO<AuditItem>

Parameters:

aItem - The element to be created. Never null.

onRecoveryUpdate

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

Description copied from class: AbstractWALDAO

Called when a recovery is needed to update an existing item.

Specified by:

onRecoveryUpdate in class AbstractWALDAO<AuditItem>

Parameters:

aElement - The element to be updated. Never null.

onRecoveryDelete

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

Description copied from class: AbstractWALDAO

Called when a recovery is needed to delete an existing item.

Specified by:

onRecoveryDelete in class AbstractWALDAO<AuditItem>

Parameters:

aElement - The element to be deleted. Never null.

onRead

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

Description copied from class: AbstractWALDAO

Fill the internal structures with from the passed XML document. This method is only called within a write lock!

Specified by:

onRead in class AbstractWALDAO<AuditItem>

Parameters:

aDoc - The XML document to read from. Never null.

Returns:

EChange.CHANGED if reading the data changed something in the internal structures that requires a writing.

createWriteData

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

Description copied from class: AbstractWALDAO

Create the XML document that should be saved to the file. This method is only called within a write lock!

Specified by:

createWriteData in class AbstractWALDAO<AuditItem>

Returns:

The non-null document to write to the file.

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.

getAuditItemCount

@Nonnegative
public int getAuditItemCount()

getAllAuditItems

@Nonnull
 @ReturnsMutableCopy
public List<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 AbstractWALDAO<AuditItem>