OSLC Architecture Management Version 2.1. Part 2: Vocabulary

This document was last revised or approved by the OASIS OSLC Lifecycle Integration Domains TC on the above date. The level of approval is also listed above. Check the “Latest version” location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=oslc-domains#technical.

TC members should send comments on this specification to the TC’s email list. Others should send comments to the TC’s public comment list oslc-domains@lists.oasis-open.org, after subscribing to it by following the instructions at the “Send A Comment” button on the TC’s web page at https://www.oasis-open.org/committees/oslc-domains/.

This specification is provided under the RF on Limited Terms Mode of the OASIS IPR Policy, the mode chosen when the Technical Committee was established. For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the TC’s web page (https://www.oasis-open.org/committees/oslc-domains/ipr.php).

Note that any machine-readable content (Computer Language Definitions) declared Normative for this Work Product is provided in separate plain text files. In the event of a discrepancy between any such plain text file and display content in the Work Product's prose narrative document(s), the content in the separate plain text file prevails.

Citation format:

When referencing this specification the following citation format should be used:

[OSLC-am-2.1-Part2]
OSLC Architecture Management Version 2.1. Part 2: Vocabulary. Edited by Jim Amsden. 09 October 2018. OASIS Committee Specification 01. http://docs.oasis-open.org/oslc-domains/oslc-am/v2.1/cs01/part2-architecture-management-vocab/oslc-am-v2.1-cs01-part2-architecture-management-vocab.html. Latest version: http://docs.oasis-open.org/oslc-domains/oslc-am/v2.1/oslc-am-v2.1-part2-architecture-management-vocab.html.

Notices

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.

OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.

The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above guidance.

1. Introduction

This section is non-normative.

This specification defines a vocabulary and resource shapes for OSLC Architecture Management resources. The intent is to define resources needed to support common integration scenarios and not to provide a comprehensive definition of an architecture resource. The resource formats are intended to define a high-level resource that can be specialized by enterprise architecture, analysis or design artifacts. The approach to supporting these scenarios is to delegate operations, as driven by service provider contributed user interfaces, as much as possible and not require a service provider to expose its complete data model and application logic.

1.1 Terminology

This section is non-normative.

Terminology is based on OSLC Core Overview [OSLCCore3], W3C Linked Data Platform [LDP], W3C's Architecture of the World Wide Web [WEBARCH], Hyper-text Transfer Protocol [HTTP11]. Terminology for this specification is defined in part 1 of the multi-part specification.

1.2 References

1.2.1 Normative references

[HTTP11]: R. Fielding, Ed.; J. Reschke, Ed.. Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing. June 2014. Proposed Standard. URL: https://tools.ietf.org/html/rfc7230
[LDP]: Steve Speicher; John Arwe; Ashok Malhotra. Linked Data Platform 1.0. 26 February 2015. W3C Recommendation. URL: https://www.w3.org/TR/ldp/
[OSLCCore3]: Steve Speicher; Jim Amsden. OSLC Core Overview v3.0. Committee Specification. URL: http://docs.oasis-open.org/oslc-core/oslc-core/v3.0/oslc-core-v3.0-part1-overview.html
[RFC2119]: S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119

1.2.2 Informative references

[OSLCQM]: Paul McMahan. Open Services for Lifecycle Collaboration Quality Management Specification Version 2.0. Final. URL: http://open-services.net/bin/view/Main/QmSpecificationV2
[OSLCRM]: Ian Green. Open Services for Lifecycle Collaboration Requirements Management Specification Version 2.0. Final. URL: http://open-services.net/bin/view/Main/RmSpecificationV2
[WEBARCH]: Ian Jacobs; Norman Walsh. Architecture of the World Wide Web, Volume One. 15 December 2004. W3C Recommendation. URL: https://www.w3.org/TR/webarch/

1.3 Typographical Conventions and Use of RFC Terms

As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The key words MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this specification are to be interpreted as described in [RFC2119].

In addition to the namespace URIs and namespace prefixes oslc, rdf, dcterms and foaf defined in the OSLC Core specification, OSLC AM defines the namespace URI of http://open-services.net/ns/am# with a namespace prefix of oslc_am

This specification also uses these namespace prefix definitions:

oslc_rm : http://open-services.net/ns/rm# [OSLCRM]
oslc_qm : http://open-services.net/ns/qm# [OSLCQM]

2. Architecture Management Vocabulary Terms

Property value types that are not defined in the following sections, are defined in [OSLCCore3].

There are two OSLC AM defined resources: Resource and LinkType. OSLC AM defines a least common set of properties for resources, however service implementations are free to extend this set of properties. Clients MUST preserve properties it does not recognize when updating resources. AM Servers MAY ignore properties that it does not recognize. Additional properties may come from existing vocabularies (ie. Dublin Core, OWL). When additional properties do not come from a known vocabulary, it is recommended that they exist in their own unique namespace, and providers SHOULD NOT reuse namespaces defined in these specifications.

All RDF/XML resources that include links with annotations MUST begin with an outer <rdf:RDF> element. This outer XML element is required to support the ability to include annotations on ‘link’ properties with additional <rdf:Description> elements reifying statements about the link.

Service implementations and clients MUST be prepared to accept any form of valid RDF/XML. For example the following two resource forms are equivalent.

Example 1

xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
   xmlns:oslc="http://open-services.net/ns/core#"
   xmlns:oslc_am="http://open-services.net/ns/am#"
   xmlns:dcterms="http://purl.org/dc/terms/">

    <oslc_am:Resource rdf:about="https://acme.com/resources/res1">
      <dcterms:title>Service Interface</dcterms:title>
      <dcterms:identifier>res1</dcterms:identifier>
      <oslc:serviceProvider rdf:resource="http://open-services.net/ns/am#"/>
    </oslc_am:Resource>

</rdf:RDF></verbatim> is equivalent to <verbatim><rdf:RDF 
   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
   xmlns:oslc="http://open-services.net/ns/core#"
   xmlns:dcterms="http://purl.org/dc/terms/">

    <rdf:Description rdf:about="https://acme.com/resources/res1">
      <dcterms:title>Service Interface</dcterms:title>
      <dcterms:identifier>res1</dcterms:identifier>
      <rdf:type rdf:resource="http://open-services.net/ns/am#Resource" />
      <oslc:serviceProvider rdf:resource="http://open-services.net/ns/am#"/>
    </rdf:Description>

</rdf:RDF>

This specification defines a number of specific, commonly occurring vocabulary terms (OWL classes), properties and values. Servers may define additional classes and provide additional properties as needed.

2.1 Vocabulary Details

The namespace URI for this vocabulary is: http://open-services.net/ns/am#

All vocabulary URIs defined in the OSLC Architecture Management (AM) namespace.

See Also:

http://docs.oasis-open.org/oslc-domains/

2.1.1 RDFS Classes in this namespace

Architecture Resource, Link Type

2.1.2 Architecture Resource

http://open-services.net/ns/am#Resource

Architecture Resource is an RDFS class.

A generic architecture resource. A resource of this type is likely to be a model or design artifact.

2.1.3 Link Type

http://open-services.net/ns/am#LinkType

Link Type is an RDFS class.

A locally managed resource that describes a link type predicate that might otherwise not be directly resolvable.

3. Resource Constraints

This section specifies the constraints for the Architecture Management resources. The resource properties are not limited to the ones defined in this specification, AM Servers may provide additional properties. It is recommended that any additional properties exist in their own unique namespace and not use the namespaces defined in these specifications.

3.1 Resource: Resource

An Architecture Management Resource (AMR) is a generic resource format that can be used to represent any type of specific architecture resource such as a UML Class, Use Case, or Business Process Diagram.

Name: Resource
Type URI: http://open-services.net/ns/am#Resource
Summary: Resource
Description: A generic resource format that can be used to represent any type of specific architecture resource like a UML Class, Use Case, or Business Process Diagram.

Resource Properties

Prefixed Name	Occurs	Read-only	Value-type	Representation	Range	Description
`dcterms:contributor`	Zero-or-many	unspecified	AnyResource	Either	`oslc:AnyResource`	Contributor or contributors to the resource. It is likely that the target resource will be a foaf:Person but that is not necessarily the case.
`dcterms:created`	Zero-or-one	unspecified	dateTime	N/A	Unspecified	Timestamp of resource creation
`dcterms:creator`	Zero-or-many	unspecified	AnyResource	Either	`oslc:AnyResource`	Creator or creators of the resource. It is likely that the target resource will be a foaf:Person but that is not necessarily the case.
`dcterms:description`	Zero-or-one	unspecified	XMLLiteral	N/A	Unspecified	Descriptive text about resource represented as rich text in XHTML content.
`dcterms:identifier`	Exactly-one	unspecified	string	N/A	Unspecified	A unique identifier for a resource. Typically read-only and assigned by the service provider when a resource is created. Not typically intended for end-user display.
`dcterms:modified`	Zero-or-one	unspecified	dateTime	N/A	Unspecified	Timestamp of latest resource modification.
`dcterms:source`	Zero-or-one	unspecified	Resource	Reference	`oslc:AnyResource`	The resource URI a client can perform a get on to obtain the original non-OSLC AM formatted resource that was used to create this resource. The source resource is usually a binary or proprietary format that the service provider can consume and convert into an OSLC AM format. The service may use content negotiation with the Accept header to obtain the desired content type.
`dcterms:title`	Exactly-one	unspecified	XMLLiteral	N/A	Unspecified	Title of the resource represented as rich text in XHTML content.
`dcterms:type`	Zero-or-many	unspecified	string	N/A	Unspecified	A short string representation for the type, for example ‘Car’.
`oslc:instanceShape`	Zero-or-one	unspecified	Resource	Reference	`oslc:ResourceShape`	The URI of a Resource Shape that describes the possible properties, occurrence, value types, allowed values and labels. This shape information is useful in displaying the subject resource as well as guiding clients in performing modifications. Instance shapes may be specific to the authenticated user associated with the request that retrieved the resource, the current state of the resource and other factors and thus should not be cached.
`oslc:serviceProvider`	Zero-or-many	unspecified	Resource	Reference	`oslc:ServiceProvider`	A link to the resource's OSLC Service Provider. There may be cases when the subject resource is available from a service provider that implements multiple domain specifications, which could result in multiple values for this property.
`oslc:shortTitle`	Zero-or-one	unspecified	XMLLiteral	N/A	Unspecified	Short name identifying a resource, often used as an abbreviated identifier for presentation to end-users. SHOULD include only content that is valid inside an XHTML <span> element.
`rdf:type`	Zero-or-many	unspecified	Resource	Reference	`rdfs:Class`	The resource type URIs.

3.2 Resource: LinkType

A Link Type Resource (LTR) represents type of link that is or can be used when defining links from AM resources. The type has an ID (expressed as a string), whose universally accepted semantics may be defined elsewhere. This resource represents the definition as it is used by this service provider. This resource is meant as a convenience for clients to get a list of known/registered link types with human readable labels and definitions that can be used in client user interfaces when links are being created.

The resource defines the properties rdfs:label and rdfs:comments for the link type URI. The link type URI is made type: http://open-services.net/ns/am#LinkType via an rdf:type property. The remaining properties may be properties of the link type URI, or on a separate resource managed by the service provider. In the case where the service provider owns the domain of the link type URI these can be the same, and all properties can be on the same link type URI.

Links from AMR resources are managed in accordance with the OSLC Core Guidance on Links and Relationships. They appear as simple properties in the resource. Links MAY include inlined values for the target and MAY include anchor properties on the link itself. AM Servers SHOULD support LinkType Resources for clients to get a list of known and acceptable link properties.

Name: LinkType
Type URI: http://open-services.net/ns/am#LinkType
Summary: LinkType
Description: Represents type of link that is or can be used when defining links from AM resources.

LinkType Properties

Prefixed Name	Occurs	Read-only	Value-type	Representation	Range	Description
`dcterms:contributor`	Zero-or-many	unspecified	AnyResource	Either	`oslc:AnyResource`	Contributor or contributors to the resource. It is likely that the target resource will be a foaf:Person but that is not necessarily the case.
`dcterms:created`	Zero-or-one	unspecified	dateTime	N/A	Unspecified	Timestamp of resource creation
`dcterms:creator`	Zero-or-many	unspecified	AnyResource	Either	`oslc:AnyResource`	Creator or creators of the resource. It is likely that the target resource will be a foaf:Person but that is not necessarily the case.
`dcterms:identifier`	Exactly-one	unspecified	string	N/A	Unspecified	A unique identifier for a resource. Typically read-only and assigned by the service provider when a resource is created. Not typically intended for end-user display.
`dcterms:modified`	Zero-or-one	unspecified	dateTime	N/A	Unspecified	Timestamp of latest resource modification.
`oslc:instanceShape`	Zero-or-one	unspecified	Resource	Reference	`oslc:ResourceShape`	The URI of a Resource Shape that describes the possible properties, occurrence, value types, allowed values and labels. This shape information is useful in displaying the subject resource as well as guiding clients in performing modifications. Instance shapes may be specific to the authenticated user associated with the request that retrieved the resource, the current state of the resource and other factors and thus should not be cached.
`oslc:serviceProvider`	Zero-or-many	unspecified	Resource	Reference	`oslc:ServiceProvider`	A link to the resource's OSLC Service Provider. There may be cases when the subject resource is available from a service provider that implements multiple domain specifications, which could result in multiple values for this property.
`rdfs:comment`	Zero-or-one	unspecified	string	N/A	Unspecified	TDescriptive text about link type. Provides a description of this link type that could be used in hover help or other areas of the UI where the user wants to understand more about what a link of this type means.
`rdfs:label`	Exactly-one	unspecified	string	N/A	Unspecified	The human readable name for this link type. This value is expected to be used in drop down lists and in tables where a link of this type is involved.

Revision	Date	Editor	Changes Made
01	08/24/2018	Jim Amsden	Committee Specification Draft for Public Review published
01	09/10/2018	Jim Amsden	Committee Specification revision 01 published