io.jsonwebtoken

Interface Locator<T>

Type Parameters:

T - the type of object that may be returned from the locate(Header) method

All Known Implementing Classes:

LocatorAdapter

public interface Locator<T>

A Locator can return an object referenced in a JWT Header that is necessary to process the associated JWT.

For example, a Locator implementation can inspect a header's kid (Key ID) parameter, and use the discovered kid value to lookup and return the associated Key instance. JJWT could then use this key to decrypt a JWE or verify a JWS signature.

Since:

0.12.0

Method Summary

Methods

Modifier and Type	Method and Description
T	locate(Header header) Returns an object referenced in the specified header, or null if the object couldn't be found.

Method Detail

locate

T locate(Header header)

Returns an object referenced in the specified header, or null if the object couldn't be found.

Parameters:

header - the JWT header to inspect; may be an instance of Header, JwsHeader or JweHeader depending on if the respective JWT is an unprotected JWT, JWS or JWE.

Returns:

an object referenced in the specified header, or null if the object couldn't be found.