Resource Registry Service - Query & Access

From Gcube Wiki
Revision as of 15:03, 6 July 2021 by Luca.frosini (Talk | contribs) (→‎Raw Query)

Jump to: navigation, search

This section provides information regarding how to interact with Resource Registry Service for Query and Access. REST and JAVA API are presented for each functionality.

Please note that the provided examples can intentionally hide some details in the response to avoid unneeded complexity.

Query & Access

Query & Access exposes the safe methods available in the dedicated collection plus 2 APIs dedicated to query the instances.

  • List Contexts:
  • Read Context:
  • Read/List Type(s):
  • List Instances:
  • Exists Instance:
  • Read Instace:
  • Get Instance Contexts:
  • Prepared Query
  • Raw Query:

On this page, the APIs already available in the dedicated collection will not be presented. Please check the dedicated page. The reason to expose the safe method already available in the dedicated collection is for security reasons.

Query & Access Collection

Operation HTTP Method URL
List Contexts GET /access/contexts
Read Context GET /access/contexts/{UUID}
Read Type GET /access/types/{TYPE_NAME}[?polymorphic=true]
List Instances GET /access/instances/{TYPE_NAME}[?polymorphic=true]
Exists Instance GET /access/instances/{TYPE_NAME}/{UUID}
Read Instace GET /access/instances/{TYPE_NAME}/{UUID}
Get Instace Contexts GET /access/instances/{TYPE_NAME}/{UUID}/contexts
Prepared Query GET /access/query/{RESOURCE_TYPE_NAME}/{RELATION_TYPE_NAME}/{ENTITY_TYPE_NAME}[?reference={REFERENCE_ENTITY_UUID}&polymorphic=true&direction=out]
Query GET /access/query?q={QUERY}

Resource Registry Client

Resource Registry Client is a java library providing RPC facilities to interact with [#Query & Access Collection | Query & Access Collection]]. The library hides all the complexity of marshalling and unmarshalling of requests and results. By using this library any client is able to manage java classes instead of JSON objects.

To use the Java library to interact with [#Query & Access Collection | Query & Access Collection]] declare the following dependency in your pom.xml file. 

<dependency>
	<groupId>org.gcube.information-system</groupId>
	<artifactId>resource-registry-client</artifactId>
	<version>[4.0.0,5.0.0-SNAPSHOT)</version>
<dependency>

To use the client you just need to instantiate the client via the provided factory. 

import org.gcube.informationsystem.resourceregistry.client.ResourceRegistryClient;
import org.gcube.informationsystem.resourceregistry.client.ResourceRegistryClientFactory;
 
...
 
ResourceRegistryClient resourceRegistryClient = ResourceRegistryClientFactory.create();

APIs

Prepared Query

Raw Query

This API provides a way to query the underlying database persistence by using the persistence query language dialect. This API does not provide any consistency with the IS Model concepts. The result is related to how the service decide to represent the IS Model concepts on the persistence data model.

At the time of writing the underlying database, persistence is OrientDB. It should be used only for development purposes only because the way to represent the IS Model concepts can change at any time or can change the database persistence.

At the time of writing the query language supported is OrientDB SQL Dialect.

REST API

GET /resource-registry/access/query?q={Query}
Example 1
GET /resource-registry/access?query=SELECT FROM SoftwareFacet LIMIT 2

Response Body 

{
    "result": [
        {
            "@type": "d",
            "@rid": "#99:5",
            "@version": 12,
            "@class": "SoftwareFacet",
            "header": {
                "@type": "d",
                "@version": 0,
                "@class": "Header",
                "uuid": "6b724a7c-9f51-4a4e-8e8e-1636ca2e9d29",
                "creator": "VREManagement:WhnManager:pc-frosini.isti.cnr.it_8080",
                "creationTime": "2017-10-05 16:09:02.618 +0200",
                "lastUpdateTime": "2017-10-05 17:23:44.191 +0200",
                "@fieldTypes": "creationTime=t,lastUpdateTime=t"
            },
            "name": "WhnManager",
            "description": "Web Hosting Node Service",
            "optional": false,
            "version": "2.0.0-SNAPSHOT",
            "group": "VREManagement",
            "_allow": [
                "#4:12",
                "#5:13",
                "#4:14"
            ],
            "_allowRead": [
                "#4:13",
                "#4:11"
            ],
            "in_IsIdentifiedBy": [
                "#168:5"
            ],
            "@fieldTypes": "_allow=n,_allowRead=n,in_IsIdentifiedBy=g"
        },
        {
            "@type": "d",
            "@rid": "#99:6",
            "@version": 5,
            "@class": "SoftwareFacet",
            "header": {
                "@type": "d",
                "@version": 0,
                "@class": "Header",
                "uuid": "bc98eec4-4365-49fd-83b3-2cacaf17f8bf",
                "creator": "VREManagement:SmartExecutor:pc-frosini.isti.cnr.it_8080",
                "creationTime": "2017-10-05 17:22:06.351 +0200",
                "lastUpdateTime": "2017-10-05 17:23:44.206 +0200",
                "@fieldTypes": "creationTime=t,lastUpdateTime=t"
            },
            "name": "SmartExecutor",
            "description": "Smart Executor Service",
            "optional": false,
            "version": "1.7.0-SNAPSHOT",
            "group": "VREManagement",
            "_allow": [
                "#4:12",
                "#5:15",
                "#4:14"
            ],
            "_allowRead": [
                "#4:13",
                "#4:11"
            ],
            "in_IsIdentifiedBy": [
                "#168:6"
            ],
            "@fieldTypes": "_allow=n,_allowRead=n,in_IsIdentifiedBy=g"
        }
    ],
    "notification": "Query executed in 0.147 sec. Returned 2 record(s)"
}

As you can see a lot of database specific informations are returned. You cannot use or rely on them to interact with registry.

Example 2
GET /resource-registry/access?query=SELECT FROM EService LIMIT 2

Response Body 

{
    "result": [
        {
            "@type": "d",
            "@rid": "#138:2",
            "@version": 12,
            "@class": "EService",
            "header": {
                "@type": "d",
                "@version": 0,
                "@class": "Header",
                "uuid": "077a389f-6676-49bb-a925-16bea54c5f5d",
                "creator": "VREManagement:WhnManager:pc-frosini.isti.cnr.it_8080",
                "creationTime": "2017-10-05 16:09:02.604 +0200",
                "lastUpdateTime": "2017-10-05 17:23:44.191 +0200",
                "@fieldTypes": "creationTime=t,lastUpdateTime=t"
            },
            "_allow": [
                "#4:12",
                "#5:13",
                "#4:14"
            ],
            "_allowRead": [
                "#4:13",
                "#4:11"
            ],
            "out_IsIdentifiedBy": [
                "#168:5"
            ],
            "out_ConsistsOf": [
                "#165:32",
                "#166:32",
                "#164:33"
            ],
            "in_Hosts": [
                "#230:2"
            ],
            "@fieldTypes": "_allow=n,_allowRead=n,out_IsIdentifiedBy=g,out_ConsistsOf=g,in_Hosts=g"
        },
        {
            "@type": "d",
            "@rid": "#138:3",
            "@version": 5,
            "@class": "EService",
            "header": {
                "@type": "d",
                "@version": 0,
                "@class": "Header",
                "uuid": "cabca29a-59e4-463d-9932-02c6d68c8ce0",
                "creator": "VREManagement:SmartExecutor:pc-frosini.isti.cnr.it_8080",
                "creationTime": "2017-10-05 17:22:06.340 +0200",
                "lastUpdateTime": "2017-10-05 17:23:44.206 +0200",
                "@fieldTypes": "creationTime=t,lastUpdateTime=t"
            },
            "_allow": [
                "#4:12",
                "#5:15",
                "#4:14"
            ],
            "_allowRead": [
                "#4:13",
                "#4:11"
            ],
            "out_IsIdentifiedBy": [
                "#168:6"
            ],
            "out_ConsistsOf": [
                "#164:36",
                "#165:36",
                "#166:36"
            ],
            "in_Hosts": [
                "#230:3"
            ],
            "@fieldTypes": "_allow=n,_allowRead=n,out_IsIdentifiedBy=g,out_ConsistsOf=g,in_Hosts=g"
        }
    ],
    "notification": "Query executed in 0.197 sec. Returned 2 record(s)"
}

As you can notice only the Vertexes of EServices are returned which they doesn't contains the facets.

Retrieved from "https://wiki.gcube-system.org/index.php?title=Resource_Registry_Service_-_Query_%26_Access&oldid=34485"