io.jsonwebtoken

Class LocatorAdapter<T>

java.lang.Object

io.jsonwebtoken.LocatorAdapter<T>

Type Parameters:

T - the type of object to locate

All Implemented Interfaces:

Locator<T>

public abstract class LocatorAdapter<T>
extends Object
implements Locator<T>

Adapter pattern implementation for the Locator interface. Subclasses can override any of the doLocate(Header), locate(ProtectedHeader), locate(JwsHeader), or locate(JweHeader) methods for type-specific logic if desired when the encountered header is an unprotected JWT, or an integrity-protected JWT (either a JWS or JWE).

Since:

0.12.0

Constructor Summary

Constructors

Constructor and Description
LocatorAdapter() Constructs a new instance, where all default method implementations return null.

Method Summary

Methods

Modifier and Type	Method and Description
protected T	doLocate(Header header) Returns an object referenced in the specified unprotected JWT header, or null if the referenced object cannot be found or does not exist.
T	locate(Header header) Inspects the specified header, and delegates to the locate(ProtectedHeader) method if the header is protected (either a JwsHeader or JweHeader), or the doLocate(Header) method if the header is not integrity protected.
protected T	locate(JweHeader header) Returns an object referenced in the specified JWE header, or null if the referenced object cannot be found or does not exist.
protected T	locate(JwsHeader header) Returns an object referenced in the specified JWS header, or null if the referenced object cannot be found or does not exist.
protected T	locate(ProtectedHeader header) Returns an object referenced in the specified ProtectedHeader, or null if the referenced object cannot be found or does not exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocatorAdapter

public LocatorAdapter()

Constructs a new instance, where all default method implementations return null.

Method Detail

locate

public final T locate(Header header)

Inspects the specified header, and delegates to the locate(ProtectedHeader) method if the header is protected (either a JwsHeader or JweHeader), or the doLocate(Header) method if the header is not integrity protected.

Specified by:

locate in interface Locator<T>

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 referenced object cannot be found or does not exist.

locate

protected T locate(ProtectedHeader header)

Returns an object referenced in the specified ProtectedHeader, or null if the referenced object cannot be found or does not exist. This is a convenience method that delegates to locate(JwsHeader) if the header is a JwsHeader or locate(JweHeader) if the header is a JweHeader.

Parameters:

header - the protected header of an encountered JWS or JWE.

Returns:

an object referenced in the specified ProtectedHeader, or null if the referenced object cannot be found or does not exist.

locate

protected T locate(JweHeader header)

Returns an object referenced in the specified JWE header, or null if the referenced object cannot be found or does not exist. Default implementation simply returns null.

Parameters:

header - the header of an encountered JWE.

Returns:

an object referenced in the specified JWE header, or null if the referenced object cannot be found or does not exist.

locate

protected T locate(JwsHeader header)

Returns an object referenced in the specified JWS header, or null if the referenced object cannot be found or does not exist. Default implementation simply returns null.

Parameters:

header - the header of an encountered JWS.

Returns:

an object referenced in the specified JWS header, or null if the referenced object cannot be found or does not exist.

doLocate

protected T doLocate(Header header)

Returns an object referenced in the specified unprotected JWT header, or null if the referenced object cannot be found or does not exist. Default implementation simply returns null.

Parameters:

header - the header of an encountered JWT.

Returns:

an object referenced in the specified unprotected JWT header, or null if the referenced object cannot be found or does not exist.