org.opensaml.util.resource

Class FilesystemResource

java.lang.Object

org.opensaml.util.resource.AbstractFilteredResource

org.opensaml.util.resource.FilesystemResource

All Implemented Interfaces:

Resource

public class FilesystemResource
extends AbstractFilteredResource

A resource representing a file on the local filesystem.

Field Summary

Fields

Modifier and Type	Field and Description
private File	resource The file represented by this resource.

Constructor Summary

Constructors

Constructor and Description
FilesystemResource(String resourcePath) Constructor.
FilesystemResource(String resourcePath, ResourceFilter resourceFilter) Deprecated. use AbstractFilteredResource.setResourceFilter(ResourceFilter) instead
FilesystemResource(URI resourceURI) Constructor.
FilesystemResource(URI resourceURI, 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.
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

resource

private File resource

The file represented by this resource.

Constructor Detail

FilesystemResource

public FilesystemResource(String resourcePath)
                   throws ResourceException

Constructor.

Parameters:

resourcePath - the path to the file for this resource

Throws:

ResourceException - thrown if the resource path is null or empty

FilesystemResource

public FilesystemResource(URI resourceURI)
                   throws ResourceException

Constructor.

Parameters:

resourceURI - file: URI to the file

Throws:

ResourceException - thrown if the resource path is null or empty

Since:

1.2.0

FilesystemResource

public FilesystemResource(String resourcePath,
                  ResourceFilter resourceFilter)
                   throws ResourceException

Deprecated. use AbstractFilteredResource.setResourceFilter(ResourceFilter) instead

Constructor.

Parameters:

resourcePath - the path to the file for this resource

resourceFilter - filter to apply to this resource

Throws:

ResourceException - thrown if the resource path is null or empty

FilesystemResource

public FilesystemResource(URI resourceURI,
                  ResourceFilter resourceFilter)
                   throws ResourceException

Deprecated. use AbstractFilteredResource.setResourceFilter(ResourceFilter) instead

Constructor.

Parameters:

resourceURI - the file: URI to the file for this resource

resourceFilter - filter to apply to this resource

Throws:

ResourceException - thrown if the resource path is null or empty

Since:

1.2.0

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