com.helger.photon.basic.audit

Class AuditManager

java.lang.Object

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

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

com.helger.photon.basic.audit.AuditManager

All Implemented Interfaces:

IAutoSaveAware, IChangeable, IDAO, IAuditManager

@ThreadSafe
public class AuditManager
extends AbstractSimpleDAO
implements IAuditManager

The class handles all system audit actions. It collects them asynchronously (see AsynchronousAuditor) and writes them to XML files on a per-day basis.

Author:

Philip Helger

Nested Class Summary

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

IDAO.EMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_ITEM Element name of each item in the serialized XML
static String	ELEMENT_ITEMS Element name of the root element of the serialized XML

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

DEFAULT_AUTO_SAVE_ENABLED, m_aRWLock

Constructor Summary

Constructors

Constructor and Description
AuditManager(String sBaseDir, ICurrentUserIDProvider aCurrentUserIDProvider) Constructor

Method Summary

Modifier and Type	Method and Description
protected com.helger.xml.microdom.IMicroDocument	createWriteData() Create the XML document that should be saved to the file.
boolean	equals(Object o)
com.helger.commons.collection.ext.ICommonsList<IAuditItem>	getAllAuditItemsOfDate(LocalDate aDate)
int	getAuditItemCount()
AsynchronousAuditor	getAuditor()
String	getBaseDir()
LocalDate	getEarliestAuditDate()
List<IAuditItem>	getLastAuditItems(int nMaxItems)
static String	getRelativeAuditDirectory(LocalDate aDate)
static String	getRelativeAuditDirectoryYear(int nYear)
static String	getRelativeAuditFilename(LocalDate aDate)
int	hashCode()
boolean	isInMemory()
protected void	onFilenameChange(String sPreviousFilename, String sNewFilename) Called after a successful write of the file, if the filename is different from the previous filename.
protected com.helger.commons.state.EChange	onRead(com.helger.xml.microdom.IMicroDocument aDoc) Fill the internal structures with from the passed XML document.
static void	readFromXML(com.helger.xml.microdom.IMicroDocument aDoc, IAuditManagerReadHandler aHandler)
void	stop() Stop taking new audits.
String	toString()

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

beforeWriteToFile, getDAOIO, getFilenameProvider, getInitCount, getLastFilename, getLastInitDateTime, getLastReadDateTime, getLastWriteDateTime, getReadCount, getSafeFile, getWriteCount, getXMLWriterSettings, initialRead, markAsChanged, modifyWriteData, onInit, 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

Field Detail

ELEMENT_ITEMS

public static final String ELEMENT_ITEMS

Element name of the root element of the serialized XML

See Also:

Constant Field Values

ELEMENT_ITEM

public static final String ELEMENT_ITEM

Element name of each item in the serialized XML

See Also:

Constant Field Values

Constructor Detail

AuditManager

@ContainsSoftMigration
public AuditManager(@Nullable
                                            String sBaseDir,
                                            @Nonnull
                                            ICurrentUserIDProvider aCurrentUserIDProvider)
                                     throws DAOException

Constructor

Parameters:

sBaseDir - The base directory, relative to the default IO base directory. 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

getRelativeAuditDirectoryYear

@Nonnull
 @Nonempty
public static String getRelativeAuditDirectoryYear(@Nonnull
                                                                         int nYear)

getRelativeAuditDirectory

@Nonnull
 @Nonempty
public static String getRelativeAuditDirectory(@Nonnull
                                                                     LocalDate aDate)

getRelativeAuditFilename

@Nonnull
 @Nonempty
public static String getRelativeAuditFilename(@Nonnull
                                                                    LocalDate aDate)

isInMemory

public boolean isInMemory()

Specified by:

isInMemory in interface IAuditManager

Returns:

true if this manager operates only in memory, false if it keeps persistent files.

See Also:

IAuditManager.getBaseDir()

getBaseDir

@Nullable
public String getBaseDir()

Specified by:

getBaseDir in interface IAuditManager

Returns:

The base directory used for audit entries. May be null to indicate in-memory only auditing. If the results is not null it must end with a path separator (slash).

See Also:

IAuditManager.isInMemory()

getAuditor

@Nonnull
public AsynchronousAuditor getAuditor()

Specified by:

getAuditor in interface IAuditManager

Returns:

The underlying auditor. Never null.

readFromXML

public static void readFromXML(@Nonnull
                               com.helger.xml.microdom.IMicroDocument aDoc,
                               @Nonnull
                               IAuditManagerReadHandler aHandler)

onRead

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

Description copied from class: AbstractSimpleDAO

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

Specified by:

onRead in class AbstractSimpleDAO

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: AbstractSimpleDAO

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 AbstractSimpleDAO

Returns:

The non-null document to write to the file.

onFilenameChange

protected void onFilenameChange(@Nullable
                                String sPreviousFilename,
                                @Nonnull
                                String sNewFilename)

Description copied from class: AbstractSimpleDAO

Called after a successful write of the file, if the filename is different from the previous filename. This can e.g. be used to clear old data.

Overrides:

onFilenameChange in class AbstractSimpleDAO

Parameters:

sPreviousFilename - The previous filename. May be null.

sNewFilename - The new filename. Never null.

getAuditItemCount

@Nonnegative
public int getAuditItemCount()

getLastAuditItems

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

Specified by:

getLastAuditItems in interface IAuditManager

Parameters:

nMaxItems - The maximum number of items. Must be > 0.

Returns:

The n latest audit items. Never null.

stop

public void stop()

Description copied from interface: IAuditManager

Stop taking new audits. Call this upon shutdown for correct cleanup! Consecutive calls to this method have no further effect.

Specified by:

stop in interface IAuditManager

getAllAuditItemsOfDate

@Nullable
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsList<IAuditItem> getAllAuditItemsOfDate(@Nonnull
                                                                                                                          LocalDate aDate)

getEarliestAuditDate

@Nonnull
public LocalDate getEarliestAuditDate()

Specified by:

getEarliestAuditDate in interface IAuditManager

Returns:

The earliest date for which auditing information is present. If this is an in-memory audit manager, it must return the current date. Never null.

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 AbstractSimpleDAO