Difference between revisions of "Facet Based Resource Model"

Revision as of 13:42, 15 July 2016 (view source) Leonardo.candela (Talk | contribs) (→‎Facets) ← Older edit		Revision as of 13:44, 15 July 2016 (view source) Leonardo.candela (Talk | contribs) (→‎Relation) Newer edit →
Line 415:		Line 415:
	== Relation ==		== Relation ==
−
−	The are two basic types of relations:
−
−	* '''RelatedTo''': [[#Resource|Resource]] (source) -> [[#Resource|Resource]] (target)</div>.  Connect two different resources of the same type or of different types.
−
−	* '''ConsistOf''': [[#Resource|Resource]] (source) -> [[#Facets|Facet]] (target)</div>. Connect a Resource to a Facet which describe one of the aspect of the Resource.
−
−
−	Please note that:
−
−	* '''Any relation has a direction which provides the semantic of the relation. Anyway the relation can be also navigated in the opposite direction.'''
−
−	* '''There is no possibility to connect a Facet with another Facet.'''
−
−	* '''There is no reverse relation of ConsistOf. In other Word, a relation having a Facet as source and a Resource as target CANNOT exist'''
−
−	* '''A Facet can be connected from different Resource if and just in the case the system want to avoid duplication of information.''' :  This MUST be done only when a change in a facet MUST affect a change in all Resources connected to such a Facet.
−
	=== RelatedTo ===		=== RelatedTo ===

---

Revision as of 13:44, 15 July 2016

Contents 1 Basic Concepts 2 Facets 2.1 Facets Specification 2.1.1 Access Point Facet 2.1.2 Contact Facet 2.1.3 Coverage Facet 2.1.4 CPU Facet 2.1.5 Descriptive Metadata Facet 2.1.6 Event Facet 2.1.7 Functionality Related Facet 2.1.8 Identification Facet 2.1.9 NetworkAddress Facet 2.1.10 License Facet 2.1.11 Memory Facet 2.1.12 Peripheral Facet 2.1.13 Persistent Memory Facet 2.1.14 Provenance Facet 2.1.15 Simple Property Facet 2.1.16 Software Facet 2.1.17 State Facet 2.1.18 Subject Facet 2.1.19 Type Facet 2.1.20 Volatile Memory Facet 3 Relation 3.1 RelatedTo 3.2 ConsistOf 4 Resources 4.1 Resource 4.1.1 Actor 4.1.2 Configuration 4.1.3 Dataset 4.1.3.1 Concrete Dataset 4.1.4 Service 4.1.4.1 Abstract Service 4.1.4.2 E-Service 4.1.4.3 Hosting Node 4.1.5 Site 4.1.6 Software

Basic Concepts

• Two typologies of entities are envisaged:
  • Resources, i.e. entities representing a description of "thing" to be managed;
  • 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;
• Two typologies of relations are envisaged:
  • RelatedTo, i.e.
  • ConsistOf, i.e.
• 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.

Facets

Early ideas and thinking on facets were documented at 2nd Generation Resource Model : Facets

Facets Specification

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.

entryName	String	An unique identifier
endpoint	URI	The URI which identify the endpoint of a resource
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	....
properties	String	This can be an arbitrarily complex element whose "structure" is defined by the associated schema
propertiesSchema	URI	....

Contact Facet

The goal of this facet is expected to capture contact information.

name	String	TBD Contains Name and Surname maybe also middle name and title (Dr. Mr.) or we add a new fields
eMail	Valid eMail address	An RFC‑822 compliant email address. (At http://www.ex-parrot.com/~pdw/Mail-RFC822-Address.html you can find a very complex regular expression for validation)
website	URL	...
address	String	...
phone	String	...

Coverage Facet

The goal of this facet is to collect any extent-related information.

spatial	String	...
spatialSchema	URI	...
temporal	String	...
temporalSchema	URI	.....

CPU Facet

The goal of this facet is to describe CPU information.

TODO to be reviewed

model	String	...
vendor	String	...
clockSpeed	String	...

Descriptive Metadata Facet

The goal of this facet is to collect any descriptive metadata about the resource.

value	String	Inherited. E.g. XML Blob
schema	URI	...

Event Facet

The goal of this facet is to collect any descriptive metadata about the resource.

type	String	...
typeSchema	URI	...
date	String	...
dateSchema	URI	...

Functionality Related Facet

The goal of this facet is to capture what are the facilities supported (Challenging because of the different audiences) Something very "poor" ... we can have a look at WPS spec

name	String	...
description	String	...
input	String	...
output	String	...

Identification Facet

The goal of this facet is to collect information on Identifiers that can be attached to a resource.

value	String	The identifier. E.g. http://fr.dbpedia.org/resource/Thunnus de305d54-75b4-431b-adb2-eb6b9e546014
type	Enumeration	The typology of identifier. E.g. URI, DOI, IRI, URL, URN, UUID;
isPersistent	boolean	To indicate if the Identifier is persistent or not.

NetworkAddress Facet

The goal of this facet is to capture IP information

HostName	String	...
DomainName	String	...
IPAddress	String	...
mask	String	...
broadcastAddress	String	...

Regular expression to validate different IPv4 addresses are available at:

http://www.regextester.com/22

https://www.safaribooksonline.com/library/view/regular-expressions-cookbook/9780596802837/ch07s16.html

Both IPv4 and IPv6: http://stackoverflow.com/questions/53497/regular-expression-that-matches-valid-ipv6-addresses

License Facet

The goal of this facet is to .....

value	String	...
schema	URI	...

Memory Facet

The goal of this facet is to .....

size	Long	...
used	Long	...
unit	String	...

Peripheral Facet

The goal of this facet is to .....

model	String	...
vendor	String	...

Persistent Memory Facet

Specialization of Memory Facet

TBD if instead of subclassing is better subclassing ConsistOf relation of reintroduce purpose in relation or header

Provenance Facet

The goal of this facet is to collect information related with resource lineage/provenance

relationship	Enum	wasGeneratedBy | ...
reference	String	resourceID (a reference to the "originator" Resource associated to the resource the facet is attached to by the relationship)
provenanceDocument	String	... E.g. the xml format
provenanceDocumentSchema	String	... E.g. a reference to the format

Simple Property Facet

The goal of this facet is the base class for all facets described by a value and the schema of the value

value	String	...
schema	URI	...

Software Facet

The goal of this facet is to capture SW related features"

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.
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.
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.
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.
role TO BE REMOVED	String	Identify the role of this facet. E.g. dependency.
optional	boolean	.... Used in maven and in gcube

State Facet

The goal of this facet is to ...

value	String	Inherited.
schema	URI	Inherited.

Subject Facet

The goal of this facet is to ...

value	String	Inherited.
schema	URI	Inherited.

Type Facet

The goal of this facet is to ...

value	String	Inherited.
schema	URI	Inherited.

Volatile Memory Facet

Specialization of Memory Facet

TBD if instead of subclassing is better subclassing ConsistOf relation of reintroduce purpose in relation or header

Relation

RelatedTo

The following relations (extending the RelatedTo) have been identified and defined:

• CallsFor: Service to Service

• CustomizedBy: Service to Configuration

• DemandsFor: Abstract Service to Software

• DependsOn: Software to Software

• Host: Hosting Node to E-Service

• Manage: Service to Dataset

• PoweredBy: Hosting Node to Software

• Require: Software to Service

• Run: E-Service to Software

• Use: E-Service to E-Service

ConsistOf

The following relations (extending the ConsistOf) have been identified and defined:

• Identify: Resource to Facet

Resources

......

Resource

Resource Profile

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	Identify	1..n	Facet	Any Resource has at least one Facet which in some way allow to identify the Resource per se.
Resource	ConsistOf	1..n	Facet	Any Resource consist of one or more facets which describes the different aspects of the facet.
Resources
Resource	RelatedTo	0..n	Resource	Any Resource can be related to any other resource. The Resource can be the source or the target of the relation. Please remind that the relation has a direction which provides the semantic of the relation. Anyway the relation can be also navigated in the opposite direction.

The following Resources have been identified:

• Actor
• Configuration
• Dataset
  • Concrete Dataset
• Service
  • Abstract Service
  • E-Service
  • Hosting Node
• Software

Actor

Actor Profile

Source	Relation	Multiplicity	Target	Description
Facets
Actor	ConsistOf	1..n	Contact	...
Resources
HostingNode	Host	1..n	eService	...

Configuration

Configuration Profile

Facets
Name	Multiplicity	Description
...	...	...
ConsistOf Relations
...	...	...
RelatedTo Relations
...	...	...

Dataset

Dataset Profile

Facets
Name	Multiplicity	Description
Identification	1..n	TBD
Contact Facet	1..n	Missing is role: Is he the curator, owner, creator, contributor? This is an attribute of the relation
Access Point Facet	...	Missing embargoState to the attached access policy
License Facet	...	Missing duration of the license applied e.g. 15 years
Event Facet	...	...
Provenance Facet	...	...
ConsistOf Relations
...	...	...
RelatedTo Relations
...	...	...

Concrete Dataset

Concrete Dataset Profile extends Dataset Profile

Facets
Name	Multiplicity	Description
...	...	...
ConsistOf Relations
...	...	...
RelatedTo Relations
...	...	...

Service

Service Profile

Facets
Name	Multiplicity	Description
Identification	1..n	TBD
Contact Facet	1..n	...
ConsistOf Relations
...	...	...
RelatedTo Relations
...	...	...

Abstract Service

Abstract Service Profile extends Service Profile

Facets
Name	Multiplicity	Description
...	...	...
ConsistOf Relations
...	...	...
RelatedTo Relations
DemandsFor (out)	0..n	A reference to the Software ....

E-Service

E-Service Profile extends Service Profile

Facets
Name	Multiplicity	Description
Software	1..1	Related with #Identify ConsistOf Relation
Access Point	1..n	Identify the endpoints.
Event	1..n	E.g. ActivationTime,DeploymenTime)
State	1..1	I.e. STARTED, ready, certified, down, failed.
Relations
Run (out)	0..n	A reference to the Software artifact the E-Service results from.
Use (out,in)	0..n	A reference to any other E-Service, the E-Service instance is invoking.
Host (in)	1	An inverse reference stemming from the Hosting Node that is operating the E-Service.

Hosting Node

Hosting Node Profile extends Service Profile

Facets
Name	Multiplicity	Description
CPU Facet	1..n	CPU Information
Persistent Memory Facet	1..n	Disk Space
Volatile Memory Facet	1..n	RAM
IP Info Facet	1..n	IP address
Event	1..n	...
State	1..1	I.e. start, activation, stop, failure.
Simple Property	1..n	E.g. Environment Variables
ConsistOf Relations
...	...	...
RelatedTo Relations
PoweredBy (out)	1..n	A reference to the Software ....

Site

Site Profile

Facets
Name	Multiplicity	Description
Contact Facet	1..n	...
Location Facet	1..n	...
ConsistOf Relations
...	...	...
RelatedTo Relations
...	...	...

Software

Software Profile

Facets
Name	Multiplicity	Description
Software	1..n	Apart the one connected with #Identify relation (gCube coordinates) the others identify the sw in other way e.g. (Maven coordinates)
Access Point	1..n	links to maven artifact on nexus, javadoc, wiki, svn ...
License	1..n	...
State	1..n	...
Relations
DependsOn (out)	0..n	A reference to the Software
Require (out)	0..n	A reference to the Service
Run (in)	0..n	An inverse reference stemming from the E-Service that is running this Software
DemandsFor (in)	0..n	An inverse reference stemming from the Abstract Service that is
PoweredBy (in)	0..n	An inverse reference stemming from the Hosting Node that is