Package se.curity.identityserver.sdk.authentication

Class BackchannelAuthenticationResult

Object

se.curity.identityserver.sdk.authentication.BackchannelAuthenticationResult

public final class BackchannelAuthenticationResult
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final BackchannelAuthenticationResult	UNKNOWN_RESULT

Constructor Summary

Constructors

Constructor	Description
BackchannelAuthenticationResult(@Nullable AuthenticationAttributes authenticationAttributes, @Nullable BackchannelAuthenticatorState state)
BackchannelAuthenticationResult(@Nullable AuthenticationAttributes authenticationAttributes, @Nullable BackchannelAuthenticatorState state, @Nullable AuthenticationActionResult authenticationActionResult)

Method Summary

Modifier and Type	Method	Description
@Nullable AuthenticationActionResult	getActionResult()
Optional<AuthenticationAttributes>	getAuthenticationAttributes()	When a backchannel authentication request was successfully completed by an authenticator, this will return the authentication attributes that the authenticator has established as a result.
AuthenticationAttributes	getAuthenticationAttributesOrError()	Calls getAuthenticationAttributes(), but throws IllegalStateException if it's empty.
BackchannelAuthenticatorState	getState()
boolean	isExpired()
boolean	isFailed()
boolean	isSucceeded()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

UNKNOWN_RESULT

public static final BackchannelAuthenticationResult UNKNOWN_RESULT

Constructor Details

BackchannelAuthenticationResult

public BackchannelAuthenticationResult(@Nullable AuthenticationAttributes authenticationAttributes,
 @Nullable BackchannelAuthenticatorState state)

BackchannelAuthenticationResult

public BackchannelAuthenticationResult(@Nullable AuthenticationAttributes authenticationAttributes,
 @Nullable BackchannelAuthenticatorState state,
 @Nullable AuthenticationActionResult authenticationActionResult)

Method Details

getAuthenticationAttributes

public Optional<AuthenticationAttributes> getAuthenticationAttributes()

When a backchannel authentication request was successfully completed by an authenticator, this will return the authentication attributes that the authenticator has established as a result.

Returns empty if authentication was not yet finished, or when it the attempt was cancelled.

Returns:

Established authentication attributes, or null when they were not (yet) established.

getAuthenticationAttributesOrError

public AuthenticationAttributes getAuthenticationAttributesOrError()

Calls getAuthenticationAttributes(), but throws IllegalStateException if it's empty.

This method is safe to call after isSucceeded() is checked and returns true.

Returns:

Established authentication attributes, or throws if not present

Throws:

IllegalStateException - if authentication attributes are not present

getState

public BackchannelAuthenticatorState getState()

Returns:

the status of the backchannel authentication request for the authenticator

getActionResult

@Nullable
public @Nullable AuthenticationActionResult getActionResult()

isExpired

public boolean isExpired()

Returns:

true when the backchannel authentication request expired.

isFailed

public boolean isFailed()

Returns:

true when the backchannel authentication request failed due to user action.

isSucceeded

public boolean isSucceeded()

Returns:

true when the backchannel authentication was successful.

toString

public String toString()

Overrides:

toString in class Object