Class UpdateEmailActionTokenHandler
- java.lang.Object
-
- org.keycloak.authentication.actiontoken.AbstractActionTokenHandler<UpdateEmailActionToken>
-
- org.keycloak.authentication.actiontoken.updateemail.UpdateEmailActionTokenHandler
-
- All Implemented Interfaces:
ActionTokenHandler<UpdateEmailActionToken>
,ActionTokenHandlerFactory<UpdateEmailActionToken>
,Provider
,ProviderFactory<ActionTokenHandler<UpdateEmailActionToken>>
public class UpdateEmailActionTokenHandler extends AbstractActionTokenHandler<UpdateEmailActionToken>
-
-
Constructor Summary
Constructors Constructor Description UpdateEmailActionTokenHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canUseTokenRepeatedly(UpdateEmailActionToken token, ActionTokenContext<UpdateEmailActionToken> tokenContext)
Returnstrue
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 UpdateEmailActionToken>[]
getVerifiers(ActionTokenContext<UpdateEmailActionToken> tokenContext)
Returns an array of verifiers that are tested prior to handling the token.javax.ws.rs.core.Response
handleToken(UpdateEmailActionToken token, ActionTokenContext<UpdateEmailActionToken> 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.provider.ProviderFactory
getConfigMetadata, order
-
-
-
-
Method Detail
-
getVerifiers
public TokenVerifier.Predicate<? super UpdateEmailActionToken>[] getVerifiers(ActionTokenContext<UpdateEmailActionToken> 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 benull
.- Returns:
- Verifiers or an empty array. The returned array must not be
null
.
-
handleToken
public javax.ws.rs.core.Response handleToken(UpdateEmailActionToken token, ActionTokenContext<UpdateEmailActionToken> tokenContext)
Description copied from interface:ActionTokenHandler
Performs the action as per the token details. This method is only called if all verifiers returned inActionTokenHandler.handleToken(T, org.keycloak.authentication.actiontoken.ActionTokenContext<T>)
succeed.- Returns:
-
canUseTokenRepeatedly
public boolean canUseTokenRepeatedly(UpdateEmailActionToken token, ActionTokenContext<UpdateEmailActionToken> tokenContext)
Description copied from interface:ActionTokenHandler
Returnstrue
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 interfaceActionTokenHandler<UpdateEmailActionToken>
- Overrides:
canUseTokenRepeatedly
in classAbstractActionTokenHandler<UpdateEmailActionToken>
- Returns:
- see above
-
-