org.gcube.rest.index.common.apis

Interface IndexServiceI

@Path(value="/")
public interface IndexServiceI

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	delete(String collectionID, String recordID, String gcubeScope)
javax.ws.rs.core.Response	deleteCollectionFieldsAlias(String collectionID, String gcubeScope)
javax.ws.rs.core.Response	deleteCollectionInfo(String collectionID, String gcubeScope)
javax.ws.rs.core.Response	deleteJSONTransformer(String collectionID, String gcubeScope)
javax.ws.rs.core.Response	dropCollection(String collectionID, String gcubeScope)
javax.ws.rs.core.Response	getAllCollectionFields(boolean aliasFields, String gcubeScope)
javax.ws.rs.core.Response	getCollectionFieldsAlias(String collectionID, boolean fromIndexToView, String gcubeScope)
javax.ws.rs.core.Response	getCollectionInfo(String collectionID, String gcubeScope)
javax.ws.rs.core.Response	getJSONTransformer(String collectionID, String gcubeScope)
javax.ws.rs.core.Response	insert(String collectionID, String recordJSON, String gcubeScope) Inserts a document in the specified index (collectionID).
javax.ws.rs.core.Response	insert(String collectionID, String recordID, String recordJSON, String gcubeScope) Inserts a document in the specified index (collectionID).
javax.ws.rs.core.Response	listCollections(String gcubeScope)
javax.ws.rs.core.Response	listFulltextEndpoints(String scope, String gcubeScope)
javax.ws.rs.core.Response	search(String queryJson, String gcubeScope)
javax.ws.rs.core.Response	setCollectionFieldsAlias(String collectionID, String mappingsJSON, String gcubeScope)
javax.ws.rs.core.Response	setCollectionInfo(String collectionID, String infoJSON, String gcubeScope)
javax.ws.rs.core.Response	setJSONTransformer(String collectionID, String transformerJSON, String gcubeScope)

Method Detail

listCollections

@GET
 @Path(value="/listCollections")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response listCollections(@HeaderParam(value="gcube-scope")
                                                                                                                                    String gcubeScope)

getAllCollectionFields

@GET
 @Path(value="/getAllCollectionFields")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response getAllCollectionFields(@DefaultValue(value="true") @QueryParam(value="aliasFields")
                                                                                                                                                  boolean aliasFields,
                                                                                                                                                  @HeaderParam(value="gcube-scope")
                                                                                                                                                  String gcubeScope)

insert

@POST
 @Path(value="/insert/{collectionID}/{recordID}")
 @Consumes(value="application/x-www-form-urlencoded")
javax.ws.rs.core.Response insert(@PathParam(value="collectionID")
                                                                                                                                               String collectionID,
                                                                                                                                               @PathParam(value="recordID")
                                                                                                                                               String recordID,
                                                                                                                                               @FormParam(value="recordJSON")
                                                                                                                                               String recordJSON,
                                                                                                                                               @HeaderParam(value="gcube-scope")
                                                                                                                                               String gcubeScope)

Inserts a document in the specified index (collectionID). If recordID is null or empty, it will be assigned an auto-generated

Parameters:

collectionID - the name of the collection - it will map to the index name

recordID - if null or empty, index assigns it an auto-generated

recordJSON - the document in json format

Returns:

true if successfull, false otherwise

insert

@POST
 @Path(value="/insert/{collectionID}")
 @Consumes(value="application/x-www-form-urlencoded")
javax.ws.rs.core.Response insert(@PathParam(value="collectionID")
                                                                                                                                    String collectionID,
                                                                                                                                    @FormParam(value="recordJSON")
                                                                                                                                    String recordJSON,
                                                                                                                                    @HeaderParam(value="gcube-scope")
                                                                                                                                    String gcubeScope)

Inserts a document in the specified index (collectionID). The new document will be assigned an auto-generated ID

Parameters:

collectionID - the name of the collection - it will map to the index name

recordJSON - the document in json format

Returns:

true if successfull, false otherwise

delete

@DELETE
 @Path(value="/delete/{collectionID}/{recordID}")
javax.ws.rs.core.Response delete(@PathParam(value="collectionID")
                                                                                           String collectionID,
                                                                                           @PathParam(value="recordID")
                                                                                           String recordID,
                                                                                           @HeaderParam(value="gcube-scope")
                                                                                           String gcubeScope)

dropCollection

@DELETE
 @Path(value="/dropCollection/{collectionID}")
javax.ws.rs.core.Response dropCollection(@PathParam(value="collectionID")
                                                                                                String collectionID,
                                                                                                @HeaderParam(value="gcube-scope")
                                                                                                String gcubeScope)

listFulltextEndpoints

@GET
 @Path(value="/listFulltextEndpoints")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response listFulltextEndpoints(@QueryParam(value="scope")
                                                                                                                                                String scope,
                                                                                                                                                @HeaderParam(value="gcube-scope")
                                                                                                                                                String gcubeScope)

getCollectionFieldsAlias

@GET
 @Path(value="/getCollectionFieldsAlias")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response getCollectionFieldsAlias(@QueryParam(value="collectionID")
                                                                                                                                                      String collectionID,
                                                                                                                                                      @DefaultValue(value="true") @QueryParam(value="fromIndexToView")
                                                                                                                                                      boolean fromIndexToView,
                                                                                                                                                      @HeaderParam(value="gcube-scope")
                                                                                                                                                      String gcubeScope)

setCollectionFieldsAlias

@POST
 @Path(value="/setCollectionFieldsAlias")
 @Consumes(value="application/x-www-form-urlencoded")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response setCollectionFieldsAlias(@QueryParam(value="collectionID")
                                                                                                                                                                                                             String collectionID,
                                                                                                                                                                                                             @FormParam(value="mappingsJSON")
                                                                                                                                                                                                             String mappingsJSON,
                                                                                                                                                                                                             @HeaderParam(value="gcube-scope")
                                                                                                                                                                                                             String gcubeScope)

deleteCollectionFieldsAlias

@DELETE
 @Path(value="/deleteCollectionFieldsAlias")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response deleteCollectionFieldsAlias(@QueryParam(value="collectionID")
                                                                                                                                                               String collectionID,
                                                                                                                                                               @HeaderParam(value="gcube-scope")
                                                                                                                                                               String gcubeScope)

getJSONTransformer

@GET
 @Path(value="/getJSONTransformer")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response getJSONTransformer(@QueryParam(value="collectionID")
                                                                                                                                          String collectionID,
                                                                                                                                          @HeaderParam(value="gcube-scope")
                                                                                                                                          String gcubeScope)

setJSONTransformer

@POST
 @Path(value="/setJSONTransformer")
 @Consumes(value="application/x-www-form-urlencoded")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response setJSONTransformer(@QueryParam(value="collectionID")
                                                                                                                                                                                                 String collectionID,
                                                                                                                                                                                                 @FormParam(value="transformerJSON")
                                                                                                                                                                                                 String transformerJSON,
                                                                                                                                                                                                 @HeaderParam(value="gcube-scope")
                                                                                                                                                                                                 String gcubeScope)

deleteJSONTransformer

@DELETE
 @Path(value="/deleteJSONTransformer")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response deleteJSONTransformer(@QueryParam(value="collectionID")
                                                                                                                                                   String collectionID,
                                                                                                                                                   @HeaderParam(value="gcube-scope")
                                                                                                                                                   String gcubeScope)

getCollectionInfo

@GET
 @Path(value="/getCollectionInfo")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response getCollectionInfo(@QueryParam(value="collectionID")
                                                                                                                                        String collectionID,
                                                                                                                                        @HeaderParam(value="gcube-scope")
                                                                                                                                        String gcubeScope)

setCollectionInfo

@POST
 @Path(value="/setCollectionInfo")
 @Consumes(value="application/x-www-form-urlencoded")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response setCollectionInfo(@QueryParam(value="collectionID")
                                                                                                                                                                                               String collectionID,
                                                                                                                                                                                               @FormParam(value="infoJSON")
                                                                                                                                                                                               String infoJSON,
                                                                                                                                                                                               @HeaderParam(value="gcube-scope")
                                                                                                                                                                                               String gcubeScope)

deleteCollectionInfo

@DELETE
 @Path(value="/deleteCollectionInfo")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response deleteCollectionInfo(@QueryParam(value="collectionID")
                                                                                                                                                 String collectionID,
                                                                                                                                                 @HeaderParam(value="gcube-scope")
                                                                                                                                                 String gcubeScope)

search

@POST
 @Path(value="/search")
 @Consumes(value="application/x-www-form-urlencoded")
 @Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response search(@FormParam(value="query")
                                                                                                                                                                         String queryJson,
                                                                                                                                                                         @HeaderParam(value="gcube-scope")
                                                                                                                                                                         String gcubeScope)