Package se.curity.identityserver.sdk.authenticationaction

Class AuthenticationActionResult.PendingCompletionAuthenticationActionResult

Object

se.curity.identityserver.sdk.authenticationaction.AuthenticationActionResult

se.curity.identityserver.sdk.authenticationaction.AuthenticationActionResult.PendingCompletionAuthenticationActionResult

Enclosing class:

AuthenticationActionResult

public static final class AuthenticationActionResult.PendingCompletionAuthenticationActionResult
extends AuthenticationActionResult

Nested Class Summary

Nested classes/interfaces inherited from class se.curity.identityserver.sdk.authenticationaction.AuthenticationActionResult

AuthenticationActionResult.FailedAuthenticationActionResult, AuthenticationActionResult.PendingCompletionAuthenticationActionResult, AuthenticationActionResult.SuccessAuthenticationActionResult

Method Summary

Modifier and Type	Method	Description
@Nullable String	getActionId()
@Nullable AuthenticationAttributes	getIntermediateAuthenticationAttributes()
RequiredActionCompletion	getObligation()
<T> T	visit(Function<AuthenticationActionResult.SuccessAuthenticationActionResult,T> onSuccess, Function<AuthenticationActionResult.PendingCompletionAuthenticationActionResult,T> onPending, Function<AuthenticationActionResult.FailedAuthenticationActionResult,T> onFailure)	Visit this authentication action result.
AuthenticationActionResult	withActionId(String actionId)
AuthenticationActionResult.PendingCompletionAuthenticationActionResult	withIntermediateResultIfNone(AuthenticationAttributes intermediateAttributes)
AuthenticationActionResult	withObligation(RequiredActionCompletion.AuthenticateUser authenticateUser)
AuthenticationActionResult	withObligation(RequiredActionCompletion.PromptUser promptUser)

Methods inherited from class se.curity.identityserver.sdk.authenticationaction.AuthenticationActionResult

failedResult, failedResult, pendingResult, pendingResult, successfulResult

Methods inherited from class java.lang.Object

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

Method Details

getObligation

public RequiredActionCompletion getObligation()

withActionId

public AuthenticationActionResult withActionId(String actionId)

Specified by:

withActionId in class AuthenticationActionResult

getActionId

@Nullable
public @Nullable String getActionId()

Specified by:

getActionId in class AuthenticationActionResult

getIntermediateAuthenticationAttributes

@Nullable
public @Nullable AuthenticationAttributes getIntermediateAuthenticationAttributes()

Returns:

the new optional intermediate attributes define by this result.

Since:

4.0.0

withIntermediateResultIfNone

public AuthenticationActionResult.PendingCompletionAuthenticationActionResult withIntermediateResultIfNone(AuthenticationAttributes intermediateAttributes)

Parameters:

intermediateAttributes - the intermediate attributes to use if the current result doesn't have any.

Returns:

the same result, if it already contained intermediate attributes; or a new result with the given intermediate attributes.

Since:

4.0.0

withObligation

public AuthenticationActionResult withObligation(RequiredActionCompletion.PromptUser promptUser)

Parameters:

promptUser - the new PromptUser object to use.

Returns:

a new PendingCompletionAuthenticationActionResult with the given PromptUser object.

Since:

4.0.0

withObligation

public AuthenticationActionResult withObligation(RequiredActionCompletion.AuthenticateUser authenticateUser)

Parameters:

authenticateUser - the new RequiredActionCompletion.AuthenticateUser object to use.

Returns:

a new AuthenticationActionResult.PendingCompletionAuthenticationActionResult with the given RequiredActionCompletion.AuthenticateUser object.

Since:

6.6

visit

public <T> T visit(Function<AuthenticationActionResult.SuccessAuthenticationActionResult,T> onSuccess,
 Function<AuthenticationActionResult.PendingCompletionAuthenticationActionResult,T> onPending,
 Function<AuthenticationActionResult.FailedAuthenticationActionResult,T> onFailure)

Description copied from class: AuthenticationActionResult

Visit this authentication action result.

Specified by:

visit in class AuthenticationActionResult

Type Parameters:

T - type of return value

Parameters:

onSuccess - function to execute on success

onPending - function to execute on a pending result

onFailure - function to execute on a failure result

Returns:

the result returned by the executed function