Package org.keycloak.authentication.actiontoken.resetcred

Class ResetCredentialsActionTokenHandler

java.lang.Object

org.keycloak.authentication.actiontoken.AbstractActionTokenHandler<ResetCredentialsActionToken>

org.keycloak.authentication.actiontoken.resetcred.ResetCredentialsActionTokenHandler

All Implemented Interfaces:

ActionTokenHandler<ResetCredentialsActionToken>, ActionTokenHandlerFactory<ResetCredentialsActionToken>, Provider, ProviderFactory<ActionTokenHandler<ResetCredentialsActionToken>>

public class ResetCredentialsActionTokenHandler
extends AbstractActionTokenHandler<ResetCredentialsActionToken>

Author:

hmlnarik

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResetCredentialsActionTokenHandler.ResetCredsAuthenticationProcessor

Constructor Summary

Constructors

Constructor	Description
ResetCredentialsActionTokenHandler()

Method Summary

Modifier and Type	Method	Description
boolean	canUseTokenRepeatedly(ResetCredentialsActionToken token, ActionTokenContext tokenContext)	Returns true when the token can be used repeatedly to invoke the action, false when the token is intended to be for single use only.
TokenVerifier.Predicate<? super ResetCredentialsActionToken>[]	getVerifiers(ActionTokenContext<ResetCredentialsActionToken> tokenContext)	Returns an array of verifiers that are tested prior to handling the token.
jakarta.ws.rs.core.Response	handleToken(ResetCredentialsActionToken token, ActionTokenContext tokenContext)	Performs the action as per the token details.

Methods inherited from class org.keycloak.authentication.actiontoken.AbstractActionTokenHandler

close, create, eventType, getAuthenticationSessionIdFromToken, getDefaultErrorMessage, getDefaultEventError, getId, getTokenClass, init, postInit, startFreshAuthenticationSession, verifyEmail

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.authentication.actiontoken.ActionTokenHandler

preHandleToken

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Constructor Details

ResetCredentialsActionTokenHandler

public ResetCredentialsActionTokenHandler()

Method Details

getVerifiers

public TokenVerifier.Predicate<? super ResetCredentialsActionToken>[] getVerifiers(ActionTokenContext<ResetCredentialsActionToken> tokenContext)

Description copied from interface: ActionTokenHandler

Returns an array of verifiers that are tested prior to handling the token. All verifiers have to pass successfully for token to be handled. The returned array must not be null.

Returns:

Verifiers or an empty array. The returned array must not be null.

handleToken

public jakarta.ws.rs.core.Response handleToken(ResetCredentialsActionToken token,
 ActionTokenContext tokenContext)

Description copied from interface: ActionTokenHandler

Performs the action as per the token details. This method is only called if all verifiers returned in ActionTokenHandler.handleToken(T, org.keycloak.authentication.actiontoken.ActionTokenContext<T>) succeed.

Returns:

canUseTokenRepeatedly

public boolean canUseTokenRepeatedly(ResetCredentialsActionToken token,
 ActionTokenContext tokenContext)

Description copied from interface: ActionTokenHandler

Returns true when the token can be used repeatedly to invoke the action, false when the token is intended to be for single use only.

Specified by:

canUseTokenRepeatedly in interface ActionTokenHandler<ResetCredentialsActionToken>

Overrides:

canUseTokenRepeatedly in class AbstractActionTokenHandler<ResetCredentialsActionToken>

Returns:

see above