Difference between revisions of "Resource Registry Service - Context Management"

From Gcube Wiki
Jump to: navigation, search
(→‎Context Collection)
Line 5: Line 5:
 
|}
 
|}
  
−
This sections provide information regarding how to interact with [[Information System Resource Registry#Resource_Registry Service | Resource Registry Service]] for Context and Schema Port Type.  
+
These sections provide information regarding how to interact with [[Information System Resource Registry#Resource_Registry Service | Resource Registry Service]] for Context and Type Management.  
 
REST API are presented for each functionality.
 
REST API are presented for each functionality.
−
Java libraries for these port types are currently under development and will be document as soon as available.
 
  
 
Please note that the provided examples can intentionally hide some details in the response to avoid unneeded complexity.
 
Please note that the provided examples can intentionally hide some details in the response to avoid unneeded complexity.

Revision as of 13:33, 1 July 2021

These sections provide information regarding how to interact with Resource Registry Service for Context and Type Management. REST API are presented for each functionality.

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

Context Management

It is responsible for managing hierarchical Context as defined by the IS Model.

Security configuration based on Authorization Framework make this port type accessible only from Resource Manager. In other words, no others client is allowed to manage Context rather than Resource Manager.

Context requirements:

  • No predefined number of levels.
  • Possibility to change the name of the Context with no impact for any component.
  • Possibility to move a Context from a parent Context to another.

Any request to this port type has success if the following guarantees are satisfied:

  • the hierarchy of contexts is a tree with an arbitrary number of levels;
  • two contexts with the same name can only exist if they have different parents;
  • any update to a context does not have any side effect on the instances belonging to the context;
  • it is not possible to delete a context if it contains instances. It is the responsibility of the clients to remove the instances from the context (or delete them) before trying to delete the context.


It exposes the common functionalities of any collection as recommended by ROA such as:

  • List: allows to enumerate the contexts;
  • Create: allows to create a new context as a child of another context (if any). The context has a name;
  • Exists: allows to check if a Context exists;
  • Read: allows to read a Context;
  • Update:
    • Rename: rename a context;
    • Move: move a context as a child of another Context;
  • Delete: allows to delete a Context.

The following table shows the exposed HTTP APIs for contexts collection.

Operation HTTP Method URL
List GET /contexts
Create PUT /contexts/{UUID}
Exists HEAD /contexts/{UUID}
Read GET /contexts/{UUID}
Update PUT /contexts/{UUID}
Delete DELETE /contexts/{UUID}

Java Client

To use the Java library to interact with Context Collection declare the following dependency in your pom.xml file. 

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

Context Collection

List

List all available contexts. 

GET /resource-registry/contexts


We have 5 Contexts organized in the following Context Tree: 

- 007f9154-25fa-4f52-9cd4-ec1f8c3c3ba (testROOT)
|
|---- 30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb (testVO)
|   |
|   |---- 55e3f48e-2aaf-4a2d-89c4-05cb43822c4a (testVRE)
|
|---- cbe1855b-97c5-495e-a24d-b04428bb4ef6 (anotherVO)

[
	{
		"name": "testRoot",
		"header": {
			"@class": "Header",
			"creator": "luca.frosini",
			"creationTime": "2020-10-30 17:03:42.339 +0100",
			"modifiedBy": "luca.frosini",
			"uuid": "007f9154-25fa-4f52-9cd4-ec1f8c3c3baf",
			"lastUpdateTime": "2020-10-30 17:03:42.339 +0100"
		},
		"@class": "Context",
		"@superClasses": [
			"EntityElement"
		],
		"children": [
			{
				"header": {
					"@class": "Header",
					"creator": "luca.frosini",
					"creationTime": "2020-10-30 17:03:46.215 +0100",
					"modifiedBy": "luca.frosini",
					"uuid": "197d9848-378b-430b-a30d-008d30cbd4b4",
					"lastUpdateTime": "2020-10-30 17:03:46.215 +0100"
				},
				"@class": "IsParentOf",
				"@superClasses": [
					"RelationElement"
				],
				"target": {
					"name": "testVO",
					"header": {
						"@class": "Header",
						"creator": "luca.frosini",
						"creationTime": "2020-10-30 17:03:46.223 +0100",
						"modifiedBy": "luca.frosini",
						"uuid": "30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb",
						"lastUpdateTime": "2020-10-30 17:03:46.223 +0100"
					},
					"@class": "Context",
					"@superClasses": [
						"EntityElement"
					]
				}
			},
			{
				"header": {
					"@class": "Header",
					"creator": "luca.frosini",
					"creationTime": "2020-10-30 17:03:49.997 +0100",
					"modifiedBy": "luca.frosini",
					"uuid": "cd21b948-4a84-4843-aa5a-3c801a6a87fa",
					"lastUpdateTime": "2020-10-30 17:03:49.997 +0100"
				},
				"@class": "IsParentOf",
				"@superClasses": [
					"RelationElement"
				],
				"target": {
					"name": "anotherVO",
					"header": {
						"@class": "Header",
						"creator": "luca.frosini",
						"creationTime": "2020-10-30 17:03:50.006 +0100",
						"modifiedBy": "luca.frosini",
						"uuid": "cbe1855b-97c5-495e-a24d-b04428bb4ef6",
						"lastUpdateTime": "2020-10-30 17:03:50.006 +0100"
					},
					"@class": "Context",
					"@superClasses": [
						"EntityElement"
					]
				}
			}
		]
	},
	{
		"name": "testVO",
		"header": {
			"@class": "Header",
			"creator": "luca.frosini",
			"creationTime": "2020-10-30 17:03:46.223 +0100",
			"modifiedBy": "luca.frosini",
			"uuid": "30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb",
			"lastUpdateTime": "2020-10-30 17:03:46.223 +0100"
		},
		"@class": "Context",
		"@superClasses": [
			"EntityElement"
		],
		"parent": {
			"header": {
				"@class": "Header",
				"creator": "luca.frosini",
				"creationTime": "2020-10-30 17:03:46.215 +0100",
				"modifiedBy": "luca.frosini",
				"uuid": "197d9848-378b-430b-a30d-008d30cbd4b4",
				"lastUpdateTime": "2020-10-30 17:03:46.215 +0100"
			},
			"@class": "IsParentOf",
			"@superClasses": [
				"RelationElement"
			],
			"source": {
				"name": "testRoot",
				"header": {
					"@class": "Header",
					"creator": "luca.frosini",
					"creationTime": "2020-10-30 17:03:42.339 +0100",
					"modifiedBy": "luca.frosini",
					"uuid": "007f9154-25fa-4f52-9cd4-ec1f8c3c3baf",
					"lastUpdateTime": "2020-10-30 17:03:42.339 +0100"
				},
				"@class": "Context",
				"@superClasses": [
					"EntityElement"
				]
			}
		},
		"children": [
			{
				"header": {
					"@class": "Header",
					"creator": "luca.frosini",
					"creationTime": "2020-10-30 17:03:54.633 +0100",
					"modifiedBy": "luca.frosini",
					"uuid": "282064cc-d71a-4ac4-9228-2e459d2880f2",
					"lastUpdateTime": "2020-10-30 17:03:54.633 +0100"
				},
				"@class": "IsParentOf",
				"@superClasses": [
					"RelationElement"
				],
				"target": {
					"name": "testVRE",
					"header": {
						"@class": "Header",
						"creator": "luca.frosini",
						"creationTime": "2020-10-30 17:03:54.643 +0100",
						"modifiedBy": "luca.frosini",
						"uuid": "55e3f48e-2aaf-4a2d-89c4-05cb43822c4a",
						"lastUpdateTime": "2020-10-30 17:03:54.643 +0100"
					},
					"@class": "Context",
					"@superClasses": [
						"EntityElement"
					]
				}
			}
		]
	},
	{
		"name": "testVRE",
		"header": {
			"@class": "Header",
			"creator": "luca.frosini",
			"creationTime": "2020-10-30 17:03:54.643 +0100",
			"modifiedBy": "luca.frosini",
			"uuid": "55e3f48e-2aaf-4a2d-89c4-05cb43822c4a",
			"lastUpdateTime": "2020-10-30 17:03:54.643 +0100"
		},
		"@class": "Context",
		"@superClasses": [
			"EntityElement"
		],
		"parent": {
			"header": {
				"@class": "Header",
				"creator": "luca.frosini",
				"creationTime": "2020-10-30 17:03:54.633 +0100",
				"modifiedBy": "luca.frosini",
				"uuid": "282064cc-d71a-4ac4-9228-2e459d2880f2",
				"lastUpdateTime": "2020-10-30 17:03:54.633 +0100"
			},
			"@class": "IsParentOf",
			"@superClasses": [
				"RelationElement"
			],
			"source": {
				"name": "testVO",
				"header": {
					"@class": "Header",
					"creator": "luca.frosini",
					"creationTime": "2020-10-30 17:03:46.223 +0100",
					"modifiedBy": "luca.frosini",
					"uuid": "30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb",
					"lastUpdateTime": "2020-10-30 17:03:46.223 +0100"
				},
				"@class": "Context",
				"@superClasses": [
					"EntityElement"
				]
			}
		}
	},
	{
		"name": "anotherVO",
		"header": {
			"@class": "Header",
			"creator": "luca.frosini",
			"creationTime": "2020-10-30 17:03:50.006 +0100",
			"modifiedBy": "luca.frosini",
			"uuid": "cbe1855b-97c5-495e-a24d-b04428bb4ef6",
			"lastUpdateTime": "2020-10-30 17:03:50.006 +0100"
		},
		"@class": "Context",
		"@superClasses": [
			"EntityElement"
		],
		"parent": {
			"header": {
				"@class": "Header",
				"creator": "luca.frosini",
				"creationTime": "2020-10-30 17:03:49.997 +0100",
				"modifiedBy": "luca.frosini",
				"uuid": "cd21b948-4a84-4843-aa5a-3c801a6a87fa",
				"lastUpdateTime": "2020-10-30 17:03:49.997 +0100"
			},
			"@class": "IsParentOf",
			"@superClasses": [
				"RelationElement"
			],
			"source": {
				"name": "testRoot",
				"header": {
					"@class": "Header",
					"creator": "luca.frosini",
					"creationTime": "2020-10-30 17:03:42.339 +0100",
					"modifiedBy": "luca.frosini",
					"uuid": "007f9154-25fa-4f52-9cd4-ec1f8c3c3baf",
					"lastUpdateTime": "2020-10-30 17:03:42.339 +0100"
				},
				"@class": "Context",
				"@superClasses": [
					"EntityElement"
				]
			}
		}
	}
]

Create

PUT /resource-registry/contexts/{{UUID}}
Description

Create new Context as child of another Context (if any).

Example 1

Create a new Context with name testROOT with no parent. It is a ROOT Context.

Request URL 

PUT /resource-registry/context/007f9154-25fa-4f52-9cd4-ec1f8c3c3baf

Body 

{
	"@class": "Context",
	"name": "testRoot",
	"header": {
		"@class": "Header",
		"uuid": "007f9154-25fa-4f52-9cd4-ec1f8c3c3baf"
	}
}


Response Body 

{
    "name": "testRoot",
    "header": {
        "@class": "Header",
        "creator": "luca.frosini",
        "creationTime": "2020-10-30 17:03:42.339 +0100",
        "modifiedBy": "luca.frosini",
        "uuid": "007f9154-25fa-4f52-9cd4-ec1f8c3c3baf",
        "lastUpdateTime": "2020-10-30 17:03:42.339 +0100"
    },
    "@class": "Context",
    "@superClasses": [
        "EntityElement"
    ]
}
Example 2

Create a new Context with name testVO as child of Context with UUID 007f9154-25fa-4f52-9cd4-ec1f8c3c3baf (testROOT).

Request URL 

PUT /resource-registry/contexts/30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb


Body 

{
    "@class": "Context",
    "header": {
        "@class": "Header",
        "uuid": "30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb"
    },
    "name": "testVO",
    "parent": {
        "@class": "IsParentOf",
        "source": {
            "@class": "Context",
            "header": {
                "@class": "Header",
                "uuid": "007f9154-25fa-4f52-9cd4-ec1f8c3c3baf"
            }
        }
    }
}


Response Body 

{
    "name": "testVO",
    "header": {
        "@class": "Header",
        "creator": "luca.frosini",
        "creationTime": "2020-10-30 17:03:46.223 +0100",
        "modifiedBy": "luca.frosini",
        "uuid": "30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb",
        "lastUpdateTime": "2020-10-30 17:03:46.223 +0100"
    },
    "@class": "Context",
    "@superClasses": [
        "EntityElement"
    ],
    "parent": {
        "header": {
            "@class": "Header",
            "creator": "luca.frosini",
            "creationTime": "2020-10-30 17:03:46.215 +0100",
            "modifiedBy": "luca.frosini",
            "uuid": "197d9848-378b-430b-a30d-008d30cbd4b4",
            "lastUpdateTime": "2020-10-30 17:03:46.215 +0100"
        },
        "@class": "IsParentOf",
        "@superClasses": [
            "RelationElement"
        ],
        "source": {
            "name": "testRoot",
            "header": {
                "@class": "Header",
                "creator": "luca.frosini",
                "creationTime": "2020-10-30 17:03:42.339 +0100",
                "modifiedBy": "luca.frosini",
                "uuid": "007f9154-25fa-4f52-9cd4-ec1f8c3c3baf",
                "lastUpdateTime": "2020-10-30 17:03:42.339 +0100"
            },
            "@class": "Context",
            "@superClasses": [
                "EntityElement"
            ]
        }
    }
}
Create With Java Client

This Java code snippet shows how to create contexts used in examples 1 and 2. 


ResourceRegistryContextClient resourceRegistryContextClient = ResourceRegistryContextClientFactory.create();
 
Context testROOTContext = new ContextImpl("testROOT");
// Java class generate a random UUID and use to interact with Resource Regsitry Service
// To specify the UUID 
// UUID testROOTUUID = UUID.fromString("007f9154-25fa-4f52-9cd4-ec1f8c3c3baf");
// Context testROOTContext = new ContextImpl("testROOT", testROOTUUID);
testROOTContext = resourceRegistryContextClient.create(testROOTContext);
 
 
Context testVOContext = new ContextImpl("testVO");
// To specify the UUID 
// UUID testVOUUID = UUID.fromString("30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb");
// Context testVOContext = new ContextImpl("testVO", testVOTUUID);
testVOContext.setParent(testROOTContext);
testVOContext = resourceRegistryContextClient.create(testVOContext);

Read

GET /resource-registry/context/{UUID}
Description

Return the definition of the Context identified by the UUID provided as the path parameter.

Example 1

Read the Context having UUID 007f9154-25fa-4f52-9cd4-ec1f8c3c3baf

Request URL 

GET /resource-registry/contexts/007f9154-25fa-4f52-9cd4-ec1f8c3c3baf

Response Body 

{
    "name": "testRoot",
    "header": {
        "@class": "Header",
        "creator": "luca.frosini",
        "creationTime": "2020-10-30 17:03:42.339 +0100",
        "modifiedBy": "luca.frosini",
        "uuid": "007f9154-25fa-4f52-9cd4-ec1f8c3c3baf",
        "lastUpdateTime": "2020-10-30 17:03:42.339 +0100"
    },
    "@class": "Context",
    "@superClasses": [
        "EntityElement"
    ],
    "children": [
        {
            "header": {
                "@class": "Header",
                "creator": "luca.frosini",
                "creationTime": "2020-10-30 17:03:46.215 +0100",
                "modifiedBy": "luca.frosini",
                "uuid": "197d9848-378b-430b-a30d-008d30cbd4b4",
                "lastUpdateTime": "2020-10-30 17:03:46.215 +0100"
            },
            "@class": "IsParentOf",
            "@superClasses": [
                "RelationElement"
            ],
            "target": {
                "name": "testVO",
                "header": {
                    "@class": "Header",
                    "creator": "luca.frosini",
                    "creationTime": "2020-10-30 17:03:46.223 +0100",
                    "modifiedBy": "luca.frosini",
                    "uuid": "30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb",
                    "lastUpdateTime": "2020-10-30 17:03:46.223 +0100"
                },
                "@class": "Context",
                "@superClasses": [
                    "EntityElement"
                ]
            }
        },
        {
            "header": {
                "@class": "Header",
                "creator": "luca.frosini",
                "creationTime": "2020-10-30 17:03:49.997 +0100",
                "modifiedBy": "luca.frosini",
                "uuid": "cd21b948-4a84-4843-aa5a-3c801a6a87fa",
                "lastUpdateTime": "2020-10-30 17:03:49.997 +0100"
            },
            "@class": "IsParentOf",
            "@superClasses": [
                "RelationElement"
            ],
            "target": {
                "name": "anotherVO",
                "header": {
                    "@class": "Header",
                    "creator": "luca.frosini",
                    "creationTime": "2020-10-30 17:03:50.006 +0100",
                    "modifiedBy": "luca.frosini",
                    "uuid": "cbe1855b-97c5-495e-a24d-b04428bb4ef6",
                    "lastUpdateTime": "2020-10-30 17:03:50.006 +0100"
                },
                "@class": "Context",
                "@superClasses": [
                    "EntityElement"
                ]
            }
        }
    ]
}
Example 2

Read the Context having UUID 30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb

Request URL 

GET /resource-registry/contexts/30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb

Response Body 

{
    "name": "testVO",
    "header": {
        "@class": "Header",
        "creator": "luca.frosini",
        "creationTime": "2020-10-30 17:03:46.223 +0100",
        "modifiedBy": "luca.frosini",
        "uuid": "30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb",
        "lastUpdateTime": "2020-10-30 17:03:46.223 +0100"
    },
    "@class": "Context",
    "@superClasses": [
        "EntityElement"
    ],
    "parent": {
        "header": {
            "@class": "Header",
            "creator": "luca.frosini",
            "creationTime": "2020-10-30 17:03:46.215 +0100",
            "modifiedBy": "luca.frosini",
            "uuid": "197d9848-378b-430b-a30d-008d30cbd4b4",
            "lastUpdateTime": "2020-10-30 17:03:46.215 +0100"
        },
        "@class": "IsParentOf",
        "@superClasses": [
            "RelationElement"
        ],
        "source": {
            "name": "testRoot",
            "header": {
                "@class": "Header",
                "creator": "luca.frosini",
                "creationTime": "2020-10-30 17:03:42.339 +0100",
                "modifiedBy": "luca.frosini",
                "uuid": "007f9154-25fa-4f52-9cd4-ec1f8c3c3baf",
                "lastUpdateTime": "2020-10-30 17:03:42.339 +0100"
            },
            "@class": "Context",
            "@superClasses": [
                "EntityElement"
            ]
        }
    },
    "children": [
        {
            "header": {
                "@class": "Header",
                "creator": "luca.frosini",
                "creationTime": "2020-10-30 17:03:54.633 +0100",
                "modifiedBy": "luca.frosini",
                "uuid": "282064cc-d71a-4ac4-9228-2e459d2880f2",
                "lastUpdateTime": "2020-10-30 17:03:54.633 +0100"
            },
            "@class": "IsParentOf",
            "@superClasses": [
                "RelationElement"
            ],
            "target": {
                "name": "testVRE",
                "header": {
                    "@class": "Header",
                    "creator": "luca.frosini",
                    "creationTime": "2020-10-30 17:03:54.643 +0100",
                    "modifiedBy": "luca.frosini",
                    "uuid": "55e3f48e-2aaf-4a2d-89c4-05cb43822c4a",
                    "lastUpdateTime": "2020-10-30 17:03:54.643 +0100"
                },
                "@class": "Context",
                "@superClasses": [
                    "EntityElement"
                ]
            }
        }
    ]
}
Read With Java Client

Read using a string representing the UUID. 

ResourceRegistryContextClient resourceRegistryContextClient = ResourceRegistryContextClientFactory.create();
Context testVOContext = resourceRegistryContextClient.read("30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb");


Read using UUID. This normally used when we already have the UUID instance. 

ResourceRegistryContextClient resourceRegistryContextClient = ResourceRegistryContextClientFactory.create();
UUID testVOUUID = UUID.fromString("30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb");
Context testVOContext = resourceRegistryContextClient.read(testVOUUID);


Read using context instace. This normally used when we already have the context instance. 

UUID testVOUUID = UUID.fromString("30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb");
Context testVOContext = new ContextImpl("testVO", testVOTUUID);
ResourceRegistryContextClient resourceRegistryContextClient = ResourceRegistryContextClientFactory.create();
Context testVOContext = resourceRegistryContextClient.read(testVOContext);

Update

PUT /resource-registry/contexts/{UUID}
Description

Update a Context identified by the UUID provided as the path parameter.

The possible updates are on:

  • name;
  • parent Context.
Rename Context

Rename a Context 007f9154-25fa-4f52-9cd4-ec1f8c3c3baf (was testVO) to the new name devVO.

Request URL 

PUT /resource-registry/contexts/007f9154-25fa-4f52-9cd4-ec1f8c3c3baf

Body 

{
    "@class": "Context",
    "header": {
        "@class": "Header",
        "uuid": "30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb"
    },
    "name": "devVO",
    "parent": {
        "@class": "IsParentOf",
        "source": {
            "@class": "Context",
            "header": {
                "@class": "Header",
                "uuid": "007f9154-25fa-4f52-9cd4-ec1f8c3c3baf"
            },
            "name": "test"
        }
    }
}

Response Body 

{
    "name": "devVO",
    "header": {
        "@class": "Header",
        "creator": "luca.frosini",
        "creationTime": "2020-10-30 17:03:46.223 +0100",
        "modifiedBy": "luca.frosini",
        "uuid": "30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb",
        "lastUpdateTime": "2020-10-30 17:11:03.714 +0100"
    },
    "@class": "Context",
    "@superClasses": [
        "EntityElement"
    ],
    "parent": {
        "header": {
            "@class": "Header",
            "creator": "luca.frosini",
            "creationTime": "2020-10-30 17:03:46.215 +0100",
            "modifiedBy": "luca.frosini",
            "uuid": "197d9848-378b-430b-a30d-008d30cbd4b4",
            "lastUpdateTime": "2020-10-30 17:03:46.215 +0100"
        },
        "@class": "IsParentOf",
        "@superClasses": [
            "RelationElement"
        ],
        "source": {
            "name": "testRoot",
            "header": {
                "@class": "Header",
                "creator": "luca.frosini",
                "creationTime": "2020-10-30 17:03:42.339 +0100",
                "modifiedBy": "luca.frosini",
                "uuid": "007f9154-25fa-4f52-9cd4-ec1f8c3c3baf",
                "lastUpdateTime": "2020-10-30 17:03:42.339 +0100"
            },
            "@class": "Context",
            "@superClasses": [
                "EntityElement"
            ]
        }
    },
    "children": [
        {
            "header": {
                "@class": "Header",
                "creator": "luca.frosini",
                "creationTime": "2020-10-30 17:03:54.633 +0100",
                "modifiedBy": "luca.frosini",
                "uuid": "282064cc-d71a-4ac4-9228-2e459d2880f2",
                "lastUpdateTime": "2020-10-30 17:03:54.633 +0100"
            },
            "@class": "IsParentOf",
            "@superClasses": [
                "RelationElement"
            ],
            "target": {
                "name": "testVRE",
                "header": {
                    "@class": "Header",
                    "creator": "luca.frosini",
                    "creationTime": "2020-10-30 17:03:54.643 +0100",
                    "modifiedBy": "luca.frosini",
                    "uuid": "55e3f48e-2aaf-4a2d-89c4-05cb43822c4a",
                    "lastUpdateTime": "2020-10-30 17:03:54.643 +0100"
                },
                "@class": "Context",
                "@superClasses": [
                    "EntityElement"
                ]
            }
        }
    ]
}
Move Context

We have 5 Contexts organized in the following Context Tree: 

- 007f9154-25fa-4f52-9cd4-ec1f8c3c3ba (testROOT)
|
|---- 30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb (testVO)
|   |
|   |---- 55e3f48e-2aaf-4a2d-89c4-05cb43822c4a (testVRE)
|
|---- cbe1855b-97c5-495e-a24d-b04428bb4ef6 (anotherVO)

We want to move Context 55e3f48e-2aaf-4a2d-89c4-05cb43822c4a (testVRE) as child of the Context cbe1855b-97c5-495e-a24d-b04428bb4ef6 (anotherVO) in palce of 30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb (testVO)

We will obtain the following Context tree 

- 007f9154-25fa-4f52-9cd4-ec1f8c3c3ba (testROOT)
|
|---- 30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb (testVO)
|
|---- cbe1855b-97c5-495e-a24d-b04428bb4ef6 (anotherVO)
|   |
|   |---- 55e3f48e-2aaf-4a2d-89c4-05cb43822c4a (testVRE)


If we read the Context 55e3f48e-2aaf-4a2d-89c4-05cb43822c4a' (testVRE) before moving it we have: 

{
    "name": "testVRE",
    "header": {
        "@class": "Header",
        "creator": "luca.frosini",
        "creationTime": "2020-10-30 17:03:54.643 +0100",
        "modifiedBy": "luca.frosini",
        "uuid": "55e3f48e-2aaf-4a2d-89c4-05cb43822c4a",
        "lastUpdateTime": "2020-10-30 17:16:00.768 +0100"
    },
    "@class": "Context",
    "@superClasses": [
        "EntityElement"
    ],
    "parent": {
        "header": {
            "@class": "Header",
            "creator": "luca.frosini",
            "creationTime": "2020-10-30 17:16:00.755 +0100",
            "modifiedBy": "luca.frosini",
            "uuid": "a6ab3939-6f6b-4d2d-9ef1-497a8330ea5e",
            "lastUpdateTime": "2020-10-30 17:16:00.755 +0100"
        },
        "@class": "IsParentOf",
        "@superClasses": [
            "RelationElement"
        ],
        "source": {
            "name": "testVO",
            "header": {
                "@class": "Header",
                "creator": "luca.frosini",
                "creationTime": "2020-10-30 17:03:46.223 +0100",
                "modifiedBy": "luca.frosini",
                "uuid": "30bdb3cc-cf18-4d26-bdb7-0bb8ffb481eb",
                "lastUpdateTime": "2020-10-30 17:13:02.481 +0100"
            },
            "@class": "Context",
            "@superClasses": [
                "EntityElement"
            ]
        }
    }
}

Request URL 

PUT /resource-registry/contexts/55e3f48e-2aaf-4a2d-89c4-05cb43822c4a

Body 

{
    "@class": "Context",
    "header": {
        "@class": "Header",
        "uuid": "55e3f48e-2aaf-4a2d-89c4-05cb43822c4a"
    },
    "name": "testVRE",
    "parent": {
        "@class": "IsParentOf",
        "source": {
            "@class": "Context",
            "header": {
                "@class": "Header",
                "uuid": "cbe1855b-97c5-495e-a24d-b04428bb4ef6"
            }
        }
    }
}

Response Body 

{
    "name": "testVRE",
    "header": {
        "@class": "Header",
        "creator": "luca.frosini",
        "creationTime": "2020-10-30 17:03:54.643 +0100",
        "modifiedBy": "luca.frosini",
        "uuid": "55e3f48e-2aaf-4a2d-89c4-05cb43822c4a",
        "lastUpdateTime": "2020-10-30 17:16:38.592 +0100"
    },
    "@class": "Context",
    "@superClasses": [
        "EntityElement"
    ],
    "parent": {
        "header": {
            "@class": "Header",
            "creator": "luca.frosini",
            "creationTime": "2020-10-30 17:16:38.580 +0100",
            "modifiedBy": "luca.frosini",
            "uuid": "170cc2b2-e772-4e07-a0a2-6f9f36ac6b12",
            "lastUpdateTime": "2020-10-30 17:16:38.580 +0100"
        },
        "@class": "IsParentOf",
        "@superClasses": [
            "RelationElement"
        ],
        "source": {
            "name": "anotherVO",
            "header": {
                "@class": "Header",
                "creator": "luca.frosini",
                "creationTime": "2020-10-30 17:03:50.006 +0100",
                "modifiedBy": "luca.frosini",
                "uuid": "cbe1855b-97c5-495e-a24d-b04428bb4ef6",
                "lastUpdateTime": "2020-10-30 17:03:50.006 +0100"
            },
            "@class": "Context",
            "@superClasses": [
                "EntityElement"
            ]
        }
    }
}

Delete

DELETE /resource-registry/contexts/{{UUID}}


Delete the Context identified by the UUID provided as the path parameter.


For example to delete the Context having UUID 55e3f48e-2aaf-4a2d-89c4-05cb43822c4a we just need to perform the following HTTP request 

DELETE /resource-registry/contexts/55e3f48e-2aaf-4a2d-89c4-05cb43822c4a

The resource registry performs the following checks before deleting a context:

  • the context MUST have no children: this implies that you can't delete the testVO context if you don't have deleted (or moved to another parent) the context testVRE;
  • the context MUST NOT have associated entities and relation instances: this implies that the client must remove in advance the available instances from the context.

Types Management

Types Management is responsible for managing the instantiation of the [Facet_Based_Resource_Model|IS Model]] by allowing the definition of entities, relations and embedded types and their schema.

The exposed APIs are:

  • Create: allows to create a new Type;
  • Exists: allows to check if a Type exists;
  • Read: allows to read a Type. This API allows also the listing of type and its subtypes by indicating hte query parameter polymorphic=true. By indicating the polimorphic parameter and as {TYPE_NAME} on of the base type of the IS Model (i.e. Resource, Facet, IsRelatedTo, ConsistsOf), it is possibile to list all the types of such base type.
Operation HTTP Method URL
Create PUT /types/{TYPE_NAME}
Exists HEAD /types/{TYPE_NAME}
Read GET /types/{TYPE_NAME}[?polymorphic=false]


Type Definition

Any Type is described by the following attributes:

  • name (String): Type Name
  • description (String): The description of the Type. default=null.
  • abstractType (Boolean): Indicate if the type is abstract so that it cannot be instantiated. In other words, only subtypes of this type can be instantiated. default=false.
  • superclasses (List<String>): The list of all supertypes of this type. Multiple Inheritance is supported.
  • Zero o more Properties

Property

Any Property is described by the following attributes:

  • name : Property Name
  • type : The Type of the Property (e.g. String, Integer, ...). See Property Type
  • description : The description of the Property. default=null.
  • mandatory : Indicate if the Property is mandatory. default=false.
  • readOnly : The Property cannot change its value. default=false.
  • notNull : Whether the property must assume a value diverse from 'null' or not. default=false
  • max : default=null
  • min : default=null
  • regexpr : A Regular Expression to validate the property value, default=null. A good online tool for regex is available at https://regex101.com/
Property Type Mapping

Property Type are mapped to and integer to be used in property definition:

Type binder is defined here: [1]

Type Integer Mapping Java type Description
Boolean 0 java.lang.Boolean or boolean Handles only the values True or False.
Integer 1 java.lang.Integer or int or java.math.BigInteger 32-bit signed Integers.
Short 2 java.lang.Short or short Small 16-bit signed integers.
Long 3 java.lang.Long or long Big 64-bit signed integers.
Float 4 java.lang.Float or float Decimal numbers
Double 5 java.lang.Double or double Decimal numbers with high precision.
Date 6 java.util.Date Any date with the precision up to milliseconds.
String 7 java.lang.String Any string as alphanumeric sequence of chars.
Binary 8 java.lang.Byte[] or byte[] Can contain any value as byte array.
Embedded 9 ? extends org.gcube.informationsystem.model.embedded.Embedded This is an Object contained inside the owner Entity and has no Header. It is reachable only by navigating the owner Entity.
Embedded list 10 List<? extends org.gcube.informationsystem.model.embedded.Embedded> List of Objects contained inside the owner Entity and have no Header. They are reachable only by navigating the owner Entity.
Embedded set 11 Set<? extends org.gcube.informationsystem.model.embedded.Embedded> Set (no duplicates) of Objects contained inside the owner Entity and have no Header. They are reachable only by navigating the owner Entity.
Embedded map 12 Map<String, ? extends org.gcube.informationsystem.model.embedded.Embedded> Map of Objects contained inside the owner Entity and have no Header. They are reachable only by navigating the owner Entity.
Byte 17 java.lang.Byte or byte Single byte. usesful to store small 8-bit signed integers.

Type Creation

PUT /resource-registry/schema/{ Type Name }

Description

Allow to create new Entity or Relation or Embedded Type.

Parameters

Name Type Required Description
Type Name String true The name of the new type to create

Responses

Code Type Description
200 String The json representation of the newly created type (which is the same of the request)

Examples

Resource Type Creation
PUT /resource-registry/schema/Actor

Request Body 

{
	"name":"Actor",
	"description":"Any entity (human or machine) playing an active role.",
	"abstractType":true, /* If the Resource cannot be instantiated */
	"superclasses":["Resource"], /* Resource or any registered specialization. */
	"properties":null /* MUST be null. The Resource cannot have any property. */
}
Facet Type Creation
PUT /resource-registry/schema/ContactFacet

Request Body 

{
	"name":"ContactFacet",
	"description":"This facet is expected to capture contact information",
	"abstractType": false,
	"superclasses":["Facet"],
	"properties":[
		{
			"name":"name",
			"description":"First Name",
			"mandatory":true,
			"readonly":false,
			"notnull":true,
			"max":null,
			"min":null,
			"regexpr":null,
			"linkedType":null,
			"linkedClass":null,
			"type":7 /* String*/
		},{
			"name":"eMail",
			"description": "A restricted range of RFC‑822 compliant email address. ... ",
			"mandatory":true,
			"readonly":false,
			"notnull":true,
			"max":null,
			"min":null,
			"regexpr":"^[a-z0-9._%+-]{1,128}@[a-z0-9.-]{1,128}$",
			"linkedType":null,
			"linkedClass":null,
			"type":7 /* String */
		}
	]
}
IsRelatedTo Type Creation
PUT /resource-registry/schema/Hosts

Request Body 

{
	"name":"Hosts",
	"description": "…”,
	"abstractType":false,
	"superclasses":["IsRelatedTo"],
	"properties":[]
}
ConsistsOf Type Creation
PUT /resource-registry/schema/HasContact

Request Body 

{
	"name":"HasContact",
	"description":"",
	"abstractType":true,
	"superclasses":["ConsistsOf"],
	"properties":[]
}
Embedded Type Creation
PUT /resource-registry/schema/AccessPolicy

Request Body 

{
	"name":"AccessPolicy",
	"description":"",
	"abstractType":false,
	"superclasses":["Embedded"],
	"properties":[{
			"name":"policy",
			"description":"",
			"mandatory":false,
			"readonly":false,
			"notnull":false,
			"max":null,
			"min":null,
			"regexpr":null,
			"linkedType":null,
			"linkedClass":”ValueSchema”,
			"type": 9  /* Embedded */
		},{
			"name":"note",
			"description":"",
			"mandatory": false,
			"readonly":false,
			"notnull":false,
			"max":null,
			"min":null,
			"regexpr":null,
			"linkedType":null,
			"linkedClass":null,
			"type":7 /* String */
	}]
}

Read Type Definition

GET /resource-registry/schema/{ Type Name }

Description

Allow to read Type Definition

Parameters

Name Type Required Description
Type Name String true The name of the type you want to retrieve the definition

Responses

Code Type Description
200 String The json representation of the newly created type

Examples

Resource Type
GET /resource-registry/schema/Actor

Response 

{
	"name":"Actor",
	"description":"Any entity (human or machine) playing an active role.",
	"abstractType":true,
	"superclasses":["Resource"],
	"properties":null
}
Facet Type
GET /resource-registry/schema/ContactFacet

Response 

{
	"name":"ContactFacet",
	"description":"This facet is expected to capture contact information",
	"abstractType": false,
	"superclasses":["Facet"],
	"properties":[
		{
			"name":"name",
			"description":"First Name",
			"mandatory":true,
			"readonly":false,
			"notnull":true,
			"max":null,
			"min":null,
			"regexpr":null,
			"linkedType":null,
			"linkedClass":null,
			"type":7 /* String*/
		},{
			"name":"eMail",
			"description": "A restricted range of RFC‑822 compliant email address. ... ",
			"mandatory":true,
			"readonly":false,
			"notnull":true,
			"max":null,
			"min":null,
			"regexpr":"^[a-z0-9._%+-]{1,128}@[a-z0-9.-]{1,128}$",
			"linkedType":null,
			"linkedClass":null,
			"type":7 /* String */
		}
	]
}
IsRelatedTo Type
GET /resource-registry/schema/Hosts

Response 

{
	"name":"Hosts",
	"description": "…”,
	"abstractType":false,
	"superclasses":["IsRelatedTo"],
	"properties":[]
}
ConsistsOf Type
GET /resource-registry/schema/HasContact

Response 

{
	"name":"HasContact",
	"description":"",
	"abstractType":true,
	"superclasses":["ConsistsOf"],
	"properties":[]
}
Embedded Type
GET /resource-registry/schema/AccessPolicy

Response 

{
	"name":"AccessPolicy",
	"description":"",
	"abstractType":false,
	"superclasses":["Embedded"],
	"properties":[{
			"name":"policy",
			"description":"",
			"mandatory":false,
			"readonly":false,
			"notnull":false,
			"max":null,
			"min":null,
			"regexpr":null,
			"linkedType":null,
			"linkedClass":”ValueSchema”,
			"type": 9  /* Embedded */
		},{
			"name":"note",
			"description":"",
			"mandatory": false,
			"readonly":false,
			"notnull":false,
			"max":null,
			"min":null,
			"regexpr":null,
			"linkedType":null,
			"linkedClass":null,
			"type":7 /* String */
	}]
}
Retrieved from "https://gcube.wiki.gcube-system.org/index.php?title=Resource_Registry_Service_-_Context_Management&oldid=34114"