com.helger.photon.basic.security.audit

Interface IAuditItem

All Superinterfaces:

com.helger.commons.state.ISuccessIndicator

@MustImplementEqualsAndHashcode
public interface IAuditItem
extends com.helger.commons.state.ISuccessIndicator

Base interface for a single audit item

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
String	getAction()
org.joda.time.LocalDateTime	getDateTime()
com.helger.commons.state.ESuccess	getSuccess()
EAuditActionType	getType()
String	getUserID()
boolean	isAnonymousUser()

Methods inherited from interface com.helger.commons.state.ISuccessIndicator

isFailure, isSuccess

Method Detail

getDateTime

@Nonnull
org.joda.time.LocalDateTime getDateTime()

Returns:

The date and time when the audit item was created

getUserID

@Nonnull
String getUserID()

Returns:

The user who triggered the audit item.

isAnonymousUser

boolean isAnonymousUser()

Returns:

true if the user ID equals CSecurity.USER_ID_NONE_LOGGED_IN

getType

@Nonnull
EAuditActionType getType()

Returns:

The audit action type.

getSuccess

@Nonnull
com.helger.commons.state.ESuccess getSuccess()

Returns:

Success or error?

getAction

@Nonnull
String getAction()

Returns:

The performed action in the syntax "action(param1,param2,...)"