Package se.curity.identityserver.sdk.data.events

Class SuccessAuthenticationEvent

Object

se.curity.identityserver.sdk.data.events.AuthenticationEvent

se.curity.identityserver.sdk.data.events.UserAuthenticationEvent

se.curity.identityserver.sdk.data.events.AuthenticationAttemptEvent

se.curity.identityserver.sdk.data.events.LoginAuthenticationEvent

se.curity.identityserver.sdk.data.events.SuccessAuthenticationEvent

All Implemented Interfaces:

SerializableAsMap, AuditableEvent, Event

public class SuccessAuthenticationEvent
extends LoginAuthenticationEvent
implements AuditableEvent

Event fired at successful authentication.

Since:

2.2.0

Field Summary

Fields inherited from class se.curity.identityserver.sdk.data.events.AuthenticationAttemptEvent

_acr, _oauthClientId, _oauthProfileId, _serviceProviderId, _subject

Constructor Summary

Constructors

Constructor	Description
SuccessAuthenticationEvent(String sessionId, String subject, String acr, AuthenticationAttributes authenticationAttributes, Instant authenticationInstant, @Nullable String oauthProfileId, @Nullable String oauthClientId, String profileId)	Creates a new SuccessAuthenticationEvent.
SuccessAuthenticationEvent(String sessionId, String subject, String acr, AuthenticationAttributes authenticationAttributes, Instant authenticationInstant, @Nullable String serviceProviderId, String profileId)	Creates a new SuccessAuthenticationEvent.

Method Summary

Modifier and Type	Method	Description
AuditData	getAuditData()	Get all AuditData associated with this auditable event.
protected String	getAuditMessagePrologue()	Gets the beginning of the audit message.

Methods inherited from class se.curity.identityserver.sdk.data.events.LoginAuthenticationEvent

asMap, getAuthenticationAttributes, getAuthenticationInstant

Methods inherited from class se.curity.identityserver.sdk.data.events.AuthenticationAttemptEvent

getAcr, getAuditMessage, getOauthClientId, getOauthProfileId, getServiceProviderId, getSubject

Methods inherited from class se.curity.identityserver.sdk.data.events.UserAuthenticationEvent

getSessionId

Methods inherited from class se.curity.identityserver.sdk.data.events.AuthenticationEvent

getProfileId, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface se.curity.identityserver.sdk.data.events.Event

asMap

Constructor Details

SuccessAuthenticationEvent

public SuccessAuthenticationEvent(String sessionId,
 String subject,
 String acr,
 AuthenticationAttributes authenticationAttributes,
 Instant authenticationInstant,
 @Nullable String serviceProviderId,
 String profileId)

Creates a new SuccessAuthenticationEvent.

Parameters:

sessionId - The ID of the session bound to this authentication

subject - The subject of the authentication

acr - The ACR (Authentication Context Class Reference) used for authentication

authenticationAttributes - The AuthenticationAttributes returned from authentication

authenticationInstant - The instant in time when the authentication happened

serviceProviderId - The service provider used for authentication

profileId - The ID of the profile from which this event originated

SuccessAuthenticationEvent

public SuccessAuthenticationEvent(String sessionId,
 String subject,
 String acr,
 AuthenticationAttributes authenticationAttributes,
 Instant authenticationInstant,
 @Nullable String oauthProfileId,
 @Nullable String oauthClientId,
 String profileId)

Creates a new SuccessAuthenticationEvent.

Parameters:

sessionId - The ID of the session bound to this authentication

subject - The subject of the authentication

acr - The ACR (Authentication Context Class Reference) used for authentication

authenticationAttributes - The AuthenticationAttributes returned from authentication

authenticationInstant - The instant in time when the authentication happened

oauthProfileId - The OAuth profile requesting authentication

oauthClientId - The OAuth client requesting authentication

profileId - The ID of the profile from which this event originated

Method Details

getAuditData

public AuditData getAuditData()

Description copied from interface: AuditableEvent

Get all AuditData associated with this auditable event.

This method must always return the same instant of AuditData.

Specified by:

getAuditData in interface AuditableEvent

Returns:

the AuditData concisely describing the auditable data of this event

getAuditMessagePrologue

protected String getAuditMessagePrologue()

Description copied from class: AuthenticationAttemptEvent

Gets the beginning of the audit message. The "prologue" should describe the event, and will be followed by further details (service provider, OAuth client, OAuth profile).

Specified by:

getAuditMessagePrologue in class AuthenticationAttemptEvent

Returns:

a description of the event.

See Also:

• AuthenticationAttemptEvent.getAuditMessage()