io.jsonwebtoken.JwtHandlerAdapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jjwt-api Show documentation
There is a newer version: 0.12.6
/*
 * 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;

/**
 * An Adapter implementation of the
 * {@link JwtHandler} interface that allows for anonymous subclasses to process only the JWT results that are
 * known/expected for a particular use case.
 *
 * All of the methods in this implementation throw exceptions: overridden methods represent
 * scenarios expected by calling code in known situations.  It would be unexpected to receive a JWT that did
 * not match parsing expectations, so all non-overridden methods throw exceptions to indicate that the JWT
 * input was unexpected.
 *
 * @param  the type of object to return to the parser caller after handling the parsed JWT.
 * @since 0.2
 */
public abstract class JwtHandlerAdapter extends SupportedJwtVisitor implements JwtHandler {

    /**
     * Default constructor, does not initialize any internal state.
     */
    public JwtHandlerAdapter() {
    }

    @Override
    public T onUnsecuredContent(Jwt jwt) {
        return onContentJwt(jwt); // bridge for existing implementations
    }

    @Override
    public T onUnsecuredClaims(Jwt jwt) {
        return onClaimsJwt(jwt);
    }

    @Override
    public T onVerifiedContent(Jws jws) {
        return onContentJws(jws);
    }

    @Override
    public T onVerifiedClaims(Jws jws) {
        return onClaimsJws(jws);
    }

    @Override
    public T onDecryptedContent(Jwe jwe) {
        return onContentJwe(jwe);
    }

    @Override
    public T onDecryptedClaims(Jwe jwe) {
        return onClaimsJwe(jwe);
    }

    @Override
    public T onContentJwt(Jwt jwt) {
        return super.onUnsecuredContent(jwt);
    }

    @Override
    public T onClaimsJwt(Jwt jwt) {
        return super.onUnsecuredClaims(jwt);
    }

    @Override
    public T onContentJws(Jws jws) {
        return super.onVerifiedContent(jws);
    }

    @Override
    public T onClaimsJws(Jws jws) {
        return super.onVerifiedClaims(jws);
    }

    @Override
    public T onContentJwe(Jwe jwe) {
        return super.onDecryptedContent(jwe);
    }

    @Override
    public T onClaimsJwe(Jwe jwe) {
        return super.onDecryptedClaims(jwe);
    }
}