Package com.helger.photon.audit

Class DoNothingAuditManager

java.lang.Object

com.helger.photon.audit.DoNothingAuditManager

All Implemented Interfaces:

IAuditManager

public final class DoNothingAuditManager
extends Object
implements IAuditManager

A specific implementation of IAuditManager that does nothing.

Since:

8.4.1

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
DoNothingAuditManager()

Method Summary

Modifier and Type	Method	Description
IAuditor	getAuditor()
String	getBaseDir()
LocalDate	getEarliestAuditDate()
List<IAuditItem>	getLastAuditItems(int nMaxItems)
boolean	isInMemory()
void	stop()	Stop taking new audits.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoNothingAuditManager

public DoNothingAuditManager()

Method Detail

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 IAuditor getAuditor()

Specified by:

getAuditor in interface IAuditManager

Returns:

The underlying auditor. Never null.

getLastAuditItems

@Nonnull
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

getEarliestAuditDate

@Nullable
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. May be null if a persistent storage is used and no entry is present yet.