io.jsonwebtoken

Class SigningKeyResolverAdapter

java.lang.Object

io.jsonwebtoken.SigningKeyResolverAdapter

All Implemented Interfaces:

SigningKeyResolver

public class SigningKeyResolverAdapter
extends Object
implements SigningKeyResolver

An Adapter implementation of the SigningKeyResolver interface that allows subclasses to process only the type of JWS body that is known/expected for a particular case.

The resolveSigningKey(JwsHeader, Claims) and resolveSigningKey(JwsHeader, String) method implementations delegate to the resolveSigningKeyBytes(JwsHeader, Claims) and resolveSigningKeyBytes(JwsHeader, String) methods respectively. The latter two methods simply throw exceptions: they represent scenarios expected by calling code in known situations, and it is expected that you override the implementation in those known situations; non-overridden *KeyBytes methods indicates that the JWS input was unexpected.

If either resolveSigningKey(JwsHeader, String) or resolveSigningKey(JwsHeader, Claims) are not overridden, one (or both) of the *KeyBytes variants must be overridden depending on your expected use case. You do not have to override any method that does not represent an expected condition.

Since:

0.4

Constructor Summary

Constructors

Constructor and Description
SigningKeyResolverAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
Key	resolveSigningKey(JwsHeader header, Claims claims) Returns the signing key that should be used to validate a digital signature for the Claims JWS with the specified header and claims.
Key	resolveSigningKey(JwsHeader header, String plaintext) Returns the signing key that should be used to validate a digital signature for the Plaintext JWS with the specified header and plaintext payload.
byte[]	resolveSigningKeyBytes(JwsHeader header, Claims claims) Convenience method invoked by resolveSigningKey(JwsHeader, Claims) that obtains the necessary signing key bytes.
byte[]	resolveSigningKeyBytes(JwsHeader header, String payload) Convenience method invoked by resolveSigningKey(JwsHeader, String) that obtains the necessary signing key bytes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SigningKeyResolverAdapter

public SigningKeyResolverAdapter()

Method Detail

resolveSigningKey

public Key resolveSigningKey(JwsHeader header,
                    Claims claims)

Description copied from interface: SigningKeyResolver

Returns the signing key that should be used to validate a digital signature for the Claims JWS with the specified header and claims.

Specified by:

resolveSigningKey in interface SigningKeyResolver

Parameters:

header - the header of the JWS to validate

claims - the claims (body) of the JWS to validate

Returns:

the signing key that should be used to validate a digital signature for the Claims JWS with the specified header and claims.

resolveSigningKey

public Key resolveSigningKey(JwsHeader header,
                    String plaintext)

Description copied from interface: SigningKeyResolver

Returns the signing key that should be used to validate a digital signature for the Plaintext JWS with the specified header and plaintext payload.

Specified by:

resolveSigningKey in interface SigningKeyResolver

Parameters:

header - the header of the JWS to validate

plaintext - the plaintext body of the JWS to validate

Returns:

the signing key that should be used to validate a digital signature for the Plaintext JWS with the specified header and plaintext payload.

resolveSigningKeyBytes

public byte[] resolveSigningKeyBytes(JwsHeader header,
                            Claims claims)

Convenience method invoked by resolveSigningKey(JwsHeader, Claims) that obtains the necessary signing key bytes. This implementation simply throws an exception: if the JWS parsed is a Claims JWS, you must override this method or the resolveSigningKey(JwsHeader, Claims) method instead.

NOTE: You cannot override this method when validating RSA signatures. If you expect RSA signatures, you must override the resolveSigningKey(JwsHeader, Claims) method instead.

Parameters:

header - the parsed JwsHeader

claims - the parsed Claims

Returns:

the signing key bytes to use to verify the JWS signature.

resolveSigningKeyBytes

public byte[] resolveSigningKeyBytes(JwsHeader header,
                            String payload)

Convenience method invoked by resolveSigningKey(JwsHeader, String) that obtains the necessary signing key bytes. This implementation simply throws an exception: if the JWS parsed is a plaintext JWS, you must override this method or the resolveSigningKey(JwsHeader, String) method instead.

Parameters:

header - the parsed JwsHeader

payload - the parsed String plaintext payload

Returns:

the signing key bytes to use to verify the JWS signature.