org.codice.ddf.spatial.ogc.catalog.resource.impl

Class OgcUrlResourceReader

java.lang.Object

org.codice.ddf.spatial.ogc.catalog.resource.impl.OgcUrlResourceReader

All Implemented Interfaces:

ResourceReader, Describable

public class OgcUrlResourceReader
extends Object
implements ResourceReader

Resource Reader which provide redirection when a product has a mime type of text/html

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION
static String	ORGANIZATION
static String	SHORTNAME
static String	TITLE
static String	VERSION

Constructor Summary

Constructors

Constructor and Description
OgcUrlResourceReader(ResourceReader urlResourceReader, org.apache.tika.Tika tika)

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns a description of the describable item.
String	getId() Returns the name, aka ID, of the describable item.
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>	getSupportedSchemes() Returns a set of URI schemes that the ResourceReader can accept when doing a Resource lookup.
String	getTitle() Returns the title of the describable item.
String	getVersion() Retrieve the version.
ResourceResponse	retrieveResource(URI resourceURI, Map<String,Serializable> properties) Retrieves a Resource based on a URI and provided arguments.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

SHORTNAME

public static final String SHORTNAME

TITLE

public static final String TITLE

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

ORGANIZATION

public static final String ORGANIZATION

See Also:

Constant Field Values

Constructor Detail

OgcUrlResourceReader

public OgcUrlResourceReader(ResourceReader urlResourceReader,
                            org.apache.tika.Tika tika)

Method Detail

getSupportedSchemes

public Set<String> getSupportedSchemes()

Description copied from interface: ResourceReader

Returns a set of URI schemes that the ResourceReader can accept when doing a Resource lookup. Custom schemes can be created for a ResourceReader to support.

Specified by:

getSupportedSchemes in interface ResourceReader

Returns:

Set of supported schemes

retrieveResource

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

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. The Resource's name gets set to the URI passed in. Calls URLResourceReader, if the mime-type is "text/html" it will inject a simple script to redirect to the resourceURI instead of attempting to download it.

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:

ResourceNotSupportedException

IOException

ResourceNotFoundException

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)

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.