io.jsonwebtoken.ClaimJwtException 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;

/**
 * ClaimJwtException is a subclass of the {@link JwtException} that is thrown after a validation of an JWT claim failed.
 *
 * @since 0.5
 */
public abstract class ClaimJwtException extends JwtException {

    /**
     * Deprecated as this is an implementation detail accidentally exposed in the JJWT 0.5 public API. It is no
     * longer referenced anywhere in JJWT's implementation and will be removed in a future release.
     *
     * @deprecated will be removed in a future release.
     */
    @Deprecated
    public static final String INCORRECT_EXPECTED_CLAIM_MESSAGE_TEMPLATE = "Expected %s claim to be: %s, but was: %s.";

    /**
     * Deprecated as this is an implementation detail accidentally exposed in the JJWT 0.5 public API. It is no
     * longer referenced anywhere in JJWT's implementation and will be removed in a future release.
     *
     * @deprecated will be removed in a future release.
     */
    @Deprecated
    public static final String MISSING_EXPECTED_CLAIM_MESSAGE_TEMPLATE = "Expected %s claim to be: %s, but was not present in the JWT claims.";

    /**
     * The header associated with the Claims that failed validation.
     */
    private final Header header;

    /**
     * The Claims that failed validation.
     */
    private final Claims claims;

    /**
     * Creates a new instance with the specified header, claims and exception message.
     *
     * @param header  the header inspected
     * @param claims  the claims obtained
     * @param message the exception message
     */
    protected ClaimJwtException(Header header, Claims claims, String message) {
        super(message);
        this.header = header;
        this.claims = claims;
    }

    /**
     * Creates a new instance with the specified header, claims and exception message as a result of encountering
     * the specified {@code cause}.
     *
     * @param header  the header inspected
     * @param claims  the claims obtained
     * @param message the exception message
     * @param cause   the exception that caused this ClaimJwtException to be thrown.
     */
    protected ClaimJwtException(Header header, Claims claims, String message, Throwable cause) {
        super(message, cause);
        this.header = header;
        this.claims = claims;
    }

    /**
     * Returns the {@link Claims} that failed validation.
     *
     * @return the {@link Claims} that failed validation.
     */
    public Claims getClaims() {
        return claims;
    }

    /**
     * Returns the header associated with the {@link #getClaims() claims} that failed validation.
     *
     * @return the header associated with the {@link #getClaims() claims} that failed validation.
     */
    public Header getHeader() {
        return header;
    }
}