Difference between revisions of "Facet Based Resource Model"
Luca.frosini (Talk | contribs) (→Property) |
m (→Property) |
||
Line 40: | Line 40: | ||
* '''Mandatory''' ('''M'''): Indicate if the Property is mandatory. <code>default=false</code>. | * '''Mandatory''' ('''M'''): Indicate if the Property is mandatory. <code>default=false</code>. | ||
* '''ReadOnly''' ('''RO'''): The Property cannot change its value. <code>default=false</code>. | * '''ReadOnly''' ('''RO'''): The Property cannot change its value. <code>default=false</code>. | ||
− | * '''NotNull''' ('''NN'''): <code>default=false</code> | + | * '''NotNull''' ('''NN'''): Whether the property must assume a value diverse from 'null' or not. <code>default=false</code> |
* '''Max''' ('''Max'''): <code>default=null</code> | * '''Max''' ('''Max'''): <code>default=null</code> | ||
* '''Min''' ('''Min'''): <code>default=null</code> | * '''Min''' ('''Min'''): <code>default=null</code> |
Revision as of 16:36, 7 September 2016
Basic Concepts
- Two typologies of entities are envisaged:
- Resources, i.e. entities representing a description of "thing" to be managed;
- Every Resource is characterised by a number of Facets.
- Facets, i.e. entities contributing to "build" a description of a Resource. Every facet, once attached to a Resource profile captures a certain aspect / characterization of the resource;
- Every facet is characterised by a number of properties;
- Resources, i.e. entities representing a description of "thing" to be managed;
- Two typologies of relations are envisaged:
- isRelatedTo, i.e. a relation linking any two Resources.
- consistsOf, i.e. a relation connecting each Resource with one of the Facets characterizing it;
- Entities and relations can be specialized.
- A number of specializations are identified below. Such specializations are managed by the gCube Core services, i.e. Core services builds upon these specialization to realize its management tasks;
- Other specializations can be defined by clients, the system make it possible to store these additional typologies of relations and facets and to discover them.
- On relations:
- Any relation has a direction, i.e. a "source" (out bound of the relation) and a "target" (in bound of the relation). Anyway the relation can be also navigated in the opposite direction;
- It is not permitted to define a Relation having a Facet as "source". In other words:
- It is not permitted to define a Relation connecting a Facet with another one;
- It is not permitted to define a Relation connecting a Facet with a Resource (as target);
- A Facet instance can be linked (by consistsOf or any specialization of it) from different Resources.
Property
Any Property can be enriched with 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 (M): Indicate if the Property is mandatory.
default=false
. - ReadOnly (RO): The Property cannot change its value.
default=false
. - NotNull (NN): Whether the property must assume a value diverse from 'null' or not.
default=false
- Max (Max):
default=null
- Min (Min):
default=null
- Regexpr (Reg)): A Regular Expression to validate the property value.
default=null
. A goog online tool for regex is avalable at https://regex101.com/
Property Type
Basic Property Type
Type | Description | Java type |
---|---|---|
Boolean | Handles only the values True or False | java.lang.Boolean or boolean
|
Integer | 32-bit signed Integers | java.lang.Integer or int or java.math.BigInteger
|
Short | Small 16-bit signed integers | java.lang.Short or short
|
Long | Big 64-bit signed integers | java.lang.Long or long
|
Float | Decimal numbers | java.lang.Float or float
|
Double | Decimal numbers with high precision | java.lang.Double or double
|
Date | Any date with the precision up to milliseconds. | java.util.Date
|
String | Any string as alphanumeric sequence of chars | java.lang.String
|
Embedded | This is an Object contained inside the owner Entity and has no Header. It is reachable only by navigating the owner Entity. | ? extends org.gcube.informationsystem.model.embedded.Embedded
|
Embedded list | List of Objects contained inside the owner Entity and have no Header. They are reachable only by navigating the owner Entity. | List<? extends org.gcube.informationsystem.model.embedded.Embedded>
|
Embedded set | Set (no duplicates) of Objects contained inside the owner Entity and have no Header. They are reachable only by navigating the owner Entity. | Set<? extends org.gcube.informationsystem.model.embedded.Embedded>
|
Embedded map | Map of Objects contained inside the owner Entity and have no Header. They are reachable only by navigating the owner Entity. | Map<String, ? extends org.gcube.informationsystem.model.embedded.Embedded>
|
Byte | Single byte. usesful to store small 8-bit signed integers | java.lang.Byte or byte
|
Binary | Can contain any value as byte array | java.lang.Byte[] or byte[]
|
Derived Property Type
The following are obtained using a String as real type and adding a validation regex.
Type | Description | Java type |
---|---|---|
Enum | by default it is represented using the String representation of the Enum. So that the primitive type used will be String. The enumeration is checked by setting Regexpr property. The Regular Expression is auto-generated and it will be something like ^(FIRST-ENUM-STRING_REPRESENTATION|SECOND-ENUM-STRING_REPRESENTATION|...|LAST_ENUM_STRING_REPRESENTATION)$ .
Otherwise (if indicated using an annotation), it can be represented using the Integer value of the Enum. So that the primitive type used will be Integer. The enumeration is checked using |
java.lang.Enum or enum
|
UUID | String representation of the UUID. The check is obtained using the regular expression ^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}$
|
java.util.UUID
|
URL | String representation of the URL. No check actually. | java.net.URL
|
URI | String representation of the URI. No check actually. | java.net.URI
|
Header
Every Entity and Relation has an Header automatically filled by the System. The Header has the following properties:
Name | Type | Description | Attributes |
---|---|---|---|
uuid | UUID | This uuid can be used to univocally identify the Entity or the Relation | Mandatory=true NotNull=true ReadOnly=true
|
creator | String | Filled at creation time. The creator is retrieved using the authorization token | Mandatory=true NotNull=true ReadOnly=true
|
creationTime | Date | Creation time in milliseconds. Represent the difference, measured in milliseconds, between the creation time and midnight, January 1, 1970 UTC | Mandatory=true NotNull=true ReadOnly=true
|
lastUpdateTime | Date | Last Update time in milliseconds. Represent the difference, measured in milliseconds, between the last update time and midnight, January 1, 1970 UTC | Mandatory=true NotNull=true
|
Resources and (isRelatedTo) Relations
Facets
Early ideas and thinking on facets were documented at 2nd Generation Resource Model : Facets
Facet
Every Facet has:
- An Header
- Zero or more properties. Some of the properties are predefined, but any other property can be added.
Access Point Facet
The goal of this facet is expected to capture information on “access points” for a resource, i.e. any endpoint to interact with the resource via a known protocol.
Name | Type | Description | Attributes | |
---|---|---|---|---|
entryName | String | An unique identifier | ||
endpoint* | URI | The URI which identify the endpoint of a resource | Mandatory=true ReadOnly=true NotNull=true
|
|
protocol | String | The high-level protocol used by the access point. The String could contains the version if needed.
E.g. WMS not http which is already contained in URI. |
||
description | String | ..... | ||
authorization | String | Contains authorization information. E.g: a token, username:password. By relying on schema it should be sufficient to capture also whether the content is encrypted or not | ||
authorizationSchema | URI | Schema Reference for authorization value | ||
properties | String | This can be an arbitrarily complex element whose "structure" is defined by the associated schema | ||
propertiesSchema | URI | Schema Reference for property values | ||
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Dataset | consistsOf | 0..n | Access Point Facet | The embargoState can be modeled through the access policy defined in the consistsOf relation |
Concrete Dataset | consistsOf | 1..n | Access Point Facet | The embargoState can be modeled through the access policy defined in the consistsOf relation |
E-Service | consistsOf | 1..n | Access Point Facet | Identify the endpoints of the E-Service |
Software | consistsOf | 1..n | Access Point Facet | Links to maven artifact on nexus, javadoc, wiki, svn, etc |
Contact Facet
The goal of this facet is expected to capture contact information.
Name | Type | Description | Attributes | |
---|---|---|---|---|
title | String | E.g. Dr, Mrs, Mr, ... | Mandatory=false
|
|
name | String | First Name | Mandatory=true NotNull=true
|
|
middleName | String | Middle Name | Mandatory=false
|
|
surname | String | Surname | Mandatory=true NotNull=true
|
|
eMail* | String | A restricted range of RFC‑822 compliant email address. Please note that just domain based email address are accepted (not IP based). Please also note that new TLD are also accepted (e.g luca@google without .com which is a valid email address). You can test here the provided regular expression with your input email address https://regex101.com/ before open a ticket. | Mandatory=true NotNull=true Regex=^[a-z0-9._%+-]{1,128}@[a-z0-9.-]{1,128}
|
|
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Actor | isIdentifiedBy | 1..n | Contact Facet | An Actor has at least a Contact Facet which permit to identify the Actor per se. |
Actor | hasContact | 0..n | Contact Facet | An Actor can have other Contact Facets which provide secondary contact information. |
Legal Body | isIdentifiedBy | 1..n | Contact Facet | A Legal Body has at least a Contact Facet which permit to identify the Legal Body per se. |
Person | isIdentifiedBy | 1..n | Contact Facet | A Person has at least a Contact Facet which permit to identify the Person per se. |
Dataset | hasContact | 1..n | Contact Facet | ... |
Dataset | hasContributor | 0..n | Contact Facet | Is he the contributor |
Dataset | hasCreator | 0..n | Contact Facet | Is he the creator |
Dataset | hasCurator | 0..n | Contact Facet | Is he the curator |
Dataset | hasMaintainer | 0..n | Contact Facet | Is he the maintainer |
Dataset | hasOwner | 0..n | Contact Facet | Is he the owner |
Concrete Dataset | hasMaintainer | 1..n | Contact Facet | Is he the maintainer |
Schema | hasContact | 1..n | Contact Facet | ... |
Site | hasContact | 1..n | Contact Facet | ... |
Site | hasMaintainer | 1..n | Contact Facet | ... |
Site | hasManager | 1..n | Contact Facet | ... |
Contact Reference Facet
The goal of this facet is expected to capture contact information.
Name | Type | Description | Attributes | |
---|---|---|---|---|
website | URL | The main website | ||
address | String | A physical address | ||
phone | String | A phone number | ||
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Actor | consistsOf | 0..n | Contact Reference Facet | |
Legal Body | consistsOf | 0..n | Contact Reference Facet | |
Person | consistsOf | 0..n | Contact Reference Facet |
Coverage Facet
The goal of this facet is to collect any extent-related information.
Name | Type | Description | Attributes | |
---|---|---|---|---|
value | String | Value | Mandatory=true NotNull=true
|
|
schema | URI | Schema | Mandatory=true NotNull=true
|
|
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Dataset | hasCoverage | 1..n | Coverage Facet | ... |
Dataset | hasTemporalCoverage | 0..n | Coverage Facet | ... |
Dataset | hasSpatialCoverage | 0..n | Coverage Facet | ... |
CPU Facet
The goal of this facet is to describe CPU information.
Name | Type | Description | Attributes | |
---|---|---|---|---|
model | String | CPU Model | Mandatory=true NotNull=true
|
|
vendor | String | CPU Vendor | Mandatory=true NotNull=true
|
|
clockSpeed | String | Clock Speed with the unit | Mandatory=true NotNull=true
|
|
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Hosting Node | consistsOf | 1..n | CPU Facet | CPU Information |
Descriptive Metadata Facet
The goal of this facet is to collect any descriptive metadata about the resource.
Name | Type | Description | Attributes | |
---|---|---|---|---|
value | String | Inherited. E.g. XML Blob | Mandatory=true NotNull=true
|
|
schema | URI | Schema | Mandatory=true NotNull=true
| |
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Dataset | consistsOf | 0..n | Descriptive Metadata Facet | ... |
Schema | consistsOf | 0..n | Descriptive Metadata Facet | ... |
Event Facet
The goal of this facet is to ...
Name | Type | Description | Attributes | |
---|---|---|---|---|
date | Calendar | Event instant | Mandatory=true NotNull=true
|
|
value | String | Event Value | Mandatory=true NotNull=true
|
|
schema | URI | Event Schema | ||
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Dataset | consistsOf | 0..n | Event Facet | ... |
E-Service | consistsOf | 1..n | Event Facet | E.g. ActivationTime, DeploymentTime |
Hosting Node | consistsOf | 1..n | Event Facet | ... |
Identifier Facet
The goal of this facet is to collect information on Identifiers that can be attached to a resource.
Name | Type | Description | Attributes | |
---|---|---|---|---|
value* | String | The identifier. E.g. http://fr.dbpedia.org/resource/Thunnus de305d54-75b4-431b-adb2-eb6b9e546014 | Mandatory=true NotNull=true
|
|
type* | Enumeration | The typology of identifier. I.e. URI, DOI, IRI, URL, URN, UUID; | Mandatory=true NotNull=true
|
|
isPersistent | boolean | To indicate if the Identifier is persistent or not. | Mandatory=true NotNull=true
| |
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Configuration Template | isIdentifiedBy | 1..n | Identifier Facet | ... |
Configuration | isIdentifiedBy | 1..n | Identifier Facet | ... |
Dataset | isIdentifiedBy | 1..n | Identifier Facet | ... |
Concrete Dataset | isIdentifiedBy | 1..n | Identifier Facet | |
Site | isIdentifiedBy | 1..n | Identifier Facet | ... |
License Facet
Name | Type | Description | Attributes | |
---|---|---|---|---|
name | String | E.g. EUPL 1.1, GPLv2, BSD, ... | Mandatory=true NotNull=true
|
|
textURL | URL | Licence Text URL | Mandatory=true NotNull=true
| |
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Dataset | consistsOf | 0..n | License Facet | The duration of license if any can can be modeled through the expiry date defined in the consistsOf relation |
E-Service | consistsOf | 0..n | License Facet | The specific terms of use for programmatic access to the service |
Software | consistsOf | 1..n | License Facet | ... |
Location Facet
The goal of this facet is to collect information about Location
Name | Type | Description | Attributes | |
---|---|---|---|---|
country | String | The English name of the country. See http://data.okfn.org/data/core/country-list | ||
location | String | The City name. | ||
latitude | String | Latitude | ||
longitude | String | Longitude | ||
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Site | consistsOf | 1..n | Location Facet | ... |
Memory Facet
The goal of this facet is to .....
Name | Type | Description | Attributes | |
---|---|---|---|---|
size | Long | Total amount of memory. | Mandatory=true NotNull=true
|
|
used | Long | usesd amount of memory. | Mandatory=true NotNull=true
|
|
unit | Enum | I.e. Byte, kB (kilobyte 10^3), MB (megabyte 10^6), GB (gigabyte 10^9), TB (terabyte 10^12), PB (petabyte 10^15), EB (exabyte 10^18), ZB (zettabyte 10^21), YB (yottabyte 10^24) | Mandatory=true NotNull=true
|
|
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Hosting Node | hasPersistentMemory | 1..n | Memory Facet | Disk Space |
Hosting Node | hasVolatileMemory | 1..n | Memory Facet | RAM |
Networking Facet
The goal of this facet is to capture Networking information
Name | Type | Description | Attributes | |
---|---|---|---|---|
hostName | String | Host Name | ||
domainName | String | Domain Name | ||
IPAddress | String | IP Address. Validation regular expression ca be foun at http://stackoverflow.com/questions/53497/regular-expression-that-matches-valid-ipv6-addresses#answer-1934546 (Michael Rushton solution) | Mandatory=true NotNull=true Regex='/^(?>(?>([a-f0-9]{1,4})(?>:(?1)){7}|(?!(?:.*[a-f0-9](?>:|$)){8,})((?1)(?>:(?1)){0,6})?::(?2)?)|(?>(?>(?1)(?>:(?1)){5}:|(?!(?:.*[a-f0-9]:){6,})(?3)?::(?>((?1)(?>:(?1)){0,4}):)?)?(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(?>\.(?4)){3}))$/iD'
|
|
mask | String | Network Mask | ||
broadcastAddress | String | Broadcast Address | ||
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Hosting Node | isIdentifiedBy | 1..n | Networking Facet | |
Site | consistsOf | 1..n | Networking Facet |
Provenance Facet
The goal of this facet is to collect information related with resource lineage/provenance.
Name | Type | Description | Attributes | |
---|---|---|---|---|
relationship | Enum | I.e. wasDerivedFrom, wasGeneratedBy | ||
reference | String | resourceID (a reference to the "originator" Resource associated to the resource the facet is attached to by the relationship) | ||
document | String | Provenance Document E.g. the xml format | ||
documentSchema | URI | Document Schema E.g. a reference to the format | ||
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Dataset | consistsOf | 0..n | Provenance Facet |
Schema Facet
The goal of this facet is to provide a way to store a schema.
Name | Type | Description | Attributes | |
---|---|---|---|---|
name* | String | Schema Name | Mandatory=true NotNull=true
|
|
description | String | Schema Description | Mandatory=true NotNull=true
|
|
schemaURL | URL | Schema definition URL (recommended) | ||
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Schema | isIdentifiedBy | 1..n | Schema Facet | ... |
JSON Schema Facet
Even is still under standardization (seems stalled) from IETF is a de-facto standard for JSON http://json-schema.org/. https://tools.ietf.org/html/draft-zyp-json-schema-04 https://tools.ietf.org/html/draft-fge-json-schema-validation-00 https://tools.ietf.org/html/draft-luff-json-hyper-schema-00
Name | Type | Description | Attributes | |
---|---|---|---|---|
content | Embedded | JSON schema definition | Mandatory=true NotNull=true
| |
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Schema | isIdentifiedBy | 0..n | JSON Schema Facet |
XSD Schema Facet
Name | Type | Description | Attributes | |
---|---|---|---|---|
content | String | XSD Schema Definition | Mandatory=true NotNull=true
| |
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Schema | isIdentifiedBy | 0..n | XSD Schema Facet |
Simple Property Facet
The goal of this facet is to collect name-value property.
Name | Type | Description | Attributes | |
---|---|---|---|---|
name | String | Name | Mandatory=true NotNull=true
|
|
value | String | Value | Mandatory=true NotNull=true
| |
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Configuration Template | consistsOf | 1..n | Simple Property Facet | ... |
Hosting Node | consistsOf | 0..n | Simple Property Facet | E.g. Environment Variables |
Software Facet
The goal of this facet is to capture SW related features.
Name | Type | Description | Attributes | |
---|---|---|---|---|
name* | String | The name of the software artefact being described. E.g. artifactId in maven, Service Name in gCube software, the software name for retail software Microsoft Office 2013-SP2. | Mandatory=true NotNull=true
|
|
group* | String | The name of "group" the software artefact belongs to. E.g. groupId in Maven, ServiceClass in gCube software, company name for retail software Microsoft Office 2013-SP2. | Mandatory=true NotNull=true
|
|
version* | String | The particular release of the software artefact. E.g. maven version, Service Version in gCube software, artifactId in maven, the software version for retail software Microsoft Office 2013-SP2. | Mandatory=true NotNull=true
|
|
description | String | A human oriented description of the software artefact being described. | ||
qualifier | String | E.g. packaging or scope in maven, scope level or sharable level in gCube software, target architecture for retail software x86 or amd64. | ||
optional | Boolean | E.g. used to indicate an optional dependency both in maven as far as in gCube. | ||
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
E-Service | isIdentifiedBy | 1..n | Software Facet | The software enabling the E-Service capabilities |
E-Service | consistsOf | 0..n | Software Facet | Software available in the E-Service environment that characterizes the specific E-Service instance |
Running Plugin | isIdentifiedBy | 1..1 | Software Facet | The software enabling the Running Plugin |
Hosting Node | consistsOf | 0..n | Software Facet | Useful to report the hosted software that are not registered in the Resource Registry as Software Resource, e.g. Operating System |
Virtual Service | isIdentifiedBy | 1..n | Software Facet | ... |
Software | isIdentifiedBy | 1..n | Software Facet | Software coordinates which identify the Software per se. |
Software | consistsOf | 1..n | Software Facet | Apart the one connected with isIdentifiedBy relation (gCube coordinates) the others identify the sw in other way e.g. (Maven coordinates) |
Plugin | isIdentifiedBy | 1..n | Software Facet | Software coordinates which identify the Plugin per se. |
State Facet
The goal of this facet is to ...
Name | Type | Description | Attributes | |
---|---|---|---|---|
value | String | The value of the state. | Mandatory=true NotNull=true
| |
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Software | consistsOf | 1..n | State Facet | E.g. Deprecated, Active, Obsolete |
Container State Facet
Name | Type | Description | Attributes | |
---|---|---|---|---|
value | String | The value of the state | Mandatory=true NotNull=true Regex=(started|ready|certified|down|failed)
| |
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Hosting Node | consistsOf | 1..1 | Container State Facet | I.e. started, ready, certified, down, failed |
Service State Facet
Name | Type | Description | Attributes | |
---|---|---|---|---|
value | String | The value of the state | Mandatory=true NotNull=true Regex=(STARTED|ready|down|failed)
| |
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
E-Service | consistsOf | 1..1 | Service State Facet | I.e. STARTED, ready, down, failed |
Subject Facet
The goal of this facet is to ...
Name | Type | Description | Attributes | |
---|---|---|---|---|
value | String | The value of the state. Must be compliant with schema. | Mandatory=true NotNull=true
|
|
schema | URI | The URI of the schema. It is only an informative field. It is not used for validation from IS part. | Mandatory=true NotNull=true
| |
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Dataset | consistsOf | 0..n | Subject Facet | ... |
Schema | consistsOf | 0..n | Subject Facet | ... |
Relations
Every relation has:
- An Header
- A Relation Property
- Zero or More properties (not necessarily predefined, similarly to Facets).
Relation Property
Name | Type | Description |
---|---|---|
referentialIntegrity | Enum | I.e. onDeleteCascadeWhenOrphan, onDeleteCascade, onDeleteKeep. The meaning is related to the relation direction. |
accessPolicy | Embedded (i.e. AccessPolicy) | A policy is characterized by a name, a description, and the period ([start], [end]) when the policies apply |
expiryTime | Long | The expiry date can be used to model the time until the relationship is valid, Expiry time in milliseconds. Represent the difference, measured in milliseconds, between the creation time and midnight, January 1, 1970 UTC |
isRelatedTo
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Resource | isRelatedTo | 0..n | Resource |
belongsTo
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Person | belongsTo | 0..n | Legal Body | ... |
callsFor
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Service | callsFor | 0..n | Service |
demands
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Virtual Service | demands | 0..n | Software |
dependsOn
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Software | dependsOn | 0..n | Software |
discovers
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
E-Service | discovers | 0..n | E-Service |
hosts
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Hosting Node | hosts | 0..n | E-Service |
involves
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Dataset | involves | 0..n | Actor |
isActivatedBy
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Running Plugin | isActivatedBy | 1..1 | E-Service |
isCompliantWith
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Dataset | isCompliantWith | 0..n | Schema |
isConfiguredBy
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Software | isConfiguredBy | 0..n | Configuration Template |
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Dataset | isCorrelatedTo | 0..n | Dataset |
isPartOf
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Concrete Dataset | isPartOf | 0..n | Dataset |
isCustomizedBy
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Service | isCustomizedBy | 0..n | Configuration |
isDerivationOf
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Configuration | isDerivationOf | 1..1 | Configuration Template |
isManagedBy
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Hosting Node | isManagedBy | 0..n | Site |
isOwnedBy
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Site | isOwnedBy | 0..n | Actor |
isPluginOf
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Plugin | isPluginOf | 1..n | Software |
isPoweredBy
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Hosting Node | isPoweredBy | 0..n | Software |
manages
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Service | manages | 0..n | Dataset |
requires
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Software | requires | 0..n | Service |
runs
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
E-Service | runs | 0..n | Software |
runsPlugin
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Running Plugin | runsPlugin | 1..1 | Plugin |
uses
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
E-Service | uses | 0..n | E-Service |
consistsOf
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Resource | consistsOf | 1..n | Facet |
isIdentifiedBy
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resource | isIdentifiedBy | 1..n | Facet | |
Known Usage | ||||
Actor | isIdentifiedBy | 1..n | Contact Facet | |
Legal Body | isIdentifiedBy | 1..n | Contact Facet | |
Person | isIdentifiedBy | 1..n | Contact Facet | |
Configuration Template | isIdentifiedBy | 1..n | Identifier Facet | |
Configuration | isIdentifiedBy | 1..n | Identifier Facet | |
Dataset | isIdentifiedBy | 1..n | Identifier Facet | |
Concrete Dataset | isIdentifiedBy | 1..n | Identifier Facet | |
Service | isIdentifiedBy | 1..n | Facet | |
Virtual Service | isIdentifiedBy | 1..n | Software Facet | ... |
E-Service | isIdentifiedBy | 1..1 | Software Facet | ... |
Schema | isIdentifiedBy | 1..n | Identifier Facet | ... |
Site | isIdentifiedBy | 1..n | Identifier Facet | ... |
Software | isIdentifiedBy | 1..n | Software Facet | Software coordinates which identify the Software per se. |
Plugin | isIdentifiedBy | 1..n | Software Facet | Software coordinates which identify the Plugin per se. |
hasContact
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resource | hasContact | 0..n | Contact Facet | |
Known Usage | ||||
Dataset | hasContact | 1..n | Contact Facet | ... |
hasContributor
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resource | hasContributor | 0..n | Contact Facet | |
Known Usage | ||||
Dataset | hasContributor | 0..n | Contact Facet | Is he the contributor |
hasCreator
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resource | hasCreator | 0..n | Contact Facet | |
Known Usage | ||||
Dataset | hasCreator | 0..n | Contact Facet | Is he the creator |
hasCurator
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resource | hasCurator | 0..n | Contact Facet | |
Known Usage | ||||
Dataset | hasCurator | 0..n | Contact Facet | Is he the curator |
hasDeveloper
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resource | hasDeveloper | 0..n | Contact Facet | |
Known Usage |
hasMaintainer
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resource | hasMaintainer | 0..n | Contact Facet | |
Known Usage | ||||
Dataset | hasMaintainer | 0..n | Contact Facet | Is he the maintainer |
hasManager
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resource | hasManager | 0..n | Contact Facet | |
Known Usage |
hasOwner
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resource | hasOwner | 0..n | Contact Facet | |
Known Usage | ||||
Dataset | hasOwner | 0..n | Contact Facet | Is he the owner |
hasCoverage
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resources | hasCoverage | 0..n | Coverage Facet | ... |
Known Usage | ||||
Dataset | hasCoverage | 1..n | Coverage Facet | ... |
hasSpatialCoverage
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resources | hasSpatialCoverage | 0..n | Coverage Facet | ... |
Known Usage | ||||
Dataset | hasSpatialCoverage | 0..n | Coverage Facet | ... |
hasTemporalCoverage
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resources | hasTemporalCoverage | 0..n | Coverage Facet | ... |
Known Usage | ||||
Dataset | hasTemporalCoverage | 0..n | Coverage Facet | ... |
hasMemory
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resources | hasMemory | 0..n | Memory Facet | ... |
hasPersistentMemory
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resources | hasPersistentMemory | 0..n | Memory Facet | ... |
Known Usage | ||||
Hosting Node | hasPersistentMemory | 1..n | Memory Facet | Disk Space |
hasVolatileMemory
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Definition | ||||
Resources | hasVolatileMemory | 0..n | Memory Facet | ... |
Known Usage | ||||
Hosting Node | hasVolatileMemory | 1..n | Memory Facet | RAM |
Resources
Every Resource has:
A class can be identified as Abstract
. This means that cannot be instantiated. uses specialization instead.
It is not required that an Abstract class establish an isIdentifiedBy relation with a Facet.
Resource
This entity is conceived to describe every "main thing" to be registered and discovered by the Information System. | ||||
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Resource | isIdentifiedBy | 1..n | Facet | Any Resource has at least one Facet which in some way allow to identify the Resource per se. |
Resource | consistsOf | 0..n | Facet | Any Resource consist of zero or more Facets which describes the different aspects of the facet. |
Resources | ||||
Resource | isRelatedTo | 0..n | Resource | Any Resource can be related to any other resource. |
The following Resources have been identified:
Actor
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Actor | isIdentifiedBy | 1..n | Contact Facet | An Actor has at least a Contact Facet which permit to identify the Actor per se. |
Actor | hasContact | 0..n | Contact Facet | An Actor can have other Contact Facets which provide secondary contact information. |
Actor | consistsOf | 0..n | Contact Reference Facet | |
Resources | ||||
Dataset | involves | 0..n | Actor | |
Site | isOwnedBy | 0..n | Actor |
Legal Body
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Legal Body | isIdentifiedBy | 1..n | Contact Facet | A Legal Body has at least a Contact Facet which permit to identify the Legal Body per se. |
Legal Body | consistsOf | 0..n | Contact Reference Facet | |
Resources | ||||
Person | belongsTo | 0..n | Legal Body | ... |
Person
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Person | isIdentifiedBy | 1..n | Contact Facet | A Person has at least a Contact Facet which permit to identify the Person per se. |
Person | consistsOf | 0..n | Contact Reference Facet | |
Resources | ||||
Person | belongsTo | 0..n | Legal Body | ... |
Configuration Template
It represents a template for a configuration. It describe how a configuration has to be realized. E.g. Used to define the accounting configuration parameters template.
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Configuration Template | isIdentifiedBy | 1..n | Identifier Facet | ... |
Configuration Template | consistsOf | 1..n | Simple Property Facet | ... |
Resources | ||||
Configuration | isDerivationOf | 1..1 | Configuration Template | ... |
Software | isConfiguredBy | 0..n | Configuration Template | ... |
Configuration
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Configuration | isIdentifiedBy | 1..n | Identifier Facet | ... |
Resources | ||||
Configuration | isDerivationOf | 1..1 | Configuration Template | ... |
Service | isCustomizedBy | 0..n | Configuration | ... |
Dataset
Concrete Dataset
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Concrete Dataset | isIdentifiedBy | 1..n | Identifier Facet | |
Concrete Dataset | hasMaintainer | 1..n | Contact Facet | Is he the maintainer |
Concrete Dataset | consistsOf | 1..n | Access Point Facet | The embargoState can be modeled through the access policy defined in the consistsOf relation |
Resources | ||||
Concrete Dataset | isPartOf | 0..n | Dataset | ... |
Schema
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Schema | isIdentifiedBy | 1..n | Schema Facet | |
Schema | isIdentifiedBy | 0..n | JSON Schema Facet | |
Schema | isIdentifiedBy | 0..n | XSD Schema Facet | |
Schema | hasContact | 1..n | Contact Facet | |
Schema | consistsOf | 0..n | Descriptive Metadata Facet | |
Schema | consistsOf | 0..n | Subject Facet | |
Resources | ||||
Dataset | isCompliantWith | 0..n | Schema |
Service
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Service | isIdentifiedBy | 1..n | Facet | |
Resources | ||||
Service | callsFor | 0..n | Service | ... |
Service | isCustomizedBy | 0..n | Configuration | ... |
Service | manages | 0..n | Dataset | ... |
Software | requires | 0..n | Service | ... |
E-Service
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
E-Service | isIdentifiedBy | 1..n | Software Facet | The software enabling the E-Service capabilities |
E-Service | consistsOf | 0..n | Software Facet | Software available in the E-Service environment that characterizes the specific E-Service instance |
E-Service | consistsOf | 1..n | Access Point Facet | Identify the endpoints of the E-Service |
E-Service | consistsOf | 1..n | Event Facet | E.g. ActivationTime, DeploymentTime |
E-Service | consistsOf | 1..1 | Service State Facet | I.e. STARTED, ready, down, failed |
E-Service | consistsOf | 0..n | License Facet | The specific terms of use for programmatic access to the service |
Resources | ||||
E-Service | discovers | 0..n | E-Service | A reference to any other E-Service, the E-Service instance is discovering through query on IS. |
E-Service | runs | 0..n | Software | ... |
E-Service | uses | 0..n | E-Service | A reference to any other E-Service, the E-Service instance is invoking. |
Hosting Node | hosts | 0..n | E-Service | ... |
Running Plugin | isActivatedBy | 1..1 | E-Service | A reference to the E-Service is running the plugin. |
Running Plugin
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Running Plugin | isIdentifiedBy | 1..1 | Software Facet | The software enabling the Running Plugin |
Resources | ||||
Running Plugin | isActivatedBy | 1..1 | E-Service | A reference to the E-Service is running the plugin. |
Running Plugin | runsPlugin | 0..n | Plugin | ... |
Hosting Node
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Hosting Node | isIdentifiedBy | 1..n | Networking Facet | ... |
Hosting Node | consistsOf | 1..n | CPU Facet | CPU Information |
Hosting Node | hasPersistentMemory | 1..n | Memory Facet | Disk Space |
Hosting Node | hasVolatileMemory | 1..n | Memory Facet | RAM |
Hosting Node | consistsOf | 1..n | Event Facet | ... |
Hosting Node | consistsOf | 1..1 | Container State Facet | I.e. started, ready, certified, down, failed |
Hosting Node | consistsOf | 0..n | Simple Property Facet | E.g. Environment Variables |
Hosting Node | consistsOf | 0..n | Software Facet | Useful to report the hosted software that are not registered in the Resource Registry as Software Resource, e.g. Operating System |
Resources | ||||
Hosting Node | hosts | 0..n | E-Service | A reference to any E-Service instance, the Hosting Node instance is hosting. |
Hosting Node | isManagedBy | 0..n | Site | ... |
Hosting Node | isPoweredBy | 0..n | Software | ... |
Virtual Service
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Virtual Service | isIdentifiedBy | 1..n | Software Facet | ... |
Resources | ||||
Virtual Service | demands | 0..n | Software Facet | ... |
Site
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Site | isIdentifiedBy | 1..n | Identifier Facet | ... |
Site | hasContact | 1..n | Contact Facet | ... |
Site | hasMaintainer | 1..n | Contact Facet | ... |
Site | hasManager | 1..n | Contact Facet | ... |
Site | consistsOf | 1..n | Location Facet | ... |
Site | consistsOf | 1..n | Networking Facet | |
Resources | ||||
Site | isOwnedBy | 0..n | Actor | |
Hosting Node | isManagedBy | 0..n | Site | ... |
Software
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Software | isIdentifiedBy | 1..n | Software Facet | Software coordinates which identify the Software per se. |
Software | consistsOf | 1..n | Software Facet | Apart the one connected with isIdentifiedBy relation (gCube coordinates) the others identify the sw in other way e.g. (Maven coordinates) |
Software | consistsOf | 1..n | Access Point Facet | Links to maven artifact on nexus, javadoc, wiki, svn ... |
Software | consistsOf | 1..n | License Facet | ... |
Software | consistsOf | 1..n | State Facet | E.g. Deprecated, Active, Obsolete |
Resources | ||||
Software | dependsOn | 0..n | Software | ... |
Software | isConfiguredBy | 0..n | Configuration Template | E.g. Accounting Sw uses it to discover the configuration |
Software | requires | 0..n | Service | E.g. A software requiring a specific database |
Virtual Service | demands | 0..n | Software | ... |
E-Service | runs | 0..n | Software | ... |
Hosting Node | isPoweredBy | 0..n | Software | ... |
Plugin | isPluginOf | 0..n | Software | ... |
Plugin
Source | Relation | Multiplicity | Target | Description |
---|---|---|---|---|
Facets | ||||
Plugin | isIdentifiedBy | 1..n | Software Facet | Software coordinates which identify the Plugin per se. |
Resources | ||||
Plugin | isPluginOf | 1..n | Software | A reference to the Software this Plugin extends capabilities. |
Running Plugin | runsPlugin | 0..n | Plugin | ... |
Best practices and guidelines
- On Facet instances "reuse" across Resource Profiles:
- This can be guaranteed automatically by the system, if and just in the case the system want to avoid duplication of information. It is based on a configuration policy;
- This MUST be done only when a change in a facet instance MUST affect a change in all Resources connected to such a Facet.
Suggested Extensions
The gCube Resource Model supports extensions at runtime meaning that new facets, relations, and resources can be defined and registered at any time by authorized clients. Those extensions must necessarily specialize an existing gCube Entity. An example of those specializations is the following:
Functionality Related Facet
The goal of this facet is to capture what are the facilities supported by the Service Entity and it aims to model the service interface.
Name | Type | Description | Attributes | |
---|---|---|---|---|
name | String | ... | ||
description | String | ... | ||
input | String | ... | ||
output | String | ... | ||
Known Usage | ||||
Source | Relation | Multiplicity | Target | Description |
Service | consistsOf | 0..n | Functionality Related Facet | ... |
Internal Entity and Relation
For internal use only are defined the following entity and relation:
Context
Model a Context (aka scope)
isParentOf
Source | Target | Description |
---|---|---|
Context | Context |