Interface ActionTokenHandler<T extends JsonWebToken>

    • Method Detail

      • getTokenClass

        Class<T> getTokenClass()
        Returns the Java token class for use with deserialization.
        Returns:
      • getVerifiers

        default TokenVerifier.Predicate<? super T>[] getVerifiers​(ActionTokenContext<T> tokenContext)
        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.
        Parameters:
        tokenContext -
        Returns:
        Verifiers or an empty array. The returned array must not be null.
      • getAuthenticationSessionIdFromToken

        String getAuthenticationSessionIdFromToken​(T token,
                                                   ActionTokenContext<T> tokenContext,
                                                   AuthenticationSessionModel currentAuthSession)
        Returns a compound authentication session ID requested from within the given token that the handler should attempt to join.
        Parameters:
        token - Token. Can be null
        tokenContext -
        currentAuthSession - Authentication session that is currently in progress, null if no authentication session is not set
        Returns:
        Authentication session ID (can be null if the token does not contain authentication session ID)
        See Also:
        AuthenticationSessionCompoundId
      • getDefaultEventError

        String getDefaultEventError()
        Returns an error to be shown in the EventBuilder detail when token handling fails and no more specific error is provided.
        Returns:
      • getDefaultErrorMessage

        String getDefaultErrorMessage()
        Returns an error to be shown in the response when token handling fails and no more specific error message is provided.
        Returns:
      • startFreshAuthenticationSession

        AuthenticationSessionModel startFreshAuthenticationSession​(T token,
                                                                   ActionTokenContext<T> tokenContext)
                                                            throws VerificationException
        Creates a fresh authentication session according to the information from the token. The default implementation creates a new authentication session that requests termination after required actions.
        Parameters:
        token -
        tokenContext -
        Returns:
        Throws:
        VerificationException
      • canUseTokenRepeatedly

        boolean canUseTokenRepeatedly​(T token,
                                      ActionTokenContext<T> 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.
        Returns:
        see above