net.di2e.ecdr.search.endpoint.rest

Class CDRRestSearchServiceImpl

java.lang.Object

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

net.di2e.ecdr.search.endpoint.rest.CDRRestSearchServiceImpl

All Implemented Interfaces:

ddf.registry.api.RegistrableService

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

JAX-RS Web Service which implements the CDR REST Search Specification which is based on Open Search

Author:

Jeff Vettraino

Constructor Summary

Constructors

Constructor and Description

CDRRestSearchServiceImpl(ddf.catalog.CatalogFramework framework, 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, List<Object> geoCoderList) Constructor for JAX RS CDR Search Service.

Method Summary

Modifier and Type	Method and Description
protected void	addSourceDescriptions(net.di2e.ecdr.commons.xml.osd.OpenSearchDescription osd)
ddf.catalog.operation.QueryResponse	executeQuery(String localSourceId, javax.ws.rs.core.MultivaluedMap<String,String> queryParameters, net.di2e.ecdr.commons.query.CDRQueryImpl query)
Map<String,String>	getProperties()
String	getServiceDescription()
String	getServiceRelativeUrl()
String	getServiceType()
javax.ws.rs.core.Response	ping(javax.ws.rs.core.UriInfo uriInfo, String encoding, String auth)
javax.ws.rs.core.Response	search(org.apache.cxf.jaxrs.ext.MessageContext context, String encoding, String auth)

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

addHeaderParameters, executePing, executeSearch, generateTemplateUrl, getCatalogFramework, getGeoRSSFormat, getOSD, getParameterTemplate, getQueryLanguage, getQueryLanguageDescriptions, getQueryProperties, getURLScheme, isIncludeStatus, isUniqueQuery, isValidQuery, replaceTemplateValues

Methods inherited from class java.lang.Object

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

Constructor Detail

CDRRestSearchServiceImpl

public CDRRestSearchServiceImpl(ddf.catalog.CatalogFramework framework,
                                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,
                                List<Object> geoCoderList)

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

builder - FilterBuilder implementation

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

mapper - The transformation mapper for handling mapping the external CDR transform name to the internal DDF transform name

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)

getServiceType

public String getServiceType()

getServiceRelativeUrl

public String getServiceRelativeUrl()

getServiceDescription

public String getServiceDescription()

getProperties

public Map<String,String> getProperties()

Specified by:

getProperties in interface ddf.registry.api.RegistrableService

Overrides:

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

addSourceDescriptions

protected void addSourceDescriptions(net.di2e.ecdr.commons.xml.osd.OpenSearchDescription osd)

Overrides:

addSourceDescriptions 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