org.apereo.inspektr.common.spi

Class JoinPointArgumentAuditPrincipalIdProvider<T>

java.lang.Object

org.apereo.inspektr.common.spi.JoinPointArgumentAuditPrincipalIdProvider<T>

All Implemented Interfaces:

PrincipalResolver

public abstract class JoinPointArgumentAuditPrincipalIdProvider<T>
extends java.lang.Object
implements PrincipalResolver

This is JoinPointArgumentAuditPrincipalIdProvider.

Author:

Misagh Moayyed

Field Summary

Fields inherited from interface org.apereo.inspektr.common.spi.PrincipalResolver

ANONYMOUS_USER, UNKNOWN_USER

Constructor Summary

Constructors

Constructor and Description
JoinPointArgumentAuditPrincipalIdProvider(int argumentPosition, java.lang.Class<T> argumentType)

Method Summary

Modifier and Type	Method and Description
java.lang.String	resolveFrom(org.aspectj.lang.JoinPoint auditTarget, java.lang.Exception exception) Resolve the principal performing an audit-able action that has incurred an exception.
java.lang.String	resolveFrom(org.aspectj.lang.JoinPoint auditTarget, java.lang.Object returnValue) Resolve the principal performing an audit-able action.
protected abstract java.lang.String	resolveFrom(T argument, org.aspectj.lang.JoinPoint auditTarget, java.lang.Object returnValue)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apereo.inspektr.common.spi.PrincipalResolver

resolve

Constructor Detail

JoinPointArgumentAuditPrincipalIdProvider

public JoinPointArgumentAuditPrincipalIdProvider(int argumentPosition,
                                                 java.lang.Class<T> argumentType)

Method Detail

resolveFrom

public java.lang.String resolveFrom(org.aspectj.lang.JoinPoint auditTarget,
                                    java.lang.Object returnValue)

Description copied from interface: PrincipalResolver

Resolve the principal performing an audit-able action.

Note, this method should NEVER throw an exception *unless* the expectation is that a failed resolution causes the entire transaction to fail. Otherwise use PrincipalResolver.UNKNOWN_USER.

Specified by:

resolveFrom in interface PrincipalResolver

Parameters:

auditTarget - the join point where we're auditing.

returnValue - the returned value

Returns:

The principal as a String. CANNOT be NULL.

resolveFrom

public java.lang.String resolveFrom(org.aspectj.lang.JoinPoint auditTarget,
                                    java.lang.Exception exception)

Description copied from interface: PrincipalResolver

Resolve the principal performing an audit-able action that has incurred an exception.

Note, this method should NEVER throw an exception *unless* the expectation is that a failed resolution causes the entire transaction to fail. Otherwise use PrincipalResolver.UNKNOWN_USER.

Specified by:

resolveFrom in interface PrincipalResolver

Parameters:

auditTarget - the join point where we're auditing.

exception - The exception incurred when the join point proceeds.

Returns:

The principal as a String. CANNOT be NULL.

resolveFrom

protected abstract java.lang.String resolveFrom(T argument,
                                                org.aspectj.lang.JoinPoint auditTarget,
                                                java.lang.Object returnValue)