Package com.helger.photon.audit.v2

Class Audit2Bridge

java.lang.Object

com.helger.photon.audit.v2.Audit2Bridge

All Implemented Interfaces:

IAuditor

public class Audit2Bridge
extends Object
implements IAuditor

Implementation of V1 IAuditor in terms of V2 AuditEvent etc. This class is mainly meant for easy transition without adopting all APIs.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static String	AUDIT_FIELD_OBJECT_TYPE
static String	AUDIT_FIELD_USER_ACTION

Constructor Summary

Constructors

Constructor	Description
Audit2Bridge(com.helger.security.authentication.subject.user.ICurrentUserIDProvider aCurrentUserIDProvider, IAuditEventConsumer aAuditEventConsumer, Function<Object,String> aToStringConverter)

Method Summary

Modifier and Type	Method	Description
void	createAuditItem(EAuditActionType eActionType, com.helger.commons.state.ESuccess eSuccess, com.helger.commons.type.ObjectType aActionObjectType, String sUserAction, Object... aArgs)	Create a new audit item.
IAuditEventConsumer	getAuditEventConsumer()
com.helger.security.authentication.subject.user.ICurrentUserIDProvider	getCurrentUserIDProvider()

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

Field Detail

AUDIT_FIELD_OBJECT_TYPE

public static final String AUDIT_FIELD_OBJECT_TYPE

See Also:

Constant Field Values

AUDIT_FIELD_USER_ACTION

public static final String AUDIT_FIELD_USER_ACTION

See Also:

Constant Field Values

Constructor Detail

Audit2Bridge

public Audit2Bridge(@Nonnull
                    com.helger.security.authentication.subject.user.ICurrentUserIDProvider aCurrentUserIDProvider,
                    @Nonnull
                    IAuditEventConsumer aAuditEventConsumer,
                    @Nonnull
                    Function<Object,String> aToStringConverter)

Method Detail

getCurrentUserIDProvider

@Nonnull
public final com.helger.security.authentication.subject.user.ICurrentUserIDProvider getCurrentUserIDProvider()

getAuditEventConsumer

@Nonnull
public final IAuditEventConsumer getAuditEventConsumer()

createAuditItem

public void createAuditItem(@Nonnull
                            EAuditActionType eActionType,
                            @Nonnull
                            com.helger.commons.state.ESuccess eSuccess,
                            @Nullable
                            com.helger.commons.type.ObjectType aActionObjectType,
                            @Nullable
                            String sUserAction,
                            @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.

aActionObjectType - Action object type. May be null if sAction is set.

sUserAction - The performed action. May be null if aActionObjectType is set.

aArgs - An optional array of arguments. May be null or empty.