net.di2e.ecdr.search.endpoint.rest

Class CDRRestSearchServiceImpl

Show UML class diagram

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, org.codice.ddf.configuration.impl.ConfigurationWatcherImpl config, ddf.catalog.filter.FilterBuilder builder, net.di2e.ecdr.commons.query.rest.parsers.QueryParser parser, net.di2e.ecdr.search.transform.mapper.TransformIdMapper mapper) 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.rest.CDRQueryImpl query)
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(javax.ws.rs.core.UriInfo uriInfo, String encoding, String auth)
boolean	useDefaultSortIfNotSpecified()

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

executePing, executeSearch, getCatalogFramework, getProperties, getQueryParser

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,
                        org.codice.ddf.configuration.impl.ConfigurationWatcherImpl config,
                        ddf.catalog.filter.FilterBuilder builder,
                        net.di2e.ecdr.commons.query.rest.parsers.QueryParser parser,
                        net.di2e.ecdr.search.transform.mapper.TransformIdMapper mapper)

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

sortedFedStrategy - Federation strategy to use

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
                               javax.ws.rs.core.UriInfo uriInfo,
                               @HeaderParam(value="Accept-Encoding")
                               String encoding,
                               @HeaderParam(value="Authorization")
                               String auth)

getServiceType

public String getServiceType()

getServiceRelativeUrl

public String getServiceRelativeUrl()

getServiceDescription

public String getServiceDescription()

useDefaultSortIfNotSpecified

public boolean useDefaultSortIfNotSpecified()

Specified by:

useDefaultSortIfNotSpecified 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.rest.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