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

Class AuthenticationAttemptEvent

Object

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

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

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

All Implemented Interfaces:

SerializableAsMap, Event

Direct Known Subclasses:

FailedAuthenticationEvent, LoginAuthenticationEvent

public abstract class AuthenticationAttemptEvent
extends UserAuthenticationEvent

A common base class for authentication events, whether successful or failed.

Since:

6.7

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	_acr
protected final @Nullable String	_oauthClientId
protected final @Nullable String	_oauthProfileId
protected final @Nullable String	_serviceProviderId
protected final @Nullable String	_subject

Constructor Summary

Constructors

Constructor	Description
AuthenticationAttemptEvent(String sessionId, @Nullable String subject, String acr, @Nullable String serviceProviderId, @Nullable String oauthProfileId, @Nullable String oauthClientId, String profileId)

Method Summary

Modifier and Type	Method	Description
String	getAcr()	Get the ACR (Authentication Context Class Reference) used for login.
protected String	getAuditMessage()
protected abstract String	getAuditMessagePrologue()	Gets the beginning of the audit message.
@Nullable String	getOauthClientId()	Get the ID of the OAuth client requesting authentication.
@Nullable String	getOauthProfileId()	Get the ID of the OAuth profile requesting authentication.
@Nullable String	getServiceProviderId()	Get the ID of the service provider used for login.
@Nullable String	getSubject()	Get the subject of whoever performed the login.

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

asMap, 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

Field Details

_subject

protected final @Nullable String _subject

_acr

protected final String _acr

_serviceProviderId

protected final @Nullable String _serviceProviderId

_oauthProfileId

protected final @Nullable String _oauthProfileId

_oauthClientId

protected final @Nullable String _oauthClientId

Constructor Details

AuthenticationAttemptEvent

public AuthenticationAttemptEvent(String sessionId,
 @Nullable String subject,
 String acr,
 @Nullable String serviceProviderId,
 @Nullable String oauthProfileId,
 @Nullable String oauthClientId,
 String profileId)

Method Details

getAcr

public String getAcr()

Get the ACR (Authentication Context Class Reference) used for login.

Returns:

the ACR of the authenticator

getServiceProviderId

@Nullable
public @Nullable String getServiceProviderId()

Get the ID of the service provider used for login.

Returns:

the service provider ID

getOauthProfileId

@Nullable
public @Nullable String getOauthProfileId()

Get the ID of the OAuth profile requesting authentication.

Returns:

the OAuth profile ID

getOauthClientId

@Nullable
public @Nullable String getOauthClientId()

Get the ID of the OAuth client requesting authentication.

Returns:

the OAuth client ID

getSubject

@Nullable
public @Nullable String getSubject()

Get the subject of whoever performed the login. For a failed attempt, this can be null.

Returns:

the authenticated subject

getAuditMessage

protected String getAuditMessage()

getAuditMessagePrologue

protected abstract String getAuditMessagePrologue()

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).

Returns:

a description of the event.

See Also:

• getAuditMessage()