Package com.nimbusds.oauth2.sdk.jose.jwk

Class RemoteJWKSet

java.lang.Object

com.nimbusds.oauth2.sdk.jose.jwk.RemoteJWKSet

All Implemented Interfaces:

JWKSource

@ThreadSafe
@Deprecated
public class RemoteJWKSet
extends Object

Deprecated.

Remote JSON Web Key (JWK) set. Intended for a JWK set specified by URL reference. The retrieved JWK set is cached.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_HTTP_CONNECT_TIMEOUT	Deprecated. The default HTTP connect timeout for JWK set retrieval, in milliseconds.
static int	DEFAULT_HTTP_READ_TIMEOUT	Deprecated. The default HTTP read timeout for JWK set retrieval, in milliseconds.
static int	DEFAULT_HTTP_SIZE_LIMIT	Deprecated. The default HTTP entity size limit for JWK set retrieval, in bytes.

Constructor Summary

Constructors

Constructor	Description
RemoteJWKSet(Identifier id, URL jwkSetURL, RestrictedResourceRetriever resourceRetriever)	Deprecated. Creates a new remote JWK set.

Method Summary

Modifier and Type	Method	Description
List<com.nimbusds.jose.jwk.JWK>	get(Identifier id, com.nimbusds.jose.jwk.JWKSelector jwkSelector)	Deprecated. Retrieves a list of JWKs matching the specified criteria.
protected static String	getFirstSpecifiedKeyID(com.nimbusds.jose.jwk.JWKMatcher jwkMatcher)	Deprecated. Returns the first specified key ID (kid) for a JWK matcher.
com.nimbusds.jose.jwk.JWKSet	getJWKSet()	Deprecated. Returns the cached JWK set.
URL	getJWKSetURL()	Deprecated. Returns the JWK set URL.
Identifier	getOwner()	Deprecated. Returns the owner identifier.
RestrictedResourceRetriever	getResourceRetriever()	Deprecated. Returns the HTTP resource retriever.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HTTP_CONNECT_TIMEOUT

public static final int DEFAULT_HTTP_CONNECT_TIMEOUT

Deprecated.

The default HTTP connect timeout for JWK set retrieval, in milliseconds. Set to 250 milliseconds.

See Also:

Constant Field Values

DEFAULT_HTTP_READ_TIMEOUT

public static final int DEFAULT_HTTP_READ_TIMEOUT

Deprecated.

The default HTTP read timeout for JWK set retrieval, in milliseconds. Set to 250 milliseconds.

See Also:

Constant Field Values

DEFAULT_HTTP_SIZE_LIMIT

public static final int DEFAULT_HTTP_SIZE_LIMIT

Deprecated.

The default HTTP entity size limit for JWK set retrieval, in bytes. Set to 50 KBytes.

See Also:

Constant Field Values

Constructor Detail

RemoteJWKSet

public RemoteJWKSet(Identifier id,
                    URL jwkSetURL,
                    RestrictedResourceRetriever resourceRetriever)

Deprecated.

Creates a new remote JWK set.

Parameters:

id - The JWK set owner identifier. Typically the OAuth 2.0 server issuer ID, or client ID. Must not be null.

jwkSetURL - The JWK set URL. Must not be null.

resourceRetriever - The HTTP resource retriever to use, null to use the default one.

Method Detail

getJWKSetURL

public URL getJWKSetURL()

Deprecated.

Returns the JWK set URL.

Returns:

The JWK set URL.

getResourceRetriever

public RestrictedResourceRetriever getResourceRetriever()

Deprecated.

Returns the HTTP resource retriever.

Returns:

The HTTP resource retriever.

getJWKSet

public com.nimbusds.jose.jwk.JWKSet getJWKSet()

Deprecated.

Returns the cached JWK set.

Returns:

The cached JWK set, null if none.

getFirstSpecifiedKeyID

protected static String getFirstSpecifiedKeyID(com.nimbusds.jose.jwk.JWKMatcher jwkMatcher)

Deprecated.

Returns the first specified key ID (kid) for a JWK matcher.

Parameters:

jwkMatcher - The JWK matcher. Must not be null.

Returns:

The first key ID, null if none.

get

public List<com.nimbusds.jose.jwk.JWK> get(Identifier id,
                                           com.nimbusds.jose.jwk.JWKSelector jwkSelector)

Deprecated.

Description copied from interface: JWKSource

Retrieves a list of JWKs matching the specified criteria.

Parameters:

id - Identifier of the JWK owner, typically an Authorisation Server / OpenID Provider issuer ID, or client ID. Must not be null.

jwkSelector - A JWK selector. Must not be null.

Returns:

The matching JWKs, empty list if no matches were found or retrieval failed.

getOwner

public Identifier getOwner()

Deprecated.

Returns the owner identifier.

Returns:

The owner identifier.