Package com.nimbusds.openid.connect.sdk.federation.trust

Class DefaultEntityStatementRetriever

java.lang.Object

com.nimbusds.openid.connect.sdk.federation.trust.DefaultEntityStatementRetriever

All Implemented Interfaces:

EntityStatementRetriever

public class DefaultEntityStatementRetriever
extends Object
implements EntityStatementRetriever

The default entity statement retriever for resolving trust chains. Supports the postfix and infix well-known path composition strategies.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_HTTP_CONNECT_TIMEOUT_MS	The default HTTP connect timeout in milliseconds.
static final int	DEFAULT_HTTP_READ_TIMEOUT_MS	The default HTTP read timeout in milliseconds.

Constructor Summary

Constructors

Constructor	Description
DefaultEntityStatementRetriever()	Creates a new entity statement retriever using the default HTTP timeout settings.
DefaultEntityStatementRetriever(int httpConnectTimeoutMs, int httpReadTimeoutMs)	Creates a new entity statement retriever.
DefaultEntityStatementRetriever(HTTPRequestSender httpRequestSender)	Creates a new entity statement retriever.

Method Summary

Modifier and Type	Method	Description
EntityStatement	fetchEntityConfiguration(EntityID target)	Fetches an entity configuration.
EntityStatement	fetchEntityStatement(URI federationAPIEndpoint, EntityID issuer, EntityID subject)	Fetches an entity statement.
int	getHTTPConnectTimeout()	Returns the configured HTTP connect timeout.
int	getHTTPReadTimeout()	Returns the configured HTTP read timeout.
List<URI>	getRecordedRequests()	Returns the running list of the recorded HTTP requests.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_HTTP_CONNECT_TIMEOUT_MS

public static final int DEFAULT_HTTP_CONNECT_TIMEOUT_MS

The default HTTP connect timeout in milliseconds.

See Also:

• Constant Field Values

DEFAULT_HTTP_READ_TIMEOUT_MS

public static final int DEFAULT_HTTP_READ_TIMEOUT_MS

The default HTTP read timeout in milliseconds.

See Also:

• Constant Field Values

Constructor Details

DefaultEntityStatementRetriever

public DefaultEntityStatementRetriever()

Creates a new entity statement retriever using the default HTTP timeout settings.

DefaultEntityStatementRetriever

public DefaultEntityStatementRetriever(int httpConnectTimeoutMs,
 int httpReadTimeoutMs)

Creates a new entity statement retriever.

Parameters:

httpConnectTimeoutMs - The HTTP connect timeout in milliseconds, zero means timeout determined by the underlying HTTP client.

httpReadTimeoutMs - The HTTP read timeout in milliseconds, zero means timeout determined by the underlying HTTP client.

DefaultEntityStatementRetriever

public DefaultEntityStatementRetriever(HTTPRequestSender httpRequestSender)

Creates a new entity statement retriever.

Parameters:

httpRequestSender - The HTTP request sender to use. Must not be null.

Method Details

getHTTPConnectTimeout

public int getHTTPConnectTimeout()

Returns the configured HTTP connect timeout.

Returns:

The configured HTTP connect timeout in milliseconds, zero means timeout determined by the underlying HTTP client.

getHTTPReadTimeout

public int getHTTPReadTimeout()

Returns the configured HTTP read timeout.

Returns:

The configured HTTP read timeout in milliseconds, zero means timeout determined by the underlying HTTP client.

fetchEntityConfiguration

public EntityStatement fetchEntityConfiguration(EntityID target)
                                         throws ResolveException

Description copied from interface: EntityStatementRetriever

Fetches an entity configuration.

Specified by:

fetchEntityConfiguration in interface EntityStatementRetriever

Parameters:

target - The entity ID. Must not be null.

Returns:

The entity statement.

Throws:

ResolveException - If fetching failed.

fetchEntityStatement

public EntityStatement fetchEntityStatement(URI federationAPIEndpoint,
 EntityID issuer,
 EntityID subject)
                                     throws ResolveException

Description copied from interface: EntityStatementRetriever

Fetches an entity statement.

Specified by:

fetchEntityStatement in interface EntityStatementRetriever

Parameters:

federationAPIEndpoint - The federation API endpoint. Must not be null.

issuer - The entity statement issuer, typically the ID of the entity operating the endpoint. Must not be null.

subject - The entity statement subject. Must not be null.

Returns:

The entity statement.

Throws:

ResolveException - If fetching failed.

getRecordedRequests

public List<URI> getRecordedRequests()

Returns the running list of the recorded HTTP requests.

Returns:

The HTTP request URIs (with query parameters), empty if none.