net.di2e.ecdr.broker.endpoint.rest

Class CDRRestBrokerServiceImpl

Show UML class diagram

java.lang.Object

net.di2e.ecdr.commons.endpoint.rest.AbstractRestSearchEndpoint

net.di2e.ecdr.broker.endpoint.rest.CDRRestBrokerServiceImpl

All Implemented Interfaces:

ddf.registry.api.RegistrableService

@Path(value="/")
public class CDRRestBrokerServiceImpl
extends net.di2e.ecdr.commons.endpoint.rest.AbstractRestSearchEndpoint

JAX-RS Web Service which implements the CDR REST Brokered Search Specification which is based on the CDR Search Spec which is in turn based on Open Search The key difference between CDR Brokered Search and CDR Search is that Brokered Search can route the search to multiple sources (FederatedSource).

Constructor Summary

Constructors

Constructor and Description

CDRRestBrokerServiceImpl(ddf.catalog.CatalogFramework framework, org.codice.ddf.configuration.impl.ConfigurationWatcherImpl config, List<net.di2e.ecdr.api.query.QueryLanguage> queryLangs, net.di2e.ecdr.api.transform.TransformIdMapper mapper, List<net.di2e.ecdr.api.auditor.SearchAuditor> auditorList, net.di2e.ecdr.api.query.QueryConfiguration queryConfig, net.di2e.ecdr.api.cache.QueryRequestCache queryCache, net.di2e.ecdr.api.federation.NormalizingFederationStrategy sortedFedStrategy, ddf.catalog.federation.FederationStrategy defaultFedStrategy) Constructor for JAX RS CDR Search Service.

Method Summary

Methods

Modifier and Type	Method and Description
ddf.catalog.operation.QueryResponse	executeQuery(String localSourceId, javax.ws.rs.core.MultivaluedMap<String,String> queryParameters, net.di2e.ecdr.commons.query.CDRQueryImpl query)
String	getParameterTemplate(String queryLanguageName)
String	getServiceDescription()
String	getServiceRelativeUrl()
String	getServiceType()
javax.ws.rs.core.Response	ping(javax.ws.rs.core.UriInfo uriInfo, String encoding, String auth)
protected String	replaceTemplateValues(String osdTemplate)
javax.ws.rs.core.Response	search(org.apache.cxf.jaxrs.ext.MessageContext context, String encoding, String auth) Search method that gets called when issuing an HTTP GET to the corresponding URL.

Methods inherited from class net.di2e.ecdr.commons.endpoint.rest.AbstractRestSearchEndpoint

addHeaderParameters, addSourceDescriptions, executePing, executeSearch, generateTemplateUrl, getCatalogFramework, getGeoRSSFormat, getOSD, getProperties, getQueryLanguage, getQueryLanguageDescriptions, getQueryProperties, isIncludeStatus, isUniqueQuery, isValidQuery

Methods inherited from class java.lang.Object

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

Constructor Detail

CDRRestBrokerServiceImpl

public CDRRestBrokerServiceImpl(ddf.catalog.CatalogFramework framework,
                        org.codice.ddf.configuration.impl.ConfigurationWatcherImpl config,
                        List<net.di2e.ecdr.api.query.QueryLanguage> queryLangs,
                        net.di2e.ecdr.api.transform.TransformIdMapper mapper,
                        List<net.di2e.ecdr.api.auditor.SearchAuditor> auditorList,
                        net.di2e.ecdr.api.query.QueryConfiguration queryConfig,
                        net.di2e.ecdr.api.cache.QueryRequestCache queryCache,
                        net.di2e.ecdr.api.federation.NormalizingFederationStrategy sortedFedStrategy,
                        ddf.catalog.federation.FederationStrategy defaultFedStrategy)

Constructor for JAX RS CDR Search Service. Values should ideally be passed into the constructor using a dependency injection framework like blueprint

Parameters:

framework - Catalog Framework which will be used for search

config - ConfigurationWatcherImpl used to get the platform configuration values

builder - FilterBuilder implementation

parser - The instance of the QueryParser to use which will determine how to parse the parameters from the query String. Query parsers are tied to different versions of a query profile

Method Detail

ping

public javax.ws.rs.core.Response ping(@Context
                             javax.ws.rs.core.UriInfo uriInfo,
                             @HeaderParam(value="Accept-Encoding")
                             String encoding,
                             @HeaderParam(value="Authorization")
                             String auth)

search

public javax.ws.rs.core.Response search(@Context
                               org.apache.cxf.jaxrs.ext.MessageContext context,
                               @HeaderParam(value="Accept-Encoding")
                               String encoding,
                               @HeaderParam(value="Authorization")
                               String auth)

Search method that gets called when issuing an HTTP GET to the corresponding URL. HTTP GET URL query parameters contain the query criteria values

Parameters:

uriInfo - Query parameters obtained by e

encoding -

auth -

Returns:

getServiceType

public String getServiceType()

getServiceRelativeUrl

public String getServiceRelativeUrl()

getServiceDescription

public String getServiceDescription()

getParameterTemplate

public String getParameterTemplate(String queryLanguageName)

Overrides:

getParameterTemplate in class net.di2e.ecdr.commons.endpoint.rest.AbstractRestSearchEndpoint

executeQuery

public ddf.catalog.operation.QueryResponse executeQuery(String localSourceId,
                                               javax.ws.rs.core.MultivaluedMap<String,String> queryParameters,
                                               net.di2e.ecdr.commons.query.CDRQueryImpl query)
                                                 throws ddf.catalog.source.SourceUnavailableException,
                                                        ddf.catalog.source.UnsupportedQueryException,
                                                        ddf.catalog.federation.FederationException

Specified by:

executeQuery in class net.di2e.ecdr.commons.endpoint.rest.AbstractRestSearchEndpoint

Throws:

ddf.catalog.source.SourceUnavailableException

ddf.catalog.source.UnsupportedQueryException

ddf.catalog.federation.FederationException

replaceTemplateValues

protected String replaceTemplateValues(String osdTemplate)

Overrides:

replaceTemplateValues in class net.di2e.ecdr.commons.endpoint.rest.AbstractRestSearchEndpoint