ddf.catalog.resource

Interface ResourceReader

All Superinterfaces:

Describable

All Known Subinterfaces:

CatalogStore, ConnectedSource, FederatedSource, RegistryStore, RemoteSource

All Known Implementing Classes:

AbstractCswSource, AbstractCswStore, ConfluenceSource, ContentResourceReader, CswSourceImpl, OgcUrlResourceReader, OpenSearchSource, RegistryStoreImpl, TransactionalCswStoreImpl, TwitterSource, URLResourceReader, WfsSource, WfsSource

public interface ResourceReader
extends Describable

A ResourceReader is used to obtain a Resource.

For example the URLResourceReader obtains a Resource based on supported URI schemes.

Author:

michael.menousek@lmco.com

Method Summary

Modifier and Type	Method and Description
Set<String>	getOptions(Metacard metacard) Obtain a set of all options supported by this ResourceReader.
Set<String>	getSupportedSchemes() Returns a set of URI schemes that the ResourceReader can accept when doing a Resource lookup.
ResourceResponse	retrieveResource(URI uri, Map<String,Serializable> arguments) Retrieves a Resource based on a URI and provided arguments.

Methods inherited from interface ddf.catalog.util.Describable

getDescription, getId, getOrganization, getTitle, getVersion

Method Detail

retrieveResource

ResourceResponse retrieveResource(URI uri,
                                  Map<String,Serializable> arguments)
                           throws IOException,
                                  ResourceNotFoundException,
                                  ResourceNotSupportedException

Retrieves a Resource based on a URI and provided arguments.

Parameters:

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

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

Returns:

A ResourceResponse containing the retrieved Resource.

Throws:

{@link - IOException} thrown typically when there is an issue retrieving the file

{@link - ResourceNotFoundException} thrown when the Resource could not be found

{@link - ResourceNotSupportedException} thrown when the Resource is not supported by the ResourceReader

IOException

ResourceNotFoundException

ResourceNotSupportedException

getSupportedSchemes

Set<String> getSupportedSchemes()

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.

Returns:

Set of supported schemes

getOptions

Set<String> getOptions(Metacard metacard)

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

Parameters:

metacard -

Returns:

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