ddf.catalog.resource.impl

Class URLResourceReader

java.lang.Object

ddf.catalog.resource.impl.URLResourceReader

All Implemented Interfaces:

ResourceReader, Describable

public class URLResourceReader
extends Object
implements ResourceReader

A URLResourceReader retrieves a Resource from a local or remote file system using a URI. The URI is used to specify the file location. A URLResourceReader supports URIs with HTTP, HTTPS, and file schemes.

Constructor Summary

Constructors

Constructor and Description
URLResourceReader() Default URLResourceReader constructor.
URLResourceReader(MimeTypeMapper mimeTypeMapper)

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns a description of the describable item.
Boolean	getFollowRedirects() Gets the autoRedirect property
String	getId() Returns the name, aka ID, of the describable item.
MimeTypeMapper	getMimeTypeMapper()
Set<String>	getOptions(Metacard metacard) Obtain a set of all options supported by this ResourceReader.
String	getOrganization() Returns the organization associated with the describable item.
Set<String>	getRootResourceDirectories()
Set<String>	getSupportedSchemes() Supported schemes are HTTP, HTTPS, and file
String	getTitle() Returns the title of the describable item.
Set<String>	getURLSupportedSchemes()
String	getVersion() Retrieve the version.
protected org.apache.cxf.jaxrs.client.WebClient	getWebClient(String uri, Map<String,Serializable> properties)
ResourceResponse	retrieveResource(URI resourceURI, Map<String,Serializable> properties) Retrieves a Resource based on a URI and provided arguments.
void	setFollowRedirects(Boolean redirect) Specifies whether the code should follow server issued redirection (HTTP Response codes between 300 and 400)
void	setMimeTypeMapper(MimeTypeMapper mimeTypeMapper)
void	setRootResourceDirectories(Set<String> rootResourceDirectoryPaths) Sets the directories that the URLResourceReader has permission to access when attempting to download a resource linked by a file URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

URLResourceReader

public URLResourceReader()

Default URLResourceReader constructor.

URLResourceReader

public URLResourceReader(MimeTypeMapper mimeTypeMapper)

Method Detail

getURLSupportedSchemes

public Set<String> getURLSupportedSchemes()

getVersion

public String getVersion()

Description copied from interface: Describable

Retrieve the version.

Specified by:

getVersion in interface Describable

Returns:

the version of the item being described (example: 1.0)

getId

public String getId()

Description copied from interface: Describable

Returns the name, aka ID, of the describable item. The name should be unique for each instance.
Example: html for a MetacardTransformer that transforms Metacards to HTML

Specified by:

getId in interface Describable

Returns:

ID of the item

getTitle

public String getTitle()

Description copied from interface: Describable

Returns the title of the describable item. It is generally more verbose than the name (aka ID).

Specified by:

getTitle in interface Describable

Returns:

title of the item (example: Dummy Catalog Provider)

getDescription

public String getDescription()

Description copied from interface: Describable

Returns a description of the describable item.

Specified by:

getDescription in interface Describable

Returns:

description of the item (example: Provider that returns back static results)

getOrganization

public String getOrganization()

Description copied from interface: Describable

Returns the organization associated with the describable item.

Specified by:

getOrganization in interface Describable

Returns:

organizational name or acronym (example: USAF)

getSupportedSchemes

public Set<String> getSupportedSchemes()

Supported schemes are HTTP, HTTPS, and file

Specified by:

getSupportedSchemes in interface ResourceReader

Returns:

set of supported schemes

getMimeTypeMapper

public MimeTypeMapper getMimeTypeMapper()

setMimeTypeMapper

public void setMimeTypeMapper(MimeTypeMapper mimeTypeMapper)

setRootResourceDirectories

public void setRootResourceDirectories(Set<String> rootResourceDirectoryPaths)

Sets the directories that the URLResourceReader has permission to access when attempting to download a resource linked by a file URL.

Parameters:

rootResourceDirectoryPaths - a set of absolute paths specifying which directories the URLResourceReader has permission to access when attempting to download resources linked by a file URL. A null or empty input clears all root resource directory paths from the URLResourceReader (this effectively blocks all resource downloads linked by file URLs).

getRootResourceDirectories

public Set<String> getRootResourceDirectories()

setFollowRedirects

public void setFollowRedirects(Boolean redirect)

Specifies whether the code should follow server issued redirection (HTTP Response codes between 300 and 400)

Parameters:

redirect - true - follow redirections automatically false - do not follow server issued redirections

getFollowRedirects

public Boolean getFollowRedirects()

Gets the autoRedirect property

Returns:

true if the server issued redirections should be automatically followed

retrieveResource

public ResourceResponse retrieveResource(URI resourceURI,
                                         Map<String,Serializable> properties)
                                  throws IOException,
                                         ResourceNotFoundException

Retrieves a Resource based on a URI and provided arguments. A connection is made to the URI to obtain the Resource's InputStream and build a ResourceResponse from that. If the URI's scheme is HTTP or HTTPS, the Resource's name gets set to the URI passed in, otherwise, if it is a file scheme, the name is set to the actual file name.

Specified by:

retrieveResource in interface ResourceReader

Parameters:

resourceURI - A URI that defines what Resource to retrieve and how to do it.

properties - Any additional arguments that should be passed to the ResourceReader.

Returns:

A ResourceResponse containing the retrieved Resource.

Throws:

IOException

ResourceNotFoundException

getWebClient

protected org.apache.cxf.jaxrs.client.WebClient getWebClient(String uri,
                                                             Map<String,Serializable> properties)

getOptions

public Set<String> getOptions(Metacard metacard)

Description copied from interface: ResourceReader

Obtain a set of all options supported by this ResourceReader. Options are used to obtain the Resource in a unique way.

Specified by:

getOptions in interface ResourceReader

Returns:

Set of all options that this ResourceReader supports. This will be an empty set if no options are supported.