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)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID_PATH_PARAM
static String	TYPE_PATH_PARAM

Constructor Summary

Constructors

Constructor and Description
Access()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	exists(String type, String id)
String	getContext(String uuid)
String	getFilteredInstances(String type, String relationType, String facetType, Boolean polymorphic, javax.ws.rs.core.UriInfo uriInfo)
String	getInstance(String type, String id)
String	getInstances(String type, Boolean polymorphic, String reference, String direction)
String	getSchema(String type, Boolean polymorphic)
String	query(String query, Integer limit, String fetchPlan) It includeSubtypes to query Entities and Relations in the current Context. It accepts idempotent query only..

Methods inherited from class java.lang.Object

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

Field Detail

ID_PATH_PARAM

public static final String ID_PATH_PARAM

See Also:

Constant Field Values

TYPE_PATH_PARAM

public static final String TYPE_PATH_PARAM

See Also:

Constant Field Values

Constructor Detail

Access

public Access()

Method Detail

query

@GET
 @Produces(value="application/json;charset=UTF-8")
public String query(@QueryParam(value="query")
                                                                            String query,
                                                                            @QueryParam(value="limit")
                                                                            Integer limit,
                                                                            @QueryParam(value="fetchPlan")
                                                                            String fetchPlan)
                                                                     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 /resource-registry/access?query=SELECT FROM V

Parameters:

query - Defines the query to send to the backend.

limit - Defines the number of results you want returned, defaults to includeSubtypes 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 no idempotent

exists

@HEAD
 @Path(value="instance/{type}/{id}")
public javax.ws.rs.core.Response exists(@PathParam(value="type")
                                                                                   String type,
                                                                                   @PathParam(value="id")
                                                                                   String id)
                                                                            throws org.gcube.informationsystem.resourceregistry.api.exceptions.er.ERNotFoundException,
                                                                                   org.gcube.informationsystem.resourceregistry.api.exceptions.er.ERAvailableInAnotherContextException,
                                                                                   org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

Throws:

org.gcube.informationsystem.resourceregistry.api.exceptions.er.ERNotFoundException

org.gcube.informationsystem.resourceregistry.api.exceptions.er.ERAvailableInAnotherContextException

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

getInstance

@GET
 @Path(value="instance/{type}/{id}")
 @Produces(value="application/json;charset=UTF-8")
public String getInstance(@PathParam(value="type")
                                                                                                                       String type,
                                                                                                                       @PathParam(value="id")
                                                                                                                       String id)
                                                                                                                throws org.gcube.informationsystem.resourceregistry.api.exceptions.er.ERNotFoundException,
                                                                                                                       org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

Throws:

org.gcube.informationsystem.resourceregistry.api.exceptions.er.ERNotFoundException

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

getInstances

@GET
 @Path(value="instances/{type}")
 @Produces(value="application/json;charset=UTF-8")
public String getInstances(@PathParam(value="type")
                                                                                                                    String type,
                                                                                                                    @QueryParam(value="polymorphic") @DefaultValue(value="false")
                                                                                                                    Boolean polymorphic,
                                                                                                                    @QueryParam(value="reference")
                                                                                                                    String reference,
                                                                                                                    @QueryParam(value="direction") @DefaultValue(value="both")
                                                                                                                    String direction)
                                                                                                             throws org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

Throws:

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

getFilteredInstances

@GET
 @Path(value="resourceInstances/{type}/{relationType}/{facetType}")
 @Produces(value="application/json;charset=UTF-8")
public String getFilteredInstances(@PathParam(value="type")
                                                                                                                                                               String type,
                                                                                                                                                               @PathParam(value="relationType") @DefaultValue(value="ConsistsOf")
                                                                                                                                                               String relationType,
                                                                                                                                                               @PathParam(value="facetType") @DefaultValue(value="Facet")
                                                                                                                                                               String facetType,
                                                                                                                                                               @QueryParam(value="polymorphic") @DefaultValue(value="false")
                                                                                                                                                               Boolean polymorphic,
                                                                                                                                                               @Context
                                                                                                                                                               javax.ws.rs.core.UriInfo uriInfo)
                                                                                                                                                        throws org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

Throws:

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

getSchema

@GET
 @Path(value="schema/{type}")
 @Produces(value="application/json;charset=UTF-8")
public String getSchema(@PathParam(value="type")
                                                                                                              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

getContext

@GET
 @Path(value="context{id}")
 @Produces(value="application/json;charset=UTF-8")
public String getContext(@PathParam(value="id")
                                                                                                             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