com.helger.photon.audit

Class AuditHelper

java.lang.Object

com.helger.photon.audit.AuditHelper

@ThreadSafe
public final class AuditHelper
extends Object

Simplify system auditing calls.
For each predefined action (see EAuditActionType - CREATE, MODIFY, DELETE, UNDELETE, EXECUTE) this class provided static helpers methods.
For MODIFY actions, the performed action (like "set-name") should always be first.
Error details should always go last.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
static IAuditor	getAuditor()
static boolean	isDefaultAuditorSet()
static void	onAuditCreateFailure(com.helger.commons.type.ObjectType aObjectType) Deprecated.
static void	onAuditCreateFailure(com.helger.commons.type.ObjectType aObjectType, Object... aArgs)
static void	onAuditCreateSuccess(com.helger.commons.type.ObjectType aObjectType)
static void	onAuditCreateSuccess(com.helger.commons.type.ObjectType aObjectType, Object... aArgs)
static void	onAuditDeleteFailure(com.helger.commons.type.ObjectType aObjectType) Deprecated.
static void	onAuditDeleteFailure(com.helger.commons.type.ObjectType aObjectType, Object... aArgs)
static void	onAuditDeleteSuccess(com.helger.commons.type.ObjectType aObjectType) Deprecated.
static void	onAuditDeleteSuccess(com.helger.commons.type.ObjectType aObjectType, Object... aArgs)
static void	onAuditExecuteFailure(com.helger.commons.type.ObjectType aObjectType, String sWhat, Object... aArgs)
static void	onAuditExecuteFailure(String sWhat, Object... aArgs)
static void	onAuditExecuteSuccess(com.helger.commons.type.ObjectType aObjectType, String sWhat, Object... aArgs)
static void	onAuditExecuteSuccess(String sWhat, Object... aArgs)
static void	onAuditModifyFailure(com.helger.commons.type.ObjectType aObjectType, String sWhat) Deprecated.
static void	onAuditModifyFailure(com.helger.commons.type.ObjectType aObjectType, String sWhat, Object... aArgs)
static void	onAuditModifySuccess(com.helger.commons.type.ObjectType aObjectType, String sWhat) Deprecated.
static void	onAuditModifySuccess(com.helger.commons.type.ObjectType aObjectType, String sWhat, Object... aArgs)
static void	onAuditUndeleteFailure(com.helger.commons.type.ObjectType aObjectType) Deprecated.
static void	onAuditUndeleteFailure(com.helger.commons.type.ObjectType aObjectType, Object... aArgs)
static void	onAuditUndeleteSuccess(com.helger.commons.type.ObjectType aObjectType) Deprecated.
static void	onAuditUndeleteSuccess(com.helger.commons.type.ObjectType aObjectType, Object... aArgs)
static void	setAuditor(IAuditor aAuditor) Set the global auditor to use.
static void	setDefaultAuditor() Set the default auditor again.

Methods inherited from class java.lang.Object

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

Method Detail

getAuditor

@Nonnull
public static IAuditor getAuditor()

isDefaultAuditorSet

public static boolean isDefaultAuditorSet()

Returns:

true if the current Auditor is the default auditor.

Since:

8.3.2

setAuditor

public static void setAuditor(@Nonnull
                              IAuditor aAuditor)

Set the global auditor to use.

Parameters:

aAuditor - The auditor to be set. May not be null.

setDefaultAuditor

public static void setDefaultAuditor()

Set the default auditor again. This may be helpful when shutting down the main auditor, and at least want some prove, when something auditible happens.

onAuditCreateSuccess

public static void onAuditCreateSuccess(@Nonnull
                                        com.helger.commons.type.ObjectType aObjectType)

onAuditCreateSuccess

public static void onAuditCreateSuccess(@Nonnull
                                        com.helger.commons.type.ObjectType aObjectType,
                                        @Nullable
                                        Object... aArgs)

onAuditCreateFailure

@Deprecated
 @UnsupportedOperation
 @DevelopersNote(value="Use the version with parameters!")
public static void onAuditCreateFailure(@Nonnull
                                                                                                                                         com.helger.commons.type.ObjectType aObjectType)

Deprecated.

onAuditCreateFailure

public static void onAuditCreateFailure(@Nonnull
                                        com.helger.commons.type.ObjectType aObjectType,
                                        @Nullable
                                        Object... aArgs)

onAuditModifySuccess

@Deprecated
 @UnsupportedOperation
 @DevelopersNote(value="Use the version with parameters!")
public static void onAuditModifySuccess(@Nonnull
                                                                                                                                         com.helger.commons.type.ObjectType aObjectType,
                                                                                                                                         @Nonnull
                                                                                                                                         String sWhat)

Deprecated.

onAuditModifySuccess

public static void onAuditModifySuccess(@Nonnull
                                        com.helger.commons.type.ObjectType aObjectType,
                                        @Nonnull
                                        String sWhat,
                                        @Nullable
                                        Object... aArgs)

onAuditModifyFailure

@Deprecated
 @UnsupportedOperation
 @DevelopersNote(value="Use the version with parameters!")
public static void onAuditModifyFailure(@Nonnull
                                                                                                                                         com.helger.commons.type.ObjectType aObjectType,
                                                                                                                                         @Nonnull
                                                                                                                                         String sWhat)

Deprecated.

onAuditModifyFailure

public static void onAuditModifyFailure(@Nonnull
                                        com.helger.commons.type.ObjectType aObjectType,
                                        @Nonnull
                                        String sWhat,
                                        @Nullable
                                        Object... aArgs)

onAuditDeleteSuccess

@Deprecated
 @UnsupportedOperation
 @DevelopersNote(value="Use the version with parameters!")
public static void onAuditDeleteSuccess(@Nonnull
                                                                                                                                         com.helger.commons.type.ObjectType aObjectType)

Deprecated.

onAuditDeleteSuccess

public static void onAuditDeleteSuccess(@Nonnull
                                        com.helger.commons.type.ObjectType aObjectType,
                                        @Nullable
                                        Object... aArgs)

onAuditDeleteFailure

@Deprecated
 @UnsupportedOperation
 @DevelopersNote(value="Use the version with parameters!")
public static void onAuditDeleteFailure(@Nonnull
                                                                                                                                         com.helger.commons.type.ObjectType aObjectType)

Deprecated.

onAuditDeleteFailure

public static void onAuditDeleteFailure(@Nonnull
                                        com.helger.commons.type.ObjectType aObjectType,
                                        @Nullable
                                        Object... aArgs)

onAuditUndeleteSuccess

@Deprecated
 @UnsupportedOperation
 @DevelopersNote(value="Use the version with parameters!")
public static void onAuditUndeleteSuccess(@Nonnull
                                                                                                                                           com.helger.commons.type.ObjectType aObjectType)

Deprecated.

onAuditUndeleteSuccess

public static void onAuditUndeleteSuccess(@Nonnull
                                          com.helger.commons.type.ObjectType aObjectType,
                                          @Nullable
                                          Object... aArgs)

onAuditUndeleteFailure

@Deprecated
 @UnsupportedOperation
 @DevelopersNote(value="Use the version with parameters!")
public static void onAuditUndeleteFailure(@Nonnull
                                                                                                                                           com.helger.commons.type.ObjectType aObjectType)

Deprecated.

onAuditUndeleteFailure

public static void onAuditUndeleteFailure(@Nonnull
                                          com.helger.commons.type.ObjectType aObjectType,
                                          @Nullable
                                          Object... aArgs)

onAuditExecuteSuccess

public static void onAuditExecuteSuccess(@Nonnull
                                         String sWhat,
                                         @Nullable
                                         Object... aArgs)

onAuditExecuteFailure

public static void onAuditExecuteFailure(@Nonnull
                                         String sWhat,
                                         @Nullable
                                         Object... aArgs)

onAuditExecuteSuccess

public static void onAuditExecuteSuccess(@Nonnull
                                         com.helger.commons.type.ObjectType aObjectType,
                                         @Nonnull
                                         String sWhat,
                                         @Nullable
                                         Object... aArgs)

onAuditExecuteFailure

public static void onAuditExecuteFailure(@Nonnull
                                         com.helger.commons.type.ObjectType aObjectType,
                                         @Nonnull
                                         String sWhat,
                                         @Nullable
                                         Object... aArgs)