com.helger.photon.audit

Class AsynchronousAuditor

java.lang.Object

com.helger.photon.audit.AbstractAuditor

com.helger.photon.audit.AsynchronousAuditor

All Implemented Interfaces:

IAuditor

@ThreadSafe
public class AsynchronousAuditor
extends AbstractAuditor

The class handles audit items asynchronously. If a new audit item is to be handled it is put into the IConcurrentPerformer's queue as provided in the constructor.
Please ensure to call stop() if this auditor is no longer used, so that the created ExecutorService can be gracefully shutdown.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AsynchronousAuditor(com.helger.security.authentication.subject.user.ICurrentUserIDProvider aUserIDProvider, com.helger.commons.concurrent.collector.IConcurrentPerformer<List<IAuditItem>> aPerformer)

Method Summary

Modifier and Type	Method and Description
int	getQueueLength()
protected void	handleAuditItem(IAuditItem aAuditItem) Implement this method to handle the created audit items.
com.helger.commons.state.EChange	stop() When using this auditor, it is important to call this stop() method before shutdown.

Methods inherited from class com.helger.photon.audit.AbstractAuditor

createAuditItem, getActionStringProvider, getCurrentUserIDProvider, setActionStringProvider, setCurrentUserIDProvider

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

AsynchronousAuditor

public AsynchronousAuditor(@Nonnull
                           com.helger.security.authentication.subject.user.ICurrentUserIDProvider aUserIDProvider,
                           @Nonnull
                           com.helger.commons.concurrent.collector.IConcurrentPerformer<List<IAuditItem>> aPerformer)

Method Detail

handleAuditItem

protected void handleAuditItem(@Nonnull
                               IAuditItem aAuditItem)

Description copied from class: AbstractAuditor

Implement this method to handle the created audit items.

Specified by:

handleAuditItem in class AbstractAuditor

Parameters:

aAuditItem - The audit item to handle. Never null.

getQueueLength

@Nonnegative
public int getQueueLength()

stop

@Nonnull
public com.helger.commons.state.EChange stop()

When using this auditor, it is important to call this stop() method before shutdown. It avoids further queuing of objects and waits until all items are handled. This method blocks until all remaining objects are handled.

Returns:

EChange.CHANGED if the shutdown was performed, EChange.UNCHANGED if the auditor was already shut down.