org.codice.ddf.spatial.ogc.wfs.v2_0_0.catalog.source

Class WfsSource

java.lang.Object

ddf.catalog.util.impl.DescribableImpl

ddf.catalog.util.impl.MaskableImpl

org.codice.ddf.spatial.ogc.wfs.v2_0_0.catalog.source.WfsSource

All Implemented Interfaces:

ResourceReader, ConfiguredService, ConnectedSource, FederatedSource, RemoteSource, Source, Maskable, Describable

public class WfsSource
extends MaskableImpl
implements FederatedSource, ConnectedSource, ConfiguredService

Provides a Federated and Connected source implementation for OGC WFS servers.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	configurationPid
static String	DISABLE_CN_CHECK_PROPERTY
protected Map<QName,WfsFilterDelegate>	featureTypeFilters
static int	WFS_MAX_FEATURES_RETURNED
protected static int	WFS_QUERY_PAGE_SIZE_MULTIPLIER

Constructor Summary

Constructors

Constructor and Description
WfsSource(EncryptionService encryptionService)
WfsSource(FilterAdapter filterAdapter, org.osgi.framework.BundleContext context, AvailabilityTask task, SecureCxfClientFactory factory, EncryptionService encryptionService)

Method Summary

Modifier and Type	Method and Description
protected GetFeatureType	buildGetFeatureRequest(Query query)
void	destroy(int code)
String	getConfigurationPid() Returns the PID of the configuration that corresponds to this service
Integer	getConnectionTimeout()
Set<ContentType>	getContentTypes() Gets the ContentTypes that are currently stored by the Source.
String	getDescription() Returns a description of the describable item.
FeatureCollectionMessageBodyReaderWfs20	getFeatureCollectionReader()
String	getForceSpatialFilter()
String	getId() Returns the name, aka ID, of the describable item.
List<MetacardMapper>	getMetacardToFeatureMapper()
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.
Integer	getPollInterval()
Integer	getReceiveTimeout()
String	getSrsName()
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.
String	getWfsUrl()
void	init() Init is called when the bundle is initially configured.
boolean	isAvailable() This method states whether this source is available, typically connecting and performing some sort of simple query or ping to the native catalog.
boolean	isAvailable(SourceMonitor callback) This method is the same as Source.isAvailable() but allows a caller to provide a SourceMonitor callback object which is meant to be used as a way for the Source to dynamically contact the caller with its availability.
void	maskId(String newSourceId) Sets the masked ID of this maskable item to the specified ID, and then sets an internal flag indicating that the masked ID cannot be changed.
SourceResponse	query(QueryRequest request)
void	refresh(Map<String,Object> configuration) Refresh is called if the bundle configuration is updated.
ResourceResponse	retrieveResource(URI uri, Map<String,Serializable> arguments) Retrieves a Resource based on a URI and provided arguments.
void	setConfigurationPid(String configurationPid) Sets the PID of this service's corresponding configuration
void	setConnectionTimeout(Integer timeout)
void	setContext(org.osgi.framework.BundleContext context)
void	setCoordinateOrder(String coordinateOrder)
void	setDisableCnCheck(Boolean disableCnCheck)
void	setDisableSorting(boolean disableSorting)
void	setFeatureCollectionReader(FeatureCollectionMessageBodyReaderWfs20 featureCollectionMessageBodyReaderWfs20)
void	setFeatureConverterFactoryList(List<FeatureConverterFactory> factories)
void	setFilterAdapter(FilterAdapter filterAdapter)
void	setFilterDelgates(Map<QName,WfsFilterDelegate> delegates)
void	setForcedFeatureType(String featureType)
void	setForceSpatialFilter(String forceSpatialFilter)
void	setMetacardToFeatureMapper(List<MetacardMapper> mappers)
void	setNonQueryableProperties(String[] newNonQueryableProperties)
void	setPassword(String password)
void	setPollInterval(Integer interval)
void	setReceiveTimeout(Integer timeout)
void	setSrsName(String srsName)
void	setUsername(String username)
void	setWfsUrl(String wfsUrl)

Methods inherited from class ddf.catalog.util.impl.MaskableImpl

setId

Methods inherited from class ddf.catalog.util.impl.DescribableImpl

setDescription, setOrganization, setShortname, setTitle, setVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface ddf.catalog.source.Source

getSecurityAttributes

Field Detail

WFS_MAX_FEATURES_RETURNED

public static final int WFS_MAX_FEATURES_RETURNED

See Also:

Constant Field Values

WFS_QUERY_PAGE_SIZE_MULTIPLIER

protected static final int WFS_QUERY_PAGE_SIZE_MULTIPLIER

See Also:

Constant Field Values

DISABLE_CN_CHECK_PROPERTY

public static final String DISABLE_CN_CHECK_PROPERTY

See Also:

Constant Field Values

featureTypeFilters

protected Map<QName,WfsFilterDelegate> featureTypeFilters

configurationPid

protected String configurationPid

Constructor Detail

WfsSource

public WfsSource(FilterAdapter filterAdapter,
                 org.osgi.framework.BundleContext context,
                 AvailabilityTask task,
                 SecureCxfClientFactory factory,
                 EncryptionService encryptionService)
          throws SecurityServiceException

Throws:

SecurityServiceException

WfsSource

public WfsSource(EncryptionService encryptionService)

Method Detail

init

public void init()

Init is called when the bundle is initially configured.

The init process creates a RemoteWfs object using the connection parameters from the configuration.

destroy

public void destroy(int code)

refresh

public void refresh(Map<String,Object> configuration)
             throws SecurityServiceException

Refresh is called if the bundle configuration is updated.

If any of the connection related properties change, an attempt is made to re-connect.

Parameters:

configuration -

Throws:

SecurityServiceException

isAvailable

public boolean isAvailable()

Description copied from interface: Source

This method states whether this source is available, typically connecting and performing some sort of simple query or ping to the native catalog.

This is expected to be an expensive operation, possibly involving network I/O. Typically only CatalogFramework implementations will call this and only periodically.

Specified by:

isAvailable in interface Source

Returns:

true - if the site is available (up), false - if the site is unavailable (down)

See Also:

ddf.catalog.util.SourcePoller

isAvailable

public boolean isAvailable(SourceMonitor callback)

Description copied from interface: Source

This method is the same as Source.isAvailable() but allows a caller to provide a SourceMonitor callback object which is meant to be used as a way for the Source to dynamically contact the caller with its availability. The intent is to return a boolean as to whether the Source is available at this very moment and also to use the SourceMonitor object to update the caller of this method if this Source's availability changes later in the future.

Specified by:

isAvailable in interface Source

Parameters:

callback - - used to notify the caller of this method when the Source object wants to update its availability.

Returns:

true - if the site is available (up), false - if the site is unavailable (down)

query

public SourceResponse query(QueryRequest request)
                     throws UnsupportedQueryException

Specified by:

query in interface Source

Parameters:

request - the query to execute

Returns:

a SourceResponse with query results and query response details

Throws:

UnsupportedQueryException - when the query is not understood, malformed, or not supported by a Source

buildGetFeatureRequest

protected GetFeatureType buildGetFeatureRequest(Query query)
                                         throws UnsupportedQueryException

Throws:

UnsupportedQueryException

getContentTypes

public Set<ContentType> getContentTypes()

Description copied from interface: Source

Gets the ContentTypes that are currently stored by the Source. Notice the return object is a Set, meaning it returns all unique content types found in the Source without duplications.

Specified by:

getContentTypes in interface Source

Returns:

a Set of ContentTypes currently available from this Source.

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

Overrides:

getId in class DescribableImpl

Returns:

ID of the item

maskId

public void maskId(String newSourceId)

Description copied from class: MaskableImpl

Sets the masked ID of this maskable item to the specified ID, and then sets an internal flag indicating that the masked ID cannot be changed.

Specified by:

maskId in interface Maskable

Overrides:

maskId in class MaskableImpl

Parameters:

newSourceId - the new id to use

getDescription

public String getDescription()

Description copied from interface: Describable

Returns a description of the describable item.

Specified by:

getDescription in interface Describable

Overrides:

getDescription in class DescribableImpl

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

Overrides:

getOrganization in class DescribableImpl

Returns:

organizational name or acronym (example: USAF)

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

Overrides:

getTitle in class DescribableImpl

Returns:

title of the item (example: Dummy Catalog Provider)

getVersion

public String getVersion()

Description copied from interface: Describable

Retrieve the version.

Specified by:

getVersion in interface Describable

Overrides:

getVersion in class DescribableImpl

Returns:

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

retrieveResource

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

Description copied from interface: ResourceReader

Retrieves a Resource based on a URI and provided arguments.

Specified by:

retrieveResource in interface ResourceReader

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:

IOException

ResourceNotFoundException

ResourceNotSupportedException

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

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.

getWfsUrl

public String getWfsUrl()

setWfsUrl

public void setWfsUrl(String wfsUrl)
               throws SecurityServiceException

Throws:

SecurityServiceException

setUsername

public void setUsername(String username)

setPassword

public void setPassword(String password)

setDisableCnCheck

public void setDisableCnCheck(Boolean disableCnCheck)

setPollInterval

public void setPollInterval(Integer interval)

getPollInterval

public Integer getPollInterval()

setConnectionTimeout

public void setConnectionTimeout(Integer timeout)

getConnectionTimeout

public Integer getConnectionTimeout()

setReceiveTimeout

public void setReceiveTimeout(Integer timeout)

getReceiveTimeout

public Integer getReceiveTimeout()

setSrsName

public void setSrsName(String srsName)

getSrsName

public String getSrsName()

setFilterAdapter

public void setFilterAdapter(FilterAdapter filterAdapter)

setFilterDelgates

public void setFilterDelgates(Map<QName,WfsFilterDelegate> delegates)

setContext

public void setContext(org.osgi.framework.BundleContext context)

setNonQueryableProperties

public void setNonQueryableProperties(String[] newNonQueryableProperties)

getForceSpatialFilter

public String getForceSpatialFilter()

setForceSpatialFilter

public void setForceSpatialFilter(String forceSpatialFilter)

setFeatureConverterFactoryList

public void setFeatureConverterFactoryList(List<FeatureConverterFactory> factories)

getMetacardToFeatureMapper

public List<MetacardMapper> getMetacardToFeatureMapper()

setMetacardToFeatureMapper

public void setMetacardToFeatureMapper(List<MetacardMapper> mappers)

setCoordinateOrder

public void setCoordinateOrder(String coordinateOrder)

setDisableSorting

public void setDisableSorting(boolean disableSorting)

getConfigurationPid

public String getConfigurationPid()

Description copied from interface: ConfiguredService

Returns the PID of the configuration that corresponds to this service

Specified by:

getConfigurationPid in interface ConfiguredService

Returns:

The unique PID of the configuration associated with this service

setConfigurationPid

public void setConfigurationPid(String configurationPid)

Description copied from interface: ConfiguredService

Sets the PID of this service's corresponding configuration

Specified by:

setConfigurationPid in interface ConfiguredService

Parameters:

configurationPid - The unique PID of the configuration associated with this service

getFeatureCollectionReader

public FeatureCollectionMessageBodyReaderWfs20 getFeatureCollectionReader()

setFeatureCollectionReader

public void setFeatureCollectionReader(FeatureCollectionMessageBodyReaderWfs20 featureCollectionMessageBodyReaderWfs20)

setForcedFeatureType

public void setForcedFeatureType(String featureType)