io.jsonwebtoken.JwtHandler Maven / Gradle / Ivy

/*
 * Copyright (C) 2014 jsonwebtoken.io
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.jsonwebtoken;

/**
 * A JwtHandler is invoked by a {@link io.jsonwebtoken.JwtParser JwtParser} after parsing a JWT to indicate the exact
 * type of JWT, JWS or JWE parsed.
 *
 * @param  the type of object to return to the parser caller after handling the parsed JWT.
 * @since 0.2
 * @deprecated since 0.12.0 in favor of calling {@link Jwt#accept(JwtVisitor)}.
 */
@SuppressWarnings("DeprecatedIsStillUsed")
@Deprecated
public interface JwtHandler extends JwtVisitor {

    /**
     * This method is invoked when a {@link io.jsonwebtoken.JwtParser JwtParser} determines that the parsed JWT is
     * an unsecured content JWT.  An unsecured content JWT has a byte array payload that is not
     * cryptographically signed or encrypted.  If the JWT creator set the (optional)
     * {@link Header#getContentType() contentType} header value, the application may inspect that value to determine
     * how to convert the byte array to the final content type as desired.
     *
     * @param jwt the parsed unsecured content JWT
     * @return any object to be used after inspecting the JWT, or {@code null} if no return value is necessary.
     */
    T onContentJwt(Jwt jwt);

    /**
     * This method is invoked when a {@link io.jsonwebtoken.JwtParser JwtParser} determines that the parsed JWT is
     * a Claims JWT.  A Claims JWT has a {@link Claims} payload that is not cryptographically signed or encrypted.
     *
     * @param jwt the parsed claims JWT
     * @return any object to be used after inspecting the JWT, or {@code null} if no return value is necessary.
     */
    T onClaimsJwt(Jwt jwt);

    /**
     * This method is invoked when a {@link io.jsonwebtoken.JwtParser JwtParser} determines that the parsed JWT is
     * a content JWS.  A content JWS is a JWT with a byte array payload that has been cryptographically signed.
     * If the JWT creator set the (optional) {@link Header#getContentType() contentType} header value, the
     * application may inspect that value to determine how to convert the byte array to the final content type
     * as desired.
     *
     * This method will only be invoked if the cryptographic signature can be successfully verified.
     *
     * @param jws the parsed content JWS
     * @return any object to be used after inspecting the JWS, or {@code null} if no return value is necessary.
     */
    T onContentJws(Jws jws);

    /**
     * This method is invoked when a {@link io.jsonwebtoken.JwtParser JwtParser} determines that the parsed JWT is
     * a valid Claims JWS.  A Claims JWS is a JWT with a {@link Claims} payload that has been cryptographically signed.
     *
     * This method will only be invoked if the cryptographic signature can be successfully verified.
     *
     * @param jws the parsed claims JWS
     * @return any object to be used after inspecting the JWS, or {@code null} if no return value is necessary.
     */
    T onClaimsJws(Jws jws);

    /**
     * This method is invoked when a {@link io.jsonwebtoken.JwtParser JwtParser} determines that the parsed JWT is
     * a content JWE.  A content JWE is a JWE with a byte array payload that has been encrypted. If the JWT creator set
     * the (optional) {@link Header#getContentType() contentType} header value, the application may inspect that
     * value to determine how to convert the byte array to the final content type as desired.
     *
     * This method will only be invoked if the content JWE can be successfully decrypted.
     *
     * @param jwe the parsed content jwe
     * @return any object to be used after inspecting the JWE, or {@code null} if no return value is necessary.
     * @since 0.12.0
     */
    T onContentJwe(Jwe jwe);

    /**
     * This method is invoked when a {@link io.jsonwebtoken.JwtParser JwtParser} determines that the parsed JWT is
     * a valid Claims JWE.  A Claims JWE is a JWT with a {@link Claims} payload that has been encrypted.
     *
     * This method will only be invoked if the Claims JWE can be successfully decrypted.
     *
     * @param jwe the parsed claims jwe
     * @return any object to be used after inspecting the JWE, or {@code null} if no return value is necessary.
     * @since 0.12.0
     */
    T onClaimsJwe(Jwe jwe);

}