net.shibboleth.ext.spring.resource

Class HTTPResource

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.ext.spring.resource.HTTPResource

All Implemented Interfaces:

Component, DestructableComponent, IdentifiedComponent, InitializableComponent, Resource, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.core.io.InputStreamSource

Direct Known Subclasses:

FileBackedHTTPResource

public class HTTPResource
extends AbstractIdentifiedInitializableComponent
implements org.springframework.core.io.Resource, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, Resource

Resource for looking up HTTP URLs. Allows injection and therefore configuration of an Apache HttpClient. Code based on OpenSAML HTTPMetadataResolver and UrlResource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	HTTPResource.ConnectionClosingInputStream A wrapper around the entity content InputStream represented by an HttpResponse that closes the stream and the HttpResponse when HTTPResource.ConnectionClosingInputStream.close() is invoked.

Field Summary

Fields

Modifier and Type	Field and Description
private HttpClient	httpClient HTTP Client used to pull the resource.
private HttpClientContextHandler	httpClientContextHandler Optional handler to pre- and post-process context.
private org.slf4j.Logger	log Class logger.
private URL	resourceURL URL to the Resource.

Constructor Summary

Constructors

Constructor and Description
HTTPResource(HttpClient client, String url) Constructor.
HTTPResource(HttpClient client, URL url) Constructor.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected HttpCacheContext	buildHttpClientContext() Build the HttpCacheContext instance which will be used to invoke the HttpClient request.
protected void	closeResponse(org.apache.http.HttpResponse response) Close the HTTP response.
long	contentLength()
HTTPResource	createRelative(String relativePath) Based on UrlResource.
Resource	createRelativeResource(String relativePath)
boolean	exists()
String	getDescription()
File	getFile() Based on UrlResource.
String	getFilename() This implementation returns the name of the file that this URL refers to.
InputStream	getInputStream()
protected org.apache.http.HttpResponse	getResourceHeaders() Attempts to fetch only the headers for a given resource.
protected String	getResponseHeader(String what) Send a Head to the client and interrogate the response for a particular response header.
URI	getURI()
URL	getURL()
boolean	isOpen()
boolean	isReadable()
long	lastModified()
protected void	reportCachingStatus(HttpCacheContext context) Print out to the log whether we hit the apache cache or not.
void	setBeanName(String name)
void	setHttpClientContextHandler(HttpClientContextHandler handler) Set a handler to manipulate the HttpClientContext.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

doInitialize, getId, setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

httpClient

@Nonnull
private final HttpClient httpClient

HTTP Client used to pull the resource.

resourceURL

@Nonnull
private final URL resourceURL

URL to the Resource.

httpClientContextHandler

@Nullable
private HttpClientContextHandler httpClientContextHandler

Optional handler to pre- and post-process context.

Constructor Detail

HTTPResource

public HTTPResource(@Nonnull @ParameterName(name="client")
                    HttpClient client,
                    @Nonnull @NotEmpty @ParameterName(name="url")
                    String url)
             throws IOException

Constructor.

Parameters:

client - the client we use to connect with.

url - URL to the remote data

Throws:

IOException - if the URL was badly formed

HTTPResource

public HTTPResource(@Nonnull @ParameterName(name="")
                    HttpClient client,
                    @Nonnull @ParameterName(name="url")
                    URL url)
             throws IOException

Constructor.

Parameters:

client - the client we use to connect with.

url - URL to the remote data

Throws:

IOException - if the URL was badly formed

Method Detail

setHttpClientContextHandler

public void setHttpClientContextHandler(@Nonnull
                                        HttpClientContextHandler handler)

Set a handler to manipulate the HttpClientContext.

Parameters:

handler - the handler to install

Since:

5.4.0

buildHttpClientContext

protected HttpCacheContext buildHttpClientContext()

Build the HttpCacheContext instance which will be used to invoke the HttpClient request.

Returns:

a new instance of HttpCacheContext

reportCachingStatus

protected void reportCachingStatus(HttpCacheContext context)

Print out to the log whether we hit the apache cache or not. http://hc.apache.org/httpcomponents-client-ga/tutorial/html/caching.html

Parameters:

context - the context of the request

getInputStream

public InputStream getInputStream()
                           throws IOException

Specified by:

getInputStream in interface Resource

Specified by:

getInputStream in interface org.springframework.core.io.InputStreamSource

Throws:

IOException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

exists

public boolean exists()

Specified by:

exists in interface Resource

isReadable

public boolean isReadable()

Specified by:

isReadable in interface Resource

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Resource

getURL

public URL getURL()
           throws IOException

Specified by:

getURL in interface Resource

Throws:

IOException

getURI

public URI getURI()
           throws IOException

Specified by:

getURI in interface Resource

Throws:

IOException

getFile

public File getFile()
             throws IOException

Based on UrlResource.

Specified by:

getFile in interface Resource

Throws:

IOException

getResourceHeaders

protected org.apache.http.HttpResponse getResourceHeaders()
                                                   throws IOException

Attempts to fetch only the headers for a given resource. If HEAD requests are unsupported than a more costly GET request is performed.

Returns:

the response from the request

Throws:

IOException - thrown if there is a problem contacting the resource

getResponseHeader

@Nullable
protected String getResponseHeader(String what)
                                      throws IOException

Send a Head to the client and interrogate the response for a particular response header.

Parameters:

what - the repsonse header to look at

Returns:

the value of that response, or null if things failed

Throws:

IOException - from lower levels.

contentLength

public long contentLength()
                   throws IOException

Specified by:

contentLength in interface Resource

Throws:

IOException

lastModified

public long lastModified()
                  throws IOException

Specified by:

lastModified in interface Resource

Throws:

IOException

createRelative

public HTTPResource createRelative(String relativePath)
                            throws IOException

Based on UrlResource.

Throws:

IOException

createRelativeResource

public Resource createRelativeResource(String relativePath)
                                throws IOException

Specified by:

createRelativeResource in interface Resource

Throws:

IOException

getFilename

public String getFilename()

This implementation returns the name of the file that this URL refers to.

Specified by:

getFilename in interface Resource

See Also:

URL.getFile(), File.getName()

getDescription

public String getDescription()

Specified by:

getDescription in interface Resource

closeResponse

protected void closeResponse(@Nullable
                             org.apache.http.HttpResponse response)

Close the HTTP response.

Parameters:

response - the HTTP response