Package org.apereo.inspektr.audit.spi.support

Class DefaultAuditActionResolver

java.lang.Object

org.apereo.inspektr.audit.spi.support.AbstractSuffixAwareAuditActionResolver

org.apereo.inspektr.audit.spi.support.DefaultAuditActionResolver

All Implemented Interfaces:

AuditActionResolver

public class DefaultAuditActionResolver
extends AbstractSuffixAwareAuditActionResolver

Default resolver. If a suffix is defined for success and failure, the failure suffix is appended if an exception is thrown. Otherwise, the success suffix is used.

Since:

1.0

Author:

Scott Battaglia

Constructor Summary

Constructors

Constructor	Description
DefaultAuditActionResolver()	Constructs the resolver with empty values for the two suffixes.
DefaultAuditActionResolver(java.lang.String successSuffix)	Constructs the DefaultAuditActionResolver with a success suffix.
DefaultAuditActionResolver(java.lang.String successSuffix, java.lang.String failureSuffix)	Constructs the DefaultAuditActionResolver with a success suffix and failure suffix.

Method Summary

Modifier and Type	Method	Description
java.lang.String	resolveFrom(org.aspectj.lang.JoinPoint auditableTarget, java.lang.Exception exception, Audit audit)	Resolve the action for the audit event that has incurred an exception.
java.lang.String	resolveFrom(org.aspectj.lang.JoinPoint auditableTarget, java.lang.Object retval, Audit audit)	Resolve the action for the audit event.

Methods inherited from class org.apereo.inspektr.audit.spi.support.AbstractSuffixAwareAuditActionResolver

getFailureSuffix, getSuccessSuffix

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAuditActionResolver

public DefaultAuditActionResolver()

Constructs the resolver with empty values for the two suffixes.

DefaultAuditActionResolver

public DefaultAuditActionResolver(java.lang.String successSuffix)

Constructs the DefaultAuditActionResolver with a success suffix.

Parameters:

successSuffix - the suffix to use in the event of a success.

DefaultAuditActionResolver

public DefaultAuditActionResolver(java.lang.String successSuffix,
                                  java.lang.String failureSuffix)

Constructs the DefaultAuditActionResolver with a success suffix and failure suffix. CANNOT be NULL.

Parameters:

successSuffix - the suffix to use in the event of a success.

failureSuffix - the suffix to use in the event of a failure.

Method Detail

resolveFrom

public java.lang.String resolveFrom(org.aspectj.lang.JoinPoint auditableTarget,
                                    java.lang.Object retval,
                                    Audit audit)

Description copied from interface: AuditActionResolver

Resolve the action for the audit event.

retval - The returned value

audit - the Audit annotation that may contain additional information.

Returns:

The resource String

resolveFrom

public java.lang.String resolveFrom(org.aspectj.lang.JoinPoint auditableTarget,
                                    java.lang.Exception exception,
                                    Audit audit)

Description copied from interface: AuditActionResolver

Resolve the action for the audit event that has incurred an exception.

exception - The exception incurred when the join point proceeds.

audit - the Audit annotation that may contain additional information.

Returns:

The resource String