org.opensaml.util.resource

Class HttpResource

java.lang.Object

org.opensaml.util.resource.AbstractFilteredResource

org.opensaml.util.resource.HttpResource

All Implemented Interfaces:

Resource

Direct Known Subclasses:

FileBackedHttpResource

public class HttpResource
extends AbstractFilteredResource

A resource representing a file retrieved from a URL using Apache Commons HTTPClient.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	HttpResource.ConnectionClosingInputStream A wrapper around the InputStream returned by a HttpMethod that closes the stream and releases the HTTP connection when HttpResource.ConnectionClosingInputStream.close() is invoked.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	CONNECTION_TIMEOUT HttpClient connection timeout in milliseconds.
private org.apache.commons.httpclient.HttpClient	httpClient HTTP client.
private String	resourceUrl HTTP URL of the resource.
private static int	SOCKET_TIMEOUT HttpClient socket timeout in milliseconds.

Constructor Summary

Constructors

Constructor and Description
HttpResource(String resource) Constructor.
HttpResource(String resource, ResourceFilter resourceFilter) Deprecated. use AbstractFilteredResource.setResourceFilter(ResourceFilter) instead

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
boolean	exists() Checks whether the resource exists.
InputStream	getInputStream() Gets the inputstream to the resource's data.
org.joda.time.DateTime	getLastModifiedTime() Gets the date and time the resource was last modified.
String	getLocation() Gets resource location information.
protected org.apache.commons.httpclient.methods.GetMethod	getResource() Gets remote resource.
int	hashCode()
String	toString()

Methods inherited from class org.opensaml.util.resource.AbstractFilteredResource

applyFilter, getResourceFilter, setResourceFilter

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CONNECTION_TIMEOUT

private static final int CONNECTION_TIMEOUT

HttpClient connection timeout in milliseconds.

See Also:

Constant Field Values

SOCKET_TIMEOUT

private static final int SOCKET_TIMEOUT

HttpClient socket timeout in milliseconds.

See Also:

Constant Field Values

resourceUrl

private String resourceUrl

HTTP URL of the resource.

httpClient

private org.apache.commons.httpclient.HttpClient httpClient

HTTP client.

Constructor Detail

HttpResource

public HttpResource(String resource)

Constructor.

Parameters:

resource - HTTP(S) URL of the resource

HttpResource

public HttpResource(String resource,
            ResourceFilter resourceFilter)

Deprecated. use AbstractFilteredResource.setResourceFilter(ResourceFilter) instead

Constructor.

Parameters:

resource - HTTP(S) URL of the resource

resourceFilter - filter to apply to this resource

Method Detail

exists

public boolean exists()
               throws ResourceException

Checks whether the resource exists.

Returns:

true if the resource exists, false if not

Throws:

ResourceException - thrown if there is a problem determining if the resource exists

getInputStream

public InputStream getInputStream()
                           throws ResourceException

Gets the inputstream to the resource's data.

Returns:

inputstream to the resource's data

Throws:

ResourceException - thrown if an input stream can not be created for the resource

getLastModifiedTime

public org.joda.time.DateTime getLastModifiedTime()
                                           throws ResourceException

Gets the date and time the resource was last modified.

Returns:

date and time the resource was last modified

Throws:

ResourceException - thrown if the last modified time can not be determined

getLocation

public String getLocation()

Gets resource location information. Examples might be filesystem path, URL, etc.

Returns:

resource location information

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getResource

protected org.apache.commons.httpclient.methods.GetMethod getResource()
                                                               throws ResourceException

Gets remote resource.

Returns:

the remove resource

Throws:

ResourceException - thrown if the resource could not be fetched