 |
Open Services for Lifecycle Collaboration Asset Management Specification Version 2.0
|
2.0 FINALIZATION DRAFT. This current draft is intended for review during finalization. You can help by reviewing it carefully and raising issues for discussion on the
OSLC Asset Management mailing list. For issues regarding this specification and their resolution, see
AssetMgSpecificationV2Issues. The specification will be final once the first Asset Management provider implementation is completed. This is currently in progress and scheduled for completion in March 2011.
Status: 2.0 Specification - September 28th, 2011
This Version
Latest Version
PreviousVersion
Authors
Contributors
Table of Contents
License
This work is licensed under a
Creative Commons Attribution License.
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.
Introduction
Asset Management Systems allow enterprises to catalog, govern, manage and maintain reusable software packages as a definitive software library. Using the constructs defined in the
OMG Reusable Asset Specification we consider a reusable asset to be a collection of zero or more artifacts. Artifacts are work products from the software development lifecycle, such as requirements documents, models, source code files, deployment descriptors, test cases or scripts, and so on.
This specification builds on the Open Services for Lifecycle Collaboration (OSLC) Core v2.0 Specification to define the resources, properties and operations supported by an OSLC Asset Management (OSLC-Asset) provider. Asset Management resources include Assets, Artifacts and supporting resources defined in the OSLC Core specification. The properties defined describe these resources and the relationships between resources. Operations are defined in terms of HTTP methods and MIME type handling. The resources, properties and operations defined do not form a comprehensive interface to Asset Management, but instead target specific integration use cases documented by the OSLC-Asset workgroup.
This specification also defines how Assets and Artifacts are represented in OSLC Services. The
Asset Resource is a set of properties for an Asset, and includes properties that describe an Asset's Artifacts.
This version of the OSLC Asset specification is demonstrated in the
version 2.0 scenarios
Terminology
Asset Consumer - An ALM tool or user that performs asset searching and retrieval activities outlined in the search and retrieve scenarios.
Asset Resource - An Asset Resource has a set of properties representing a reusable software asset. These properties include such things as name, description, classification, and the properties for an Asset's Artifacts.
Asset Query Resource - When filtering using simple query, the representation of a list of Asset Resources.
Asset Submitter - An ALM tool or user that performs asset preparation activities outlined in the publish scenario.
Artifact - This term is often used interchangeably with 'work product' or 'file'. It refers to an Artifact Media Resource and its properties. An asset may have zero or more artifacts.
Artifact Media Resource - The Artifact Media Resource represents the actual artifact content. The content can be a presentation, a test case, a binary software component, or any other kind of content typically used in software development and delivery activities.
Property - An attribute of a resource. Typically a property is a name/value pair that describes a certain aspect of the resource. For example, an asset has many properties such as the asset title, subject/short description, version.
Service Provider - An implementation of the OSLC Asset Management specification as a server. OSLC Asset Management clients consume these services.
Work product - This term is often used interchangeably with 'artifact' or 'file'. An asset may have zero or more work products.
Base Requirements
Compliance
This specification is based on
OSLC Core Specification. OSLC Asset Management 2.0 consumers and service providers
MUST be compliant with both the core specification and this Asset Management specification, and SHOULD follow all the guidelines and recommendations in both these specifications.
The following table summarizes the requirements from OSLC Core Specification as well as some additional specific to Asset Management. Note that this specification further restricts some of the requirements for OSLC Core Specification. See further sections in this specification or the OSLC Core Specification to get further details on each of these requirements.
| Requirement |
Level |
Meaning |
| Unknown properties and content |
MAY / MUST |
OSLC services MAY ignore unknown content and OSLC clients MUST preserve unknown content |
| Resource Operations |
MUST |
OSLC service MUST support resource operations via standard HTTP operations |
| Resource Paging |
MAY |
OSLC services MAY provide paging for resources but only when specifically requested by client |
| Partial Resource Representations |
MAY / MUST |
OSLC services MUST support request for a subset of a resource's properties via the oslc.properties URL parameter retrieval via HTTP GET and MAY support via HTTP PUT |
| Partial Update |
MAY |
OSLC services MAY support partial update of resources using patch semantics |
| Service Provider Resources |
MAY / MUST |
OSLC service providers MAY provide a Service Provider Catalog and MUST provide a Service Provider resource |
| Creation Factories |
MUST |
OSLC service providers MUST provide creation factories to enable resource creation via HTTP POST |
| Query Capabilities |
MUST |
OSLC service providers MUST provide query capabilities to enable clients to query for resources |
| Query Syntax |
MUST |
OSLC query capabilities MUST support the OSLC Core Query Syntax and MAY use other query syntax |
| Delegated UI Dialogs |
MUST |
OSLC Services MUST offer delegated UI dialogs (creation and selections) specified via service provider resource |
| UI Preview |
SHOULD |
OSLC Services SHOULD offer UI previews for resources that may be referenced by other resources |
| HTTP Basic Authentication |
MAY |
OSLC Services MAY support Basic Auth and should do so only over HTTPS |
| OAuth Authentication |
SHOULD |
OSLC Services SHOULD support OAuth and can indicate the required OAuth URLs via the service provider resource |
| Error Responses |
MAY |
OSLC Services MAY provide error responses using Core defined error formats |
| RDF/XML Representations |
MUST |
OSLC services MUST provide an RDF/XML representation for HTTP GET requests and MUST support RDF/XML representations on POST and PUT requests. |
| XML Representations |
MAY |
OSLC services MAY provide a XML representation for HTTP GET, POST and PUT requests that conform to the Core Guidelines for XML. |
| JSON Representations |
SHOULD |
OSLC services SHOULD provide JSON representations for HTTP GET, POST and PUT requests that conform to the Core Guidelines for JSON |
| HTML Representations |
SHOULD |
OSLC services SHOULD provide HTML representations for HTTP GET requests |
Specification Versioning
See
OSLC Core Specification Versioning section.
Service providers that support the resource formats and services in this specification
MUST use HTTP response header of
OSLC-Core-Version with a value of
2.0 and
OSLC-Asset-Version with a value of
2.0. Consumers
MAY request formats and services defined in this document by providing a HTTP request header of
OSLC-Core-Version with a value of
2.0. See section below on Version Compatibility with OSLC CM 1.0 Specifications.
Namespaces
In addition to the namespace URIs and namespace prefixes
oslc,
rdf,
dcterms and
foaf defined in the
OSLC Core specification, OSLC Asset Management defines the namespace URI of
http://open-services.net/ns/asset# with a namespace prefix of
oslc_asset
This specification also uses these namespace prefix definitions: This specification also uses these namespace prefix definitions:
- oslc_cm :
http://open-services.net/ns/cm# (Reference: OSLC CM)
- oslc_rm :
http://open-services.net/ns/rm# (Reference: OSLC RM)
- oslc_qm :
http://open-services.net/ns/qm# (Reference: OSLC QM)
- oslc_automation :
http://open-services.net/ns/automation# (Reference: OSLC AUTOMATION)
Resource Formats
In addition to the requirements for
OSLC Core Resource Formats section, this section outlines further refinements and restrictions.
For HTTP GET requests on all OSLC Asset Management and OSLC Core defined resource types,
- Asset Management Providers MUST provide RDF/XML representations, SHOULD provide JSON representations, and MAY provide XML representations. The XML and JSON representations SHOULD follow the guidelines outlined in the OSLC Core Representations Guidance.
- Asset Management Consumers requesting RDF/XML SHOULD be prepared for any valid RDF/XML document. Asset Management Consumers requesting XML or JSON SHOULD be prepared for representations that follow the guidelines outlined in the OSLC Core Representations Guidance.
- Asset Management Providers SHOULD support an [X]HTML representation and a user interface (UI) preview as defined by UI Preview Guidance
For HTTP PUT/POST request formats for resource type of Asset:
- Asset Management Providers MUST accept RDF/XML representations, SHOULD accept JSON representations, and MAY accept XML representations. Asset Management Providers accepting RDF/XML SHOULD be prepared for any valid RDF/XML document. For XML or JSON, Asset Management Providers SHOULD be prepared for representations that follow the guidelines outlined in the OSLC Core Representations Guidance.
For HTTP GET response formats for Query requests,
Asset Management Providers
MUST provide RDF/XML representations,
SHOULD provide JSON and Atom Syndication Format XML representations, and
MAY provide XML representations.
When Asset Management Consumers request:
-
application/rdf+xml Asset Management Providers MUST respond with RDF/XML representation without restrictions.
-
application/json Asset Management Providers SHOULD respond with JSON representation as defined in the OSLC Core Representations Guidance.
-
application/xml Asset Management Provider MAY respond with OSLC-defined abbreviated XML representation as defined in the OSLC Core Representations Guidance
-
application/atom+xml Asset Management Provider SHOULD respond with Atom Syndication Format XML representation as defined in the OSLC Core Representations Guidance
- The Atom Syndication Format XML representation SHOULD use RDF/XML representation without restrictions for the atom:content entries representing the resource representations.
See Query Capabilities for additional information when Resource Shapes affect representation.
Content Negotiation
OSLC Core Guidance clearly points to RDF representations (and specifically RDF/XML) as a convention that all OSLC Provider implementations minimally provide and accept. OSLC Asset Provider implementations are strongly encouraged to adopt this convention. Future versions of this specification are expected to require RDF representations for all operations and relax requirements for specialized XML representations.
XML Representation - identified by the
application/xml content type. Format representation rules are outlined in Core
OSLC Core Resource Formats section
RDF/XML Representation - identified by the
application/rdf+xml content type. No additional guidance is given. The OSLC Core describes an algorithm for generating consistent formats that are used as examples only.
JSON Representation - identified by the
application/json content type. Format representation rules are outlined in Core
OSLC Core Resource Formats section.
Atom Syndication Format XML Representation - identified by the
application/atom+xml content type. Format representation rules are outlined in Core
OSLC Core Resource Formats section.
Authentication
See
OSLC Core Authentication section. Asset Management puts no additional constraints on authentication.
Error Responses
See
OSLC Core Error Responses section. Asset Management puts no additional constraints on error responses.
Pagination
OSLC Asset service providers
SHOULD support pagination of query results and
MAY support pagination of a single resource's properties as defined by the OSLC Core Specification.
Requesting and Updating Properties
Requesting a Subset of Properties
A client
MAY request a subset of a resource's properties as well as properties from a referenced resource. In order to support this behavior a service provider
MUST support the
oslc.properties and
oslc.prefix URL parameter on a HTTP GET request on individual resource request or a collection of resources by query. If the
oslc.properties parameter is omitted on the request, then all resource properties
MUST be provided in the response.
Updating a Subset of Properties
A client
MAY request that a subset of a resource's properties be updated by identifying those properties to be modified using the
oslc.properties URL parameter on a HTTP PUT request.
If the parameter
oslc.properties contains a valid resource property on the request that is not provided in the content, the server
MUST set the resource's property to a null or empty value. If the parameter
oslc.properties contains an invalid resource property, then a
409 Conflict MUST be returned.
Labels for Relationships
Asset relationships to other resources are represented as properties whose values are the URI of the object or target resource. When an Asset relationship property is to be presented in a user interface, it may be helpful to provide an informative and useful textual label for that relationship instance. (This in addition to the relationship property URI and the object resource URI, which are also candidates for presentation to a user.) To this end, OSLC providers
MAY support a
dcterms:title link property in Asset resource representations, using the anchor approach outlined in the OSLC Core Links Guidance. In addition to the textual label, the Asset resource definition defines several properties that can be used to describe the relationship from one Asset resource to another Asset resource.
RDF/XML and XML example using reified statement:
<rdf:RDF
xmlns:dcterms="http://purl.org/dc/terms/"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:oslc_asset="http://open-services.net/ns/asset#">
<oslc_asset:Asset rdf:about="http://example.com/assets/CDFE4153-9271-5CA6-425A-4CA6BE7BD7CA/1.0">
<oslc_asset:relatedAsset rdf:ID="relationship1" rdf:resource="http://example.com/assets/52C4702C-7CA2-E46E-D373-620482ECBEED/1.0"/>
</oslc_asset:Asset>
<rdf:Description rdf:about="#relationship1">
<dcterms:title>Build Configuration</dcterms:title>
</rdf:Description>
</rdf:RDF>
Custom Properties
Asset management providers
SHOULD allow consumers to define custom properties. If providers allow consumers to define custom properties, they
MUST allow the consumer to optionally specify an HTTP URI for that data element, and the specified URI
MUST be used in the RDF representation of all resources that contain the data element. The specified URI
MAY be part of an industry standard such as DC, FOAF, or OSLC, or it
MAY be defined by the user's organization. If the URI is defined by the user's organization, then they SHOULD make it dereferencable as per the
W3C Best Practices for Publishing RDF Vocabularies.
If the user does not specify the optional URI, then the provider
MUST use a default generated HTTP URI. The generated URI
SHOULD be as human-readable as possible. One method for achieving human-readability is to apply a human-friendly name mangling algorithm to the user-defined label for the data element. The tool
SHOULD make the generated URI dereferencable as per the
W3C Best Practices for Publishing RDF Vocabularies. The published RDF vocabulary
SHOULD include any relevant descriptive information provided the user as part of the data element definition, e.g. the label and description.
OSLC Asset Management Resource Definitions
Asset
A reusable software Asset is a collection of zero or more Artifacts from the software development lifecycle, such as requirements documents, models, source code files, deployment descriptors, test cases, scripts, and so on. An Asset resource is a set of properties representing a reusable software asset. These properties include such things as name, description, classification, and the properties of an Asset's Artifacts.
The Asset resource properties are not limited to the ones defined in this specification, service providers 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.
- Name:
Asset
- Type URI
http://open-services.net/ns/asset#Asset
| Prefixed Name |
Occurs |
Read-only |
Value-type |
Representation |
Range |
Description |
| OSLC Core: Common Properties |
| dcterms:title |
exactly-one |
unspecified |
XMLLiteral |
n/a |
n/a |
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 element. |
| dcterms:description |
zero-or-one |
unspecified |
XMLLiteral |
n/a |
n/a |
Descriptive text (reference: Dublin Core) about resource represented as rich text in XHTML content. SHOULD include only content that is valid and suitable inside an XHTML element. |
| dcterms:abstract |
zero-or-one |
unspecified |
XMLLiteral |
n/a |
n/a |
Short description (reference: Dublin Core) or often a single line summary of the resource |
| dcterms:creator |
zero-or-many |
unspecified |
Either Resource or Local Resource |
Either Reference or Inline |
any |
Creator or creators of resource (reference: Dublin Core). It is likely that the target resource will be a foaf:Person but that is not necessarily the case |
| dcterms:contributor |
zero-or-many |
unspecified |
Either Resource or Local Resource |
Either Reference or Inline |
any |
The person(s) who are responsible for this asset. (reference: Dublin Core). It is likely that the target resource will be a foaf:Person but that is not necessarily the case. |
| dcterms:created |
zero-or-one |
True |
DateTime |
n/a |
n/a |
Timestamp of resource creation (reference: Dublin Core). |
| dcterms:modified |
zero-or-one |
True |
DateTime |
n/a |
n/a |
Timestamp last latest resource modification (reference: Dublin Core). |
| rdf:type |
zero-or-many |
unspecified |
Resource |
Reference |
n/a |
The resource type URIs. One reference should have the value of http://open-services.net/ns/asset#Asset. A second reference may be used to indicate the type of the asset based on values defined by the service provider. This specification does not define the resource for this property, however it should contain a dcterms:title property. |
| oslc:serviceProvider |
zero-or-many |
unspecified |
Resource |
Reference |
oslc:ServiceProvider |
The scope of a resource is a URI for the resource's OSLC Service Provider. |
| oslc:instanceShape |
zero-or-one |
unspecified |
Resource |
Reference |
oslc:ResourceShape |
Resource Shape that provides hints as to resource property value-types and allowed values. |
| Prefixed Name |
Occurs |
Read-only |
Value-type |
Representation |
Range |
Description |
| OSLC Asset: Start of additional properties |
| dcterms:identifier |
zero-or-one |
True |
String |
n/a |
n/a |
A unique identifier for a resource. Assigned by the service provider when a resource is created. |
| oslc_asset:guid |
zero-or-one |
unspecified |
String |
n/a |
n/a |
An identifier for the asset. Assigned by the service provider when a resource is created. Different versions of the same asset will share the same identifier. |
| oslc_asset:version |
zero-or-one |
unspecified |
String |
n/a |
n/a |
The version of the asset. Possible values may include '1.0', '2.0', etc. |
| oslc_asset:state |
zero-or-one |
unspecified |
Either Resource or Local Resource |
Either Reference or Inline |
any |
Used to indicate the state of the asset based on values defined by the service provider. This specification does not define the resource for this property, however it should contain a dcterms:title property. |
| oslc_asset:categorization |
zero-or-many |
unspecified |
Either Resource or Local Resource |
Either Reference or Inline |
any |
A categorization to classify an asset. The category schema values are defined by the service provider. This specification does not define the resource for this property, however it should contain a dcterms:title property. |
| oslc_asset:artifact |
zero-or-many |
unspecified |
Local Resource |
Inline |
oslc_asset:Artifact |
The multi valued list of artifacts. |
| oslc_asset:artifactFactory |
exactly-one |
unspecified |
Resource |
Reference |
any |
|
| Prefixed Name |
Occurs |
Read-only |
Value-type |
Representation |
Range |
Description |
| OSLC Artifact Fragment: The grouping of properties that define an artifact |
| dcterms:title |
exactly-one |
unspecified |
XMLLiteral |
n/a |
n/a |
The name of the artifact. Title (reference: Dublin Core) of the resource represented in text XHTML content. SHOULD include only content that is valid inside an XHTML element. |
| oslc:label |
zero-or-one |
unspecified |
XMLLiteral |
n/a |
n/a |
The label of the artifact. Subject (reference: Dublin Core) an abbreviated presentation for the end-users. SHOULD include only content that is valid inside an XHTML element. |
| oslc_asset:content |
exactly-one |
unspecified |
Resource |
Reference |
Artifact Media |
The media resource reference URI (the artifact bytes). |
| dcterms:format |
zero-or-one |
unspecified |
String |
n/a |
n/a |
The mime type of the artifact media resource. |
| oslc_asset:size |
zero-or-one |
True |
Integer |
n/a |
n/a |
The size of the artifact media resource in bytes. |
| dcterms:created |
zero-or-one |
True |
DateTime |
n/a |
n/a |
Timestamp of resource creation (reference: Dublin Core). |
| dcterms:modified |
zero-or-one |
True |
DateTime |
n/a |
n/a |
Timestamp last latest resource modification (reference: Dublin Core). |
| Prefixed Name |
Occurs |
Read-only |
Value-type |
Representation |
Range |
Description |
| Relationship Properties: This grouping of properties are used to identify relationships between resources managed by the current or other OSLC Service Providers |
| oslc_asset:relatedAsset |
zero-or-many |
False |
Resource |
Reference |
any |
This relationship is loosely coupled and has no specific meaning. It is likely that the target resource will be a oslc_asset:Asset but that is not necessarily the case. Details about this relationship may be included in a reified statement. |
| oslc_asset:relatedChangeRequest |
zero-or-many |
False |
Resource |
Reference |
any |
This relationship is loosely coupled and has no specific meaning. It is likely that the target resource will be a oslc_cm:ChangeRequest but that is not necessarily the case. |
| oslc_asset:relatedRequirement |
zero-or-many |
False |
Resource |
Reference |
any |
This relationship is loosely coupled and has no specific meaning. It is likely that the target resource will be an oslc_rm:Requirement but that is not necessarily the case. |
| oslc_asset:relatedAutomationPlan |
zero-or-many |
False |
Resource |
Reference |
any |
This relationship is loosely coupled and has no specific meaning. It is likely that the target resource will be a oslc_auto:AutomationPlan but that is not necessarily the case. |
| oslc_asset:relatedAutomationResult |
zero-or-many |
False |
Resource |
Reference |
any |
This relationship is loosely coupled and has no specific meaning. It is likely that the target resource will be a oslc_auto:AutomationResult but that is not necessarily the case. |
| oslc_asset:relatedAutomationRequest |
zero-or-many |
False |
Resource |
Reference |
any |
This relationship is loosely coupled and has no specific meaning. It is likely that the target resource will be a oslc_auto:AutomationRequest but that is not necessarily the case. |
| oslc_asset:relatedTestPlan |
zero-or-many |
False |
Resource |
Reference |
any |
This relationship is loosely coupled and has no specific meaning. It is likely that the target resource will be an oslc_qm:TestPlan but that is not necessarily the case. |
| oslc_asset:relatedTestCase |
zero-or-many |
False |
Resource |
Reference |
any |
This relationship is loosely coupled and has no specific meaning. It is likely that the target resource will be an oslc_qm:TestCase but that is not necessarily the case. |
| oslc_asset:relatedTestResult |
zero-or-many |
False |
Resource |
Reference |
any |
This relationship is loosely coupled and has no specific meaning. It is likely that the target resource will be an oslc_qm:TestResult but that is not necessarily the case. |
| oslc_asset:relatedTestExecutionRecord |
zero-or-many |
False |
Resource |
Reference |
any |
This relationship is loosely coupled and has no specific meaning. It is likely that the target resource will be an oslc_qm:TestExecutionRecord but that is not necessarily the case. |
| oslc_asset:relatedTestScript |
zero-or-many |
False |
Resource |
Reference |
any |
This relationship is loosely coupled and has no specific meaning. It is likely that the target resource will be an oslc_qm:TestScript but that is not necessarily the case. |
| oslc_asset:relatedArchitectureManagement |
zero-or-many |
False |
Resource |
Reference |
any |
This relationship is loosely coupled and has no specific meaning. It is likely that the target resource will be an oslc_am:#ArchitectureManagementResource but that is not necessarily the case. |
| dcterms:relation |
zero-or-many |
False |
Resource |
Reference |
any |
This relationship is loosely coupled and has no specific meaning. It is intended to be used for related resources that do not fit into one of the pre-defined relationship properties. |
| Prefixed Name |
Occurs |
Read-only |
Value-type |
Representation |
Range |
Description |
| Related Asset Reified Statement Properties: This grouping of properties is used to provide additional details about a related asset link in a reified statement |
| oslc_asset:relationshipType |
zero-or-one |
unspecified |
Either Resource or Local Resource |
Either Reference or Inline |
any |
The type of this relationship from the perspective of the oslc_asset:relatedAsset resource based on values defined by the service provider. This specification does not define the resource for this property, however it should contain a dcterms:title property. |
| dcterms:creator |
zero-or-many |
unspecified |
Either Resource or Local Resource |
Either Reference or Inline |
any |
Creator or creators of resource (reference: Dublin Core). It is likely that the target resource will be a foaf:Person but that is not necessarily the case. |
| dcterms:created |
zero-or-one |
True |
DateTime |
n/a |
n/a |
Timestamp of resource creation (reference: Dublin Core). |
| dcterms:modified |
zero-or-one |
True |
DateTime |
n/a |
n/a |
Timestamp last latest resource modification (reference: Dublin Core). |
| oslc_asset:state |
zero-or-one |
unspecified |
Either Resource or Local Resource |
Either Reference or Inline |
any |
Used to indicate the state of the relationship based on values defined by the service provider. This specification does not define the resource for this property, however it should contain a dcterms:title property. |
Artifact Media Resources
An Asset's Artifacts have a Media Resource representing the actual content of the Artifact.
A client can POST Media Resources (content) to the {Artifact Media Creation URL} which is a property of the Asset. When POSTed, the service provider creates a new Media Resource and adds an associated Artifact property to the Asset.
The Artifact property has properties which include the URL to the (potentially binary) Media Resource. The Property thus makes the description for that Media Resource separately available for retrieval and alteration.
Successful responses to creation requests must return a status code of 201, and a Location Header indicating the URL of the Media Resource. The new Artifact property must have an olsc_asset:content element with a "rdf:resource" attribute. The value of the "rdf:resource" attribute is an URL for the newly created Media Resource.
Upon successful creation of a Resource, a server must populate mandatory elements with values derived from the POSTed entity or from any other source. A server may not allow a client to modify server-selected values (such as creation time, size, mime type).
Asset Management Service Provider Capabilities
Service Discovery and Description
OSLC Asset Management service providers
MUST provide a
Service Provider Resource that can be retrieved at a implementation dependent URI.
OSLC Asset Management service providers
MAY provide a
Service Provider Catalog Resource that can be retrieved at a implementation dependent URI.
OSLC Asset Management service providers
MUST provide a
oslc:serviceProvider property for their defined resources that will be the URI to a
Service Provider Resource.
OSLC Asset Management service providers
MUST supply a value of
http://open-services.net/ns/asset# for the property
oslc:domain on either
oslc:Service or
oslc:ServiceProviderCatalog resources.
Creation Factories
OSLC Asset Management service providers
MUST support
Creation Factories and list them in the Service Provider Resource as defined by OSLC Core. OSLC Asset Management service providers
SHOULD support
Resource Shapes for Creation Factories as defined in
OSLC Core Specification
Query Capabilities
OSLC Asset Management service providers
MUST support the
Query Capabilities as defined by OSLC Core. OSLC Asset Management service providers
SHOULD support
Resource Shapes for Query Capability as defined in
OSLC Core Specification
The Query Capability
MUST support these parameters:
-
oslc.where
-
oslc.select
-
oslc.properties
-
oslc.prefix
If shape information is NOT present with the Query Capability, service providers
SHOULD use these default properties to contain the result:
Delegated User Interface Dialogs
OSLC Asset Management service providers
SHOULD support the selection of resources by delegated web-based user interface dialogs
Delegated UIs as defined by OSLC Core.
OSLC Asset Management service providers
MAY support the creation of resources by delegated web-based user interface dialogs
Delegated UIs as defined by OSLC Core.
OSLC Asset Management service providers
MAY support the pre-filling of creation dialogs based on the definition at
Delegated UIs.
The service providers supports the delegated UIs as follows:
Version Compatibility with 1.0 Specifications
The goal is to provide a smooth transition to 2.0 for both Consumers and Providers. This section will clarify the usage of 1.0 media types so that Providers can support both 1.0 and 2.0 Consumers when HTTP requests are made for a resource with the same URI.
Media Types
For an Asset Resource format identification of RDF/XML and XML, the media type used for this representation SHOULD be
application/rdf+xml or
application/xml.
For an Asset Resource format identification of JSON, the media type used for this representation SHOULD be
application/json.
Appendix A: Samples
(this section is informative)
See
AssetMgSpecificationV2Samples
Appendix B: Resource Shapes
(this section is informative)
See
AssetMgSpecificationV2Shapes
Appendix C: Notices and References
Contributors
Reporting Issues on the Specification
The working group participants who author and maintain this working draft specification, monitor a distribution list where issues or questions can be raised, see
Asset Management Mailing List
Also the issues found with this specification and their resolution can be found at
AssetMgSpecificationV2Issues
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 Asset Management 2.0 Specification, as described in the open-services.net
Terms of Use. Details of the Covenant may be found
here.
References