com.auth0.jwt.interfaces.JWTPartsParser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-jwt Show documentation

Java implementation of JSON Web Token (JWT)

There is a newer version: 4.4.0

package com.auth0.jwt.interfaces;

import com.auth0.jwt.exceptions.JWTDecodeException;

/**
 * The JWTPartsParser class defines which parts of the JWT should be converted
 * to its specific Object representation instance.
 */
public interface JWTPartsParser {

    /**
     * Parses the given JSON into a {@link Payload} instance.
     *
     * @param json the content of the Payload in a JSON representation.
     * @return the Payload.
     * @throws JWTDecodeException if the json doesn't have a proper JSON format.
     */
    Payload parsePayload(String json) throws JWTDecodeException;

    /**
     * Parses the given JSON into a {@link Header} instance.
     *
     * @param json the content of the Header in a JSON representation.
     * @return the Header.
     * @throws JWTDecodeException if the json doesn't have a proper JSON format.
     */
    Header parseHeader(String json) throws JWTDecodeException;
}