ddf.catalog.source.opensearch.impl

Class OpenSearchSource

java.lang.Object

ddf.catalog.source.opensearch.impl.OpenSearchSource

All Implemented Interfaces:

ResourceReader, ConfiguredService, FederatedSource, RemoteSource, Source, Describable

public class OpenSearchSource
extends Object
implements FederatedSource, ConfiguredService

Federated site that talks via OpenSearch to the DDF platform. Communication is usually performed via https which requires a keystore and trust store to be provided.

Field Summary

Fields

Modifier and Type	Field and Description
protected SecureCxfClientFactory<OpenSearch>	factory

Constructor Summary

Constructors

Constructor and Description
OpenSearchSource(FilterAdapter filterAdapter, OpenSearchParser openSearchParser, OpenSearchFilterVisitor openSearchFilterVisitor, EncryptionService encryptionService) Creates an OpenSearch Site instance.
OpenSearchSource(FilterAdapter filterAdapter, OpenSearchParser openSearchParser, OpenSearchFilterVisitor openSearchFilterVisitor, EncryptionService encryptionService, BiConsumer<List<org.jdom2.Element>,SourceResponse> foreignMarkupBiConsumer) Creates an OpenSearch Site instance.

Method Summary

Modifier and Type	Method and Description
protected SecureCxfClientFactory<OpenSearch>	createClientFactory(String url, String username, String password)
void	destroy(int code)
Boolean	getAllowRedirects()
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.
Boolean	getDisableCnCheck()
String	getEndpointUrl() Get the URL of the endpoint.
String	getId() Returns the name, aka ID, of the describable item.
boolean	getLocalQueryOnly() Get the boolean flag that indicates only local queries are being executed by this OpenSearch Source.
List<String>	getMarkUpSet()
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.
List<String>	getParameters()
String	getPassword()
Integer	getReceiveTimeout()
boolean	getShouldConvertToBBox() Get the boolean flag that determines if point-radius and polygon geometries should be converting to bounding boxes before sending.
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	getUsername()
String	getVersion() Retrieve the version.
void	init() Called when this OpenSearch Source is created, but after all of the setter methods have been called for each property specified in the metatype.xml file.
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.
protected InputTransformer	lookupTransformerReference(String namespaceUri)
SourceResponse	query(QueryRequest queryRequest)
ResourceResponse	retrieveResource(URI uri, Map<String,Serializable> requestProperties) Retrieves a Resource based on a URI and provided arguments.
void	setAllowRedirects(Boolean allowRedirects)
void	setConfigurationPid(String configurationPid) Sets the PID of this service's corresponding configuration
void	setConnectionTimeout(Integer connectionTimeout)
void	setDisableCnCheck(Boolean disableCnCheck)
void	setEndpointUrl(String endpointUrl) Set URL of the endpoint.
void	setLocalQueryOnly(boolean localQueryOnly) Sets the boolean flag that indicates all queries executed should be to its local source only, i.e., no federated or enterprise queries.
void	setMarkUpSet(List<String> markUpSet)
protected boolean	setOpenSearchParameters(QueryRequest queryRequest, Subject subject, org.apache.cxf.jaxrs.client.WebClient client)
void	setParameters(List<String> parameters)
void	setPassword(String password)
void	setReceiveTimeout(Integer receiveTimeout)
void	setResourceReader(ResourceReader reader)
void	setShortname(String shortname) Sets the shortname for this site.
void	setShouldConvertToBBox(boolean shouldConvertToBBox) Sets the boolean flag that tells the code to convert point-radius and polygon geometries to a bounding box before sending them.
void	setUsername(String username)

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

factory

protected SecureCxfClientFactory<OpenSearch> factory

Constructor Detail

OpenSearchSource

public OpenSearchSource(FilterAdapter filterAdapter,
                        OpenSearchParser openSearchParser,
                        OpenSearchFilterVisitor openSearchFilterVisitor,
                        EncryptionService encryptionService)

Creates an OpenSearch Site instance. Sets an initial default endpointUrl that can be overwritten using the setter methods.

OpenSearchSource

public OpenSearchSource(FilterAdapter filterAdapter,
                        OpenSearchParser openSearchParser,
                        OpenSearchFilterVisitor openSearchFilterVisitor,
                        EncryptionService encryptionService,
                        BiConsumer<List<org.jdom2.Element>,SourceResponse> foreignMarkupBiConsumer)

Creates an OpenSearch Site instance. Sets an initial default endpointUrl that can be overwritten using the setter methods.

Method Detail

init

public void init()

Called when this OpenSearch Source is created, but after all of the setter methods have been called for each property specified in the metatype.xml file.

createClientFactory

protected SecureCxfClientFactory<OpenSearch> createClientFactory(String url,
                                                                 String username,
                                                                 String password)

destroy

public void destroy(int code)

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 queryRequest)
                     throws UnsupportedQueryException

Specified by:

query in interface Source

Parameters:

queryRequest - 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

setOpenSearchParameters

protected boolean setOpenSearchParameters(QueryRequest queryRequest,
                                          Subject subject,
                                          org.apache.cxf.jaxrs.client.WebClient client)

getEndpointUrl

public String getEndpointUrl()

Get the URL of the endpoint.

Returns:

setEndpointUrl

public void setEndpointUrl(String endpointUrl)

Set URL of the endpoint.

Parameters:

endpointUrl - Full url of the endpoint.

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)

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

setShortname

public void setShortname(String shortname)

Sets the shortname for this site. This shortname is used to identify the site when performing federated queries.

Parameters:

shortname - Name of this site.

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)

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)

lookupTransformerReference

protected InputTransformer lookupTransformerReference(String namespaceUri)
                                               throws org.osgi.framework.InvalidSyntaxException

Throws:

org.osgi.framework.InvalidSyntaxException

getLocalQueryOnly

public boolean getLocalQueryOnly()

Get the boolean flag that indicates only local queries are being executed by this OpenSearch Source.

Returns:

true indicates only local queries, false indicates enterprise query

setLocalQueryOnly

public void setLocalQueryOnly(boolean localQueryOnly)

Sets the boolean flag that indicates all queries executed should be to its local source only, i.e., no federated or enterprise queries.

Parameters:

localQueryOnly - true indicates only local queries, false indicates enterprise query

getShouldConvertToBBox

public boolean getShouldConvertToBBox()

Get the boolean flag that determines if point-radius and polygon geometries should be converting to bounding boxes before sending.

Returns:

setShouldConvertToBBox

public void setShouldConvertToBBox(boolean shouldConvertToBBox)

Sets the boolean flag that tells the code to convert point-radius and polygon geometries to a bounding box before sending them.

Parameters:

shouldConvertToBBox -

retrieveResource

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

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.

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

Returns:

A ResourceResponse containing the retrieved Resource.

Throws:

ResourceNotFoundException

ResourceNotSupportedException

IOException

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.

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.

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

getMarkUpSet

public List<String> getMarkUpSet()

setMarkUpSet

public void setMarkUpSet(List<String> markUpSet)

getParameters

public List<String> getParameters()

setParameters

public void setParameters(List<String> parameters)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getDisableCnCheck

public Boolean getDisableCnCheck()

setDisableCnCheck

public void setDisableCnCheck(Boolean disableCnCheck)

getAllowRedirects

public Boolean getAllowRedirects()

setAllowRedirects

public void setAllowRedirects(Boolean allowRedirects)

getConnectionTimeout

public Integer getConnectionTimeout()

setConnectionTimeout

public void setConnectionTimeout(Integer connectionTimeout)

getReceiveTimeout

public Integer getReceiveTimeout()

setReceiveTimeout

public void setReceiveTimeout(Integer receiveTimeout)

setResourceReader

public void setResourceReader(ResourceReader reader)