org.gcube.informationsystem.resourceregistry.rest

Class Access

java.lang.Object

org.gcube.informationsystem.resourceregistry.rest.Access

@Path(value="access")
public class Access
extends Object

Author:

Luca Frosini (ISTI - CNR)

Constructor Summary

Constructors

Constructor and Description
Access()

Method Summary

Modifier and Type	Method and Description
String	getAllContexts()
String	getAllInstances(String type, Boolean polymorphic)
String	getAllResourcesHavingFacet(String resourcetype, String relationType, String referenceType, String reference, Boolean polymorphic, String direction, javax.ws.rs.core.UriInfo uriInfo)
String	getContext(String uuid)
String	getInstance(String type, String uuid)
String	getType(String type, Boolean polymorphic)
javax.ws.rs.core.Response	instanceExists(String type, String uuid)
String	query(String query, Integer limit, String fetchPlan, Boolean raw) It includeSubtypes to query Entities and Relations in the current Context. It accepts idempotent query only..
static void	setCalledMethod(org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD httpMethod, List<String> pathValues, Map<String,String> map)
protected void	setCalledMethodLocal(org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD httpMethod, List<String> pathValues)
protected void	setCalledMethodLocal(org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD httpMethod, List<String> pathValues, Map<String,String> map)
protected void	setCalledMethodLocal(org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD httpMethod, String path)
protected void	setCalledMethodLocal(org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD httpMethod, String path, Map<String,String> map)

Methods inherited from class java.lang.Object

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

Constructor Detail

Access

public Access()

Method Detail

setCalledMethod

public static void setCalledMethod(org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD httpMethod,
                                   List<String> pathValues,
                                   Map<String,String> map)

setCalledMethodLocal

protected void setCalledMethodLocal(org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD httpMethod,
                                    String path)

setCalledMethodLocal

protected void setCalledMethodLocal(org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD httpMethod,
                                    String path,
                                    Map<String,String> map)

setCalledMethodLocal

protected void setCalledMethodLocal(org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD httpMethod,
                                    List<String> pathValues)

setCalledMethodLocal

protected void setCalledMethodLocal(org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD httpMethod,
                                    List<String> pathValues,
                                    Map<String,String> map)

getAllContexts

@GET
 @Path(value="contexts")
 @Produces(value="application/json;charset=UTF-8")
public String getAllContexts()
                                                                                                       throws org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

Throws:

org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

getContext

@GET
 @Path(value="contexts/{UUID}")
 @Consumes(value={"text/plain","application/json;charset=UTF-8"})
 @Produces(value="application/json;charset=UTF-8")
public String getContext(@PathParam(value="UUID")
                                                                                                                                                                                   String uuid)
                                                                                                                                                                            throws org.gcube.informationsystem.resourceregistry.api.exceptions.context.ContextNotFoundException,
                                                                                                                                                                                   org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

Throws:

org.gcube.informationsystem.resourceregistry.api.exceptions.context.ContextNotFoundException

org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

getType

@GET
 @Path(value="types/{TYPE_NAME}")
 @Consumes(value={"text/plain","application/json;charset=UTF-8"})
 @Produces(value="application/json;charset=UTF-8")
public String getType(@PathParam(value="TYPE_NAME")
                                                                                                                                                                                  String type,
                                                                                                                                                                                  @QueryParam(value="polymorphic") @DefaultValue(value="false")
                                                                                                                                                                                  Boolean polymorphic)
                                                                                                                                                                           throws org.gcube.informationsystem.resourceregistry.api.exceptions.schema.SchemaNotFoundException,
                                                                                                                                                                                  org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

Throws:

org.gcube.informationsystem.resourceregistry.api.exceptions.schema.SchemaNotFoundException

org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

getAllInstances

@GET
 @Path(value="instances/{TYPE_NAME}")
 @Consumes(value={"text/plain","application/json;charset=UTF-8"})
 @Produces(value="application/json;charset=UTF-8")
public String getAllInstances(@PathParam(value="TYPE_NAME")
                                                                                                                                                                                              String type,
                                                                                                                                                                                              @QueryParam(value="polymorphic") @DefaultValue(value="true")
                                                                                                                                                                                              Boolean polymorphic)
                                                                                                                                                                                       throws org.gcube.informationsystem.resourceregistry.api.exceptions.NotFoundException,
                                                                                                                                                                                              org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

Throws:

org.gcube.informationsystem.resourceregistry.api.exceptions.NotFoundException

org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

instanceExists

@HEAD
 @Path(value="instances/{TYPE_NAME}/{UUID}")
 @Consumes(value={"text/plain","application/json;charset=UTF-8"})
 @Produces(value="application/json;charset=UTF-8")
public javax.ws.rs.core.Response instanceExists(@PathParam(value="TYPE_NAME")
                                                                                                                                                                                                                        String type,
                                                                                                                                                                                                                        @PathParam(value="UUID")
                                                                                                                                                                                                                        String uuid)
                                                                                                                                                                                                                 throws org.gcube.informationsystem.resourceregistry.api.exceptions.NotFoundException,
                                                                                                                                                                                                                        org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

Throws:

org.gcube.informationsystem.resourceregistry.api.exceptions.NotFoundException

org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

getInstance

@GET
 @Path(value="instances/{TYPE_NAME}/{UUID}")
 @Consumes(value={"text/plain","application/json;charset=UTF-8"})
 @Produces(value="application/json;charset=UTF-8")
public String getInstance(@PathParam(value="TYPE_NAME")
                                                                                                                                                                                                 String type,
                                                                                                                                                                                                 @PathParam(value="UUID")
                                                                                                                                                                                                 String uuid)
                                                                                                                                                                                          throws org.gcube.informationsystem.resourceregistry.api.exceptions.NotFoundException,
                                                                                                                                                                                                 org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

Throws:

org.gcube.informationsystem.resourceregistry.api.exceptions.NotFoundException

org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

query

@GET
 @Path(value="query")
 @Produces(value="application/json;charset=UTF-8")
public String query(@QueryParam(value="q")
                                                                                                  String query,
                                                                                                  @QueryParam(value="limit")
                                                                                                  Integer limit,
                                                                                                  @QueryParam(value="fetchPlan") @DefaultValue(value="*:-1")
                                                                                                  String fetchPlan,
                                                                                                  @QueryParam(value="raw") @DefaultValue(value="false")
                                                                                                  Boolean raw)
                                                                                           throws org.gcube.informationsystem.resourceregistry.api.exceptions.query.InvalidQueryException

It includeSubtypes to query Entities and Relations in the current Context.
It accepts idempotent query only..

For query syntax please refer to
https://orientdb.com/docs/last/SQL-Syntax.html

e.g. GET /access/query?q=SELECT FROM V&limit=20&fetchPlan=*:-1

Parameters:

query - Defines the query to send to the backend.

limit - Defines the number of results you want returned (default 20, use -1 to unbounded results)

fetchPlan - Defines the fetching strategy you want to use. See https://orientdb.com/docs/last/Fetching-Strategies.html

Returns:

The JSON representation of the result

Throws:

org.gcube.informationsystem.resourceregistry.api.exceptions.query.InvalidQueryException - if the query is invalid or not idempotent

getAllResourcesHavingFacet

@GET
 @Path(value="query/{RESOURCE_TYPE_NAME}/{RELATION_TYPE_NAME}/{REFERENCE_TYPE_NAME}")
 @Produces(value="application/json;charset=UTF-8")
public String getAllResourcesHavingFacet(@PathParam(value="RESOURCE_TYPE_NAME")
                                                                                                                                                                                       String resourcetype,
                                                                                                                                                                                       @PathParam(value="RELATION_TYPE_NAME")
                                                                                                                                                                                       String relationType,
                                                                                                                                                                                       @PathParam(value="REFERENCE_TYPE_NAME")
                                                                                                                                                                                       String referenceType,
                                                                                                                                                                                       @QueryParam(value="reference")
                                                                                                                                                                                       String reference,
                                                                                                                                                                                       @QueryParam(value="polymorphic") @DefaultValue(value="false")
                                                                                                                                                                                       Boolean polymorphic,
                                                                                                                                                                                       @QueryParam(value="direction") @DefaultValue(value="out")
                                                                                                                                                                                       String direction,
                                                                                                                                                                                       @Context
                                                                                                                                                                                       javax.ws.rs.core.UriInfo uriInfo)
                                                                                                                                                                                throws org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

Throws:

org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException