This wiki is locked. Future workgroup activity and specification development must take place at our new wiki. For more information, see this blog post about the new governance model and this post about changes to the website.

OSLC AM Specification V1.0

NOTE: This version of the specification has been deprecated, and is replaced by the OSLC Core 2.0 compliant specification, here. This version of the specification was never finalized, instead the first released version of the AM specification is expected to be the OSLC AM 2.0 Specification, starting with the verison number that indicates compliance with the Core version.

Introduction

This family of documents defines the Open Services for Lifecycle Collaboration Architecture Management specification, also known as OSLC AM. These documents collectively define the OSLC-AM 1.0 specification, which is part of the OSLC group of specifications.

This specification supports key REST APIs for the management of architecture related resources used in a software development llifecycle. This first version of the specification focuses on core resource management functionality, and takes a loosely coupled approach towards integration with other OSLC specifications.

It does NOT specifiy or assume any pariticular development process or methodology. It also does NOT attempt to canonically define specific types of resources or relationships between resources. Instead it provides a least common approach for resource presentation and defines a mechanism for managing relationships.

This specification, along with the other OSLC specifications is heavily influenced by current web and open technologies. The services defined here are all RESTful HTTP services. The data model for resources is based on RDF.

Specification Working Group

Authors of the OSLC RM 1.0 Specification:

SteveAbrams (IBM)
JimAmsden (IBM)
ChrisArmstrong (Armstrong Process Group)
AndyBerner (IBM)
ScottBosworth (IBM)
JimConallen (IBM, OSLC AM Lead)
DerryDavis (Accenture)
BrendaEllis (Northrop Grumman Corporation)
IanGreen (IBM, OSLC RM Lead)
JonathanHarclerode (Accenture)
SimonHelsen (IBM)
ClydeIcuspit (IBM)
WallyMclaughlin (Armstrong Process Group)
ThomasPicolli (IBM)
VishyRamaswamy (IBM)
RenRenganathan (Citi Bank)

Notation and Conventions

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC2119. Domain name examples use RFC2606.

Intellectual Property Covenant

The members of the Working Group (or as appropriate, their employers) have documented a Patent Non-Assertion Covenant for implementations of the Architecture Management 1.0 Specification, as described in the open-services.net Terms of Use. Details of the Covenant may be found here.

Terminology

Resource - An artifact used in the ALM space. A resource is directly addressable with an absolute URL.

Architecture Management Resource (AMR) - Directly addressable resources of some domain/notation (i.e. UML, BMPN, ER) that represent an abstraction of some behavior or construct of a system under development. An AMR maintains its identity after refactoring. In the semantic web, an AMR might correspond to a graph that is an instance of some vocabulary or micro-theory.

Link - A logical relationship from one resource to another resource. An OSLC AM Link is uni-directional. The subject (source) of a link represents the resource that 'knows about' and is referencing another resource (target). The type of relationship is given by a predicate URI (link type). In semantic web terminology, a link would correspond to an RDF statement with a subject (source) a predicate (type) and object (target). The predicate could be defined by property in an RDF schema.

Link Type (LT) - A URI that represents the type of a link. In semantic web terminology it is the predicate of an RDF triple. It clarifies the type of relationship between two resources. Link Type URIs may be defined locally, within the OSLC, or externaly (i.e. Dublin Core terms). Link types could be defined in RDF Schemas.

Result Set - An ordered or unordered set of resources, typically generated as the result of performing a query or search. In this specification result sets are formatted with as ATOM feeds.

Service Provider - An implementation of the OSLC Architecture Management specifications as a server. OSLC AM clients consume these service.

Service Description Resource - an informational resource describing the capabilities and contextual configuration needed for a set of Architecture Management-specific services.

Service Description Document - the representation of a Architecture Management Services Resource.

Namespaces Used

The below table lists the namespace prefixes and associated namespaces used for samples and specification text. Service Providers MUST support these reserved namespace prefixes.

PrefixSorted ascending Namespace Defined
atom http://www.w3.org/2005/Atom RFC4287 - Atom Syndication Format
dcterms http://purl.org/dc/terms/ Dublin Core Terms
oslc http://open-services.net/ns/core# Common Core OSLC namespace
oslc_am http://open-services.net/xmlns/am/1.0/ Namespace for elements defined in this specification
rdf http://www.w3.org/1999/02/22-rdf-syntax-ns# RDF/XML

Specification Documents

Document Version Status
RESTful Services 1.0 convergence
Resource Definition 1.0 convergence
Simple Query Syntax 1.0 convergence
Service Description Document 1.0 convergence
Delegated Resource Selection and Creation 2.0 draft
OSLC Service Provider Catalog 2.0 draft
Topic revision: r10 - 29 Jul 2010 - 12:41:57 - JimConallen
 
This site is powered by the TWiki collaboration platform Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use
Ideas, requests, problems regarding this site? Send feedback