org.gcube.search.sru.consumer.common.apis

Interface SruConsumerServiceAPI

All Superinterfaces:

org.gcube.rest.commons.resourceawareservice.ResourceAwareServiceRestAPI

public interface SruConsumerServiceAPI
extends org.gcube.rest.commons.resourceawareservice.ResourceAwareServiceRestAPI

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	explain(String scope, String resourceID)
javax.ws.rs.core.Response	ping()
javax.ws.rs.core.Response	query(String scope, String resourceID, String queryString, Long maxRecords, Boolean result, Boolean useRR)

Methods inherited from interface org.gcube.rest.commons.resourceawareservice.ResourceAwareServiceRestAPI

createResourceREST, destroyResourceREST, filterResourcesREST, getResourceREST, listResourcesREST

Method Detail

ping

@GET
 @Path(value="/ping")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response ping()

query

@GET
 @Path(value="/{id}/query")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response query(@HeaderParam(value="gcube-scope")
                                                                                                                     String scope,
                                                                                                                     @PathParam(value="id")
                                                                                                                     String resourceID,
                                                                                                                     @QueryParam(value="queryString")
                                                                                                                     String queryString,
                                                                                                                     @QueryParam(value="maxRecords")
                                                                                                                     Long maxRecords,
                                                                                                                     @QueryParam(value="result") @DefaultValue(value="false")
                                                                                                                     Boolean result,
                                                                                                                     @QueryParam(value="useRR") @DefaultValue(value="true")
                                                                                                                     Boolean useRR)

explain

@GET
 @Path(value="/{id}/explain")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response explain(@HeaderParam(value="gcube-scope")
                                                                                                                         String scope,
                                                                                                                         @PathParam(value="id")
                                                                                                                         String resourceID)