Package com.sun.identity.authentication.audit

Class AuthenticationModuleEventAuditor

java.lang.Object

com.sun.identity.authentication.audit.AbstractAuthenticationEventAuditor

com.sun.identity.authentication.audit.AuthenticationModuleEventAuditor

public class AuthenticationModuleEventAuditor
extends AbstractAuthenticationEventAuditor

This auditor is specifically aimed at constructing and logging authentication events for login modules.

Since:

13.0.0

Field Summary

Fields inherited from class com.sun.identity.authentication.audit.AbstractAuthenticationEventAuditor

eventFactory, eventPublisher

Constructor Summary

Constructors

Constructor	Description
AuthenticationModuleEventAuditor(AuditEventPublisher eventPublisher, AuditEventFactory eventFactory)	Constructor for AuthenticationModuleEventAuditor.

Method Summary

Modifier and Type	Method	Description
void	auditModuleFailure(LoginState loginState, Principal principal, AuthenticationAuditEntry auditEntryDetail)	Log an authentication module failure completion event.
void	auditModuleSuccess(LoginState loginState, Principal principal, AuthenticationAuditEntry auditEntryDetail)	Log an authentication module successful completion event.

Methods inherited from class com.sun.identity.authentication.audit.AbstractAuthenticationEventAuditor

getFailedPrincipal, getRealmFromState, getRealmFromToken, getTrackingIds, getUserId

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationModuleEventAuditor

@Inject
public AuthenticationModuleEventAuditor(AuditEventPublisher eventPublisher,
                                        AuditEventFactory eventFactory)

Constructor for AuthenticationModuleEventAuditor.

Parameters:

eventPublisher - The publisher responsible for logging the events.

eventFactory - The factory that can be used to create the events.

Method Detail

auditModuleSuccess

public void auditModuleSuccess(LoginState loginState,
                               Principal principal,
                               AuthenticationAuditEntry auditEntryDetail)

Log an authentication module successful completion event.

Parameters:

loginState - The login state object.

principal - The principal for this module.

auditEntryDetail - A map containing audit entry details.

auditModuleFailure

public void auditModuleFailure(LoginState loginState,
                               Principal principal,
                               AuthenticationAuditEntry auditEntryDetail)

Log an authentication module failure completion event.

Parameters:

loginState - The login state object.

principal - The principal for this module.

auditEntryDetail - A map containing audit entry details.