Description

The OpenSearch Source provides a Federated Source that has the capability to do OpenSearch queries for metadata from Content Discovery and Retrieval (CDR) Search V1.1 compliant sources. See http://www.dni.gov/index.php/about/organization/chief-information-officer/cdr-search for the CDR Specifications. The OpenSearch Source does not provide a Connected Source interface.

The OpenSearch Source converts a query into OpenSearch format and then sends that request to the CDR-compliant Search Service. It then accepts the response, formatted in Atom, and translates the Atom entries to DDMS Resources (using the Atom Query Response Transformer). Existing DDMS is used from the Atom entries when available. If it is not available, then a new DDMS document is created from the Atom information. If no (or incomplete) security markings are present, then this bundle adds security markings per the security settings that were configured in the Default Security Settings feature. The OpenSearch Source then splits out the DDMS documents into results, which are sent back to the endpoint/client via the Catalog Framework.

Usage

Use the OpenSearch Source if querying a CDR-compliant Search Service is desired. The OpenSearch Source, which is used for federating to other DDFs.

Installation and Uninstallation

The OpenSearch Source can be installed and uninstalled using the normal processes described in the Configuration section.

Configuration

This Component can be configured using the normal processes described in the Configuration section.

The configurable properties for the OpenSearch Source are accessed from the Catalog OpenSearch Federated Source Configuration in the Admin Console.

Configuring the OpenSearch Source

Configurable Properties

Title	Property	Type	Description	Default Value	Required
Source Name	shortname	String		DDF-OS	Yes
OpenSearch service URL	endpointUrl	String	The OpenSearch endpoint URL, e.g., DDF's OpenSearch endpoint (`http://0.0.0.0:8181/services/catalog/query?q={searchTerms}...`)	https://example.com?q={searchTerms}&src={fs:routeTo?}&mr={fs:maxResults?}&count={count?}&mt={fs:maxTimeout?}&dn={idn:userDN?}&lat={geo:lat?}&lon={geo:lon?}&radius={geo:radius?}&bbox={geo:box?}&polygon={geo:polygon?}&dtstart={time:start?}&dtend={time:end?}&dateName={cat:dateName?}&filter={fsa:filter?}&sort={fsa:sort?}	Yes
Always perform local query	localQueryOnly	Boolean	Always performs a local query by setting `src=local` OpenSearch parameter in endpoint URL. This must be set if federating to another DDF.	false	Yes
Convert to BBox	shouldConvertToBBox	Boolean	Converts Polygon and Point-Radius searches to a Bounding Box for compatibility with legacy interfaces. Generated bounding box is a very rough representation of the input geometry	true	Yes
Truststore File Location	trustStoreLocation	String	Truststore is only required for secure OpenSearch endpoints. This is the local file location of a java keystore that contains the trusted root certificates for the server being called. For the official servers this is the "store.jks" file attached to the Configuring a Java Keystore for Secure Communications page.	trustStore.jks	No
Truststore Password	trustStorePassword	String	The password of the above truststore.	password	No
Keystore File Location	keyStoreLocation	String	This is the local file location of a java keystore that contains the client certificates sent to the server and used for client authentication. This should be a personal ECA Cert that has been exported and converted from PKCS12 to a Java keystore (.jks).	keyStore.jks	No
Keystore Password	keyStorePassword	String	The password of the above keystore. This should be the same password that used when exporting the client cert.	password	No

Information on creating keystores and truststores can be found on the Configuring a Java Keystore for Secure Communications page.

Source Details

Default Security Settings (applicable to all OpenSearch Sources)

These settings are used to provide default security settings for the Title, Description, and Security elements in a DDMS record. The purpose of these defaults is that many providers fail to deliver a classification and Owner/Producer with the metadata returned. These default settings are used if a metadata record is returned without security settings. This feature can be turned on or off.

Open the web admin console.
- http://localhost:8181/system/console
- Username/Password: admin/admin
Click on the Configuration tab.
Find Catalog Security Defaults
Select whether or not to apply these defaults by checking or unchecking the box marked "Apply Default Security Settings."

If checked, the default security settings specified in this configuration are applied to all records returned from the CDR-compliant Search Service that do not contain DDMS metadata. (If a metadata record is returned without DDMS, it also is without security markings). If unchecked, the records without the DDMS metadata are removed from the result set.
If the applied defaults are selected, change the settings in the console to the default metadata security.
- These settings can also be changed by editing the file <INSTALL_DIRECTORY>/etc/ddf/ddf.DefaultSiteSecurity.cfg
Click Save at the bottom of the configuration window (or save the file).

In the CDR Open Search Service, if one of the properties has a blank value, the "last-resort" default is U and USA.
If the DefaultSiteSecurity.cfg file is deleted, it needs to be replaced otherwise all classification values are set to "last-resort" defaults U and USA.
After the file is replaced, either restart DDF or the restart the CDR Open Search Service to reload the property values.

If this feature is turned off, the records from a CDR-compliant Search Service without DDMS metadata are dropped out of the result set. This means that a Max Results of 20 query parameters is specified and there are only 15 records containing DDMS metadata, the result set only contains 15 records. The total count will accurately specify the number of records that match the query criteria in the Source that is queried.

Query Format

OpenSearch Parameter to DDF Query Mapping

OpenSearch/CDR Parameter	DDF Data Location
q={searchTerms}	Pulled verbatim from DDF query.
src={fs:routeTo?}	Unused
mr={fs:maxResults?}	Pulled verbatim from DDF query.
count={count?}	Pulled verbatim from DDF query.
mt={fs:maxTimeout?}	Pulled verbatim from DDF query.
dn={idn:userDN?}	DDF Subject
lat={geo:lat?}	Pulled verbatim from DDF query.
lon={geo:lon?}	Pulled verbatim from DDF query.
radius={geo:radius?}	Pulled verbatim from DDF query.
bbox={geo:box?}	Converted from Point-Radius DDF query.
polygon={geo:polygon?}	Pulled verbatim from DDF query.
dtstart={time:start?}	Pulled verbatim from DDF query.
dtend={time:end?}	Pulled verbatim from DDF query.
dateName={cat:dateName?}	Unused
filter={fsa:filter?}	Unused
sort={fsa:sort?}	Translated from DDF query. Format: "relevance" or "date" Supports "asc" and "desc" using colon as delimiter.

Implementation Details

Imported Services

Registered Interface	Availability	Multiple	Filter
`ddf.catalog.transform.InputTransformer`	required	false	(&(mime-type=text/xml)(id=xml))

Exported Services

Registered Interface	Service Property	Value
`ddf.catalog.source.FederatedSource`

Known Issues and Limitations

The OpenSearch Source does not provide a Connected Source interface.

Browser not supported