com.nimbusds.jose.util

Class DefaultResourceRetriever

java.lang.Object

com.nimbusds.jose.util.AbstractRestrictedResourceRetriever

com.nimbusds.jose.util.DefaultResourceRetriever

All Implemented Interfaces:

ResourceRetriever, RestrictedResourceRetriever

@ThreadSafe
public class DefaultResourceRetriever
extends AbstractRestrictedResourceRetriever
implements RestrictedResourceRetriever

The default retriever of resources specified by URL. Provides setting of HTTP connect and read timeouts as well as a size limit of the retrieved entity. Caching header directives are not honoured.

Version:

2016-11-28

Author:

Vladimir Dzhuvinov

Constructor Summary

Constructors

Constructor and Description
DefaultResourceRetriever() Creates a new resource retriever.
DefaultResourceRetriever(int connectTimeout, int readTimeout) Creates a new resource retriever.
DefaultResourceRetriever(int connectTimeout, int readTimeout, int sizeLimit) Creates a new resource retriever.

Method Summary

Modifier and Type	Method and Description
Resource	retrieveResource(URL url) Retrieves the resource from the specified HTTP(S) URL.

Methods inherited from class com.nimbusds.jose.util.AbstractRestrictedResourceRetriever

getConnectTimeout, getReadTimeout, getSizeLimit, setConnectTimeout, setReadTimeout, setSizeLimit

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nimbusds.jose.util.RestrictedResourceRetriever

getConnectTimeout, getReadTimeout, getSizeLimit, setConnectTimeout, setReadTimeout, setSizeLimit

Constructor Detail

DefaultResourceRetriever

public DefaultResourceRetriever()

Creates a new resource retriever. The HTTP timeouts and entity size limit are set to zero (infinite).

DefaultResourceRetriever

public DefaultResourceRetriever(int connectTimeout,
                                int readTimeout)

Creates a new resource retriever. The HTTP entity size limit is set to zero (infinite).

Parameters:

connectTimeout - The HTTP connects timeout, in milliseconds, zero for infinite. Must not be negative.

readTimeout - The HTTP read timeout, in milliseconds, zero for infinite. Must not be negative.

DefaultResourceRetriever

public DefaultResourceRetriever(int connectTimeout,
                                int readTimeout,
                                int sizeLimit)

Creates a new resource retriever.

Parameters:

connectTimeout - The HTTP connects timeout, in milliseconds, zero for infinite. Must not be negative.

readTimeout - The HTTP read timeout, in milliseconds, zero for infinite. Must not be negative.

sizeLimit - The HTTP entity size limit, in bytes, zero for infinite. Must not be negative.

Method Detail

retrieveResource

public Resource retrieveResource(URL url)
                          throws IOException

Description copied from interface: ResourceRetriever

Retrieves the resource from the specified HTTP(S) URL.

Specified by:

retrieveResource in interface ResourceRetriever

Parameters:

url - The URL of the resource. Its scheme must be HTTP or HTTPS. Must not be null.

Returns:

The retrieved resource.

Throws:

IOException - If the HTTP connection to the specified URL failed or the resource couldn't be retrieved.