org.apereo.cas.audit

Interface AuditPrincipalIdProvider

All Superinterfaces:

org.springframework.core.Ordered

All Known Implementing Classes:

ChainingAuditPrincipalIdProvider, DefaultAuditPrincipalIdProvider, SamlResponseAuditPrincipalIdProvider, SurrogateAuditPrincipalIdProvider

public interface AuditPrincipalIdProvider
extends org.springframework.core.Ordered

Strategy interface to provide principal id tokens from any given authentication event.

Useful for authentication scenarios where there is not only one primary principal id available, but additional authentication metadata in addition to custom requirement to compute and show more complex principal identifier for auditing purposes. An example would be compound ids resulted from multi-legged mfa authentications, 'surrogate' authentications, etc.

Since:

4.2.0

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPrincipalIdFrom(Authentication authentication, java.lang.Object resultValue, 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 interface org.springframework.core.Ordered

getOrder

Method Detail

getPrincipalIdFrom

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

Return principal id from a given authentication event.

Parameters:

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

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:

computed principal id

supports

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.

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