org.apereo.cas.audit.spi

Class DefaultAuditPrincipalIdProvider

java.lang.Object

org.apereo.cas.audit.spi.DefaultAuditPrincipalIdProvider

All Implemented Interfaces:

AuditPrincipalIdProvider, org.springframework.core.Ordered

Direct Known Subclasses:

SamlResponseAuditPrincipalIdProvider, SurrogateAuditPrincipalIdProvider

public class DefaultAuditPrincipalIdProvider
extends java.lang.Object
implements AuditPrincipalIdProvider

This is DefaultAuditPrincipalIdProvider.

Since:

5.3.0

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
DefaultAuditPrincipalIdProvider()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPrincipalIdFrom(Authentication authentication, java.lang.Object returnValue, java.lang.Exception exception) Return principal id from a given authentication event.
boolean	supports(Authentication authentication, java.lang.Object resultValue, java.lang.Exception exception) Whether this provider can support the authentication transaction to provide a principal id.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.core.Ordered

getOrder

Constructor Detail

DefaultAuditPrincipalIdProvider

public DefaultAuditPrincipalIdProvider()

Method Detail

getPrincipalIdFrom

public java.lang.String getPrincipalIdFrom(Authentication authentication,
                                           java.lang.Object returnValue,
                                           java.lang.Exception exception)

Description copied from interface: AuditPrincipalIdProvider

Return principal id from a given authentication event.

Specified by:

getPrincipalIdFrom in interface AuditPrincipalIdProvider

Parameters:

authentication - authentication event containing the data to computed the final principal id from

returnValue - the result value that is currently processed by the executing op. May be null.

exception - the exception that may have occurred as part of the current executing op. May be null.

Returns:

computed principal id

supports

public boolean supports(Authentication authentication,
                        java.lang.Object resultValue,
                        java.lang.Exception exception)

Description copied from interface: AuditPrincipalIdProvider

Whether this provider can support the authentication transaction to provide a principal id.

Specified by:

supports in interface AuditPrincipalIdProvider

Parameters:

authentication - the authentication transaction.

resultValue - the result value that is currently processed by the executing op. May be null.

exception - the exception that may have occurred as part of the current executing op. May be null.

Returns:

true /false