com.nimbusds.jwt.JWTHandler Maven / Gradle / Ivy

Go to download

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

Java library for Javascript Object Signing and Encryption (JOSE) and JSON Web Tokens (JWT)

There is a newer version: 10.0.2

package com.nimbusds.jwt;


/**
 * Handler of parsed {@link JWT JSON Web Tokens} (JWT). Invoked by a
 * {@link JWTParser} after parsing a JWT to indicate its exact type -
 * {@link PlainJWT plain}, {@link SignedJWT signed} or
 * {@link EncryptedJWT encrypted}.
 *
 * @since 3.4
 */
public interface JWTHandler {


	/**
	 * Invoked when the {@link JWTParser} determines that the parsed JWT is
	 * plain (unsecured).
	 *
	 * @param plainJWT The parsed plain JWT. Not {@code null}.
	 *
	 * @return Any object to be used after inspecting the JWT, or
	 *         {@code null} if no return value is necessary.
	 */
	public T onPlainJWT(final PlainJWT plainJWT);


	/**
	 * Invoked when the {@link JWTParser} determines that the parsed JWT is
	 * signed (JWS).
	 *
	 * @param signedJWT The parsed signed JWT. Not {@code null}.
	 *
	 * @return Any object to be used after inspecting the JWT, or
	 *         {@code null} if no return value is necessary.
	 */
	public T onSignedJWT(final SignedJWT signedJWT);


	/**
	 * Invoked when the {@link JWTParser} determines that the parsed JWT is
	 * encrypted (JWE).
	 *
	 * @param encryptedJWT The parsed encrypted JWT. Not {@code null}.
	 *
	 * @return Any object to be used after inspecting the JWT, or
	 *         {@code null} if no return value is necessary.
	 */
	public T onEncryptedJWT(final EncryptedJWT encryptedJWT);
}