Package org.keycloak.authentication.actiontoken.inviteorg

Class InviteOrgActionTokenHandler

java.lang.Object

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

org.keycloak.authentication.actiontoken.inviteorg.InviteOrgActionTokenHandler

All Implemented Interfaces:

ActionTokenHandler<InviteOrgActionToken>, ActionTokenHandlerFactory<InviteOrgActionToken>, Provider, ProviderFactory<ActionTokenHandler<InviteOrgActionToken>>

public class InviteOrgActionTokenHandler
extends AbstractActionTokenHandler<InviteOrgActionToken>

Action token handler for handling invitation of an existing user to an organization. A new user is handled in registration LoginActionsService.

Constructor Summary

Constructors

Constructor	Description
InviteOrgActionTokenHandler()

Method Summary

Modifier and Type	Method	Description
TokenVerifier.Predicate<? super InviteOrgActionToken>[]	getVerifiers(ActionTokenContext<InviteOrgActionToken> tokenContext)	Returns an array of verifiers that are tested prior to handling the token.
jakarta.ws.rs.core.Response	handleToken(InviteOrgActionToken token, ActionTokenContext<InviteOrgActionToken> tokenContext)	Performs the action as per the token details.
jakarta.ws.rs.core.Response	preHandleToken(InviteOrgActionToken token, ActionTokenContext<InviteOrgActionToken> tokenContext)	This method allows to parse the token and extract information from it after initial verification.

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

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

dependsOn, getConfigMetadata, order

Constructor Details

InviteOrgActionTokenHandler

public InviteOrgActionTokenHandler()

Method Details

getVerifiers

public TokenVerifier.Predicate<? super InviteOrgActionToken>[] getVerifiers(ActionTokenContext<InviteOrgActionToken> 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.

preHandleToken

public jakarta.ws.rs.core.Response preHandleToken(InviteOrgActionToken token,
 ActionTokenContext<InviteOrgActionToken> tokenContext)

Description copied from interface: ActionTokenHandler

This method allows to parse the token and extract information from it after initial verification.

Parameters:

token - Token.

tokenContext - Token context.

Returns:

Error response if the initial verification fails, null otherwise.

handleToken

public jakarta.ws.rs.core.Response handleToken(InviteOrgActionToken token,
 ActionTokenContext<InviteOrgActionToken> 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: