net.di2e.ecdr.commons.endpoint.rest

Class AbstractRestSearchEndpoint

Show UML class diagram

java.lang.Object

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

All Implemented Interfaces:

ddf.registry.api.RegistrableService

public abstract class AbstractRestSearchEndpoint
extends Object
implements ddf.registry.api.RegistrableService

Constructor Summary

Constructors

Constructor and Description

AbstractRestSearchEndpoint(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) Constructor for JAX RS CDR Search Service.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addHeaderParameters(javax.servlet.http.HttpServletRequest servletRequest, javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)
protected void	addSourceDescriptions(OpenSearchDescription osd)
javax.ws.rs.core.Response	executePing(javax.ws.rs.core.UriInfo uriInfo, String encodingHeader, String authHeader)
abstract ddf.catalog.operation.QueryResponse	executeQuery(String localSourceId, javax.ws.rs.core.MultivaluedMap<String,String> queryParameters, CDRQueryImpl query)
javax.ws.rs.core.Response	executeSearch(javax.servlet.http.HttpServletRequest servletRequest, javax.ws.rs.core.UriInfo uriInfo, String encoding, String auth) Search method that gets called when issuing an HTTP GET to the corresponding URL.
protected String	generateTemplateUrl(net.di2e.ecdr.api.query.QueryLanguage lang)
protected ddf.catalog.CatalogFramework	getCatalogFramework()
protected String	getGeoRSSFormat(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)
javax.ws.rs.core.Response	getOSD()
String	getParameterTemplate(String languageName)
Map<String,String>	getProperties()
protected net.di2e.ecdr.api.query.QueryLanguage	getQueryLanguage(javax.ws.rs.core.MultivaluedMap<String,String> queryParams)
protected String	getQueryLanguageDescriptions()
Map<String,Serializable>	getQueryProperties(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters, String sourceId)
protected boolean	isIncludeStatus(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)
protected boolean	isUniqueQuery(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters, String sourceId)
protected boolean	isValidQuery(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters, String sourceId)
protected String	replaceTemplateValues(String osdTemplate)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ddf.registry.api.RegistrableService

getServiceDescription, getServiceRelativeUrl, getServiceType

Constructor Detail

AbstractRestSearchEndpoint

public AbstractRestSearchEndpoint(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)

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

executePing

public javax.ws.rs.core.Response executePing(javax.ws.rs.core.UriInfo uriInfo,
                                    String encodingHeader,
                                    String authHeader)

getQueryLanguage

protected net.di2e.ecdr.api.query.QueryLanguage getQueryLanguage(javax.ws.rs.core.MultivaluedMap<String,String> queryParams)

executeSearch

public javax.ws.rs.core.Response executeSearch(javax.servlet.http.HttpServletRequest servletRequest,
                                      javax.ws.rs.core.UriInfo uriInfo,
                                      String encoding,
                                      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 - accept-encoding from the client

auth - Authorization header

Returns:

Response to send back to the calling client

getOSD

@Path(value="/osd.xml")
public javax.ws.rs.core.Response getOSD()

addSourceDescriptions

protected void addSourceDescriptions(OpenSearchDescription osd)

replaceTemplateValues

protected String replaceTemplateValues(String osdTemplate)

getQueryLanguageDescriptions

protected String getQueryLanguageDescriptions()

addHeaderParameters

protected void addHeaderParameters(javax.servlet.http.HttpServletRequest servletRequest,
                       javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)

getParameterTemplate

public String getParameterTemplate(String languageName)

executeQuery

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

Throws:

ddf.catalog.source.SourceUnavailableException

ddf.catalog.source.UnsupportedQueryException

ddf.catalog.federation.FederationException

getProperties

public Map<String,String> getProperties()

Specified by:

getProperties in interface ddf.registry.api.RegistrableService

getCatalogFramework

protected ddf.catalog.CatalogFramework getCatalogFramework()

isIncludeStatus

protected boolean isIncludeStatus(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)

getGeoRSSFormat

protected String getGeoRSSFormat(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)

getQueryProperties

public Map<String,Serializable> getQueryProperties(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters,
                                          String sourceId)

generateTemplateUrl

protected String generateTemplateUrl(net.di2e.ecdr.api.query.QueryLanguage lang)

isValidQuery

protected boolean isValidQuery(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters,
                   String sourceId)

isUniqueQuery

protected boolean isUniqueQuery(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters,
                    String sourceId)