Asset Management Service Description

1.0 Specification

Introduction

Clients with a need to interact with an Asset Management system need a mechanism for discovering its capabilities, and the URLs used to access those capabilities. There are several aspects to the discovery process. First, clients may need to discover the existence of the Asset Management system itself. Once identifying the system, the clients need to discover the services that are provided within that system. This portion of the OSLC asset management spec addresses the latter of these scenarios, leaving the discovery of the asset management system itself to either manual configuration or a broader network configuration mechanism. Therefore, this spec focuses on how clients will discover the service document associated with that system, and the format of that document.

Refer to the definitions page for descriptions on asset management related terms used here.

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.

Service Description Resource

A Service Description Resource is an informational resource describing a the contextual configuration needs of a service provider.

The GET method on a Service Description Resource MUST retrieve a Service Description Document. This specification only covers retrieving a Service Description Resource with GET. The behavior of POST, PUT, and DELETE methods on Service Description Resources are not covered in this specification.

Service Description Document

The Service Description Document provides configuration definitions needed by consumers of a service provider.

XML namespace abbreviations used in this specification:

rdf - RDF XML namespace - http://www.w3.org/1999/02/22-rdf-syntax-ns#
dc - The Dublin Core Metadata Terms namespace - http://purl.org/dc/terms/
oslc_asset - The Open Services for Lifecycle Collaboration Asset Management namespace - http://open-services.net/xmlns/asset/1.0

XML Representation Summary: ServiceDescriptor? ? Element
<oslc_asset:ServiceDescriptor rdf:about="anyURI"> Content: {dc:title, dc:description?, dc:contributor?} </oslc_asset:ServiceDescriptor>
Property	Representation	Presentable
dc:title	The REQUIRED title string. Note that this element comes from the DC namespace, allowing tools unaware of the change management domain to access this element.	Yes
dc:description	The REQUIRED description string. This element comes from the DC namespace, allowing tools completely unaware of the change management domain to access this element.	Yes
dc:contributor	The OPTIONAL contributor string. This element comes from the DC namespace, defining the contributing entity of this service implementation.	N/A
- dc:title	The OPTIONAL title string that could be used for display.	Yes
- dc:identifier	The REQUIRED contributor identifier. This can be of any form but recommend to either be of URN com.{company name}.{product indentifier} or URL forms. This property is to be used by a client application to identify the provider of this service.	No
- oslc_asset:icon	The OPTIONAL URL to an icon file that represents the provider. This icon should be a favicon format and 16x16 pixels in size	Yes
- oslc_asset:home	The OPTIONAL home element when present it MUST have child elements <dc:title> and <oslc_cm:url>. This can be used by service providers to provide a URL to the main Web UI which clients may use to navigate to. There MUST only be one occurrence of this element.	Only <dc:title>
- oslc_asset:factory	The OPTIONAL factory element with REQUIRED child elements <dc:title> and <oslc_asset:url>. There may be an optional <oslc_asset:identifier> element that is intended for use in a choice list.	Only <dc:title>
- oslc_asset:simpleQuery	The OPTIONAL simple query element with REQUIRED child elements <dc:title> and <oslc_asset:url>. There MUST be only one simpleQuery element.	Only <dc:title>

Providers of this Service Description Document MAY provide additional properties in a non-OSLC namespace.

Presentable text is intended to be seen by users of the client application communicating with the provider of this service. Presentable text, as indicated in the table above, can have multiple entries per translated language supported. The language of each presentable text string will be indicated with the xml:lang attribute.

Example

<?xml version="1.0" encoding="UTF-8"?>
    <oslc_asset:ServiceDescriptor rdf:about="https://server:9443/ram/oslc/assets/services">
        <dc:title>Asset Management Services</dc:title>
        <dc:description>  IBM Rational Team Concert OSLC Asset Management Service Description  </dc:description>  
        <dc:contributor>
            <dc:title>IBM Rational Asset Manager</dc:title>
            <dc:identifier>com.ibm.ram.assets</dc:identifier>
            <oslc_asset:icon>https://ram/images/RationalAssetManager.ico</oslc_asset:icon>
       </dc:contributor>

       <!-- Services -->
       <oslc_asset:assets oslc_asset:version="1.0">
           <oslc_asset:home rdf:about="https://server:9443/ram/oslc/assets">
               <dc:title>Assets Home</dc:title>
           </oslc_asset:home>

          <!-- Create asset location -->
          <oslc_asset:factory rdf:about="https://server:9443/ram/oslc/assets">
              <dc:title>Default location for creation of assets</dc:title>
           </oslc_asset:factory>

          <!-- Asset Search -->
          <oslc_asset:simpleQuery rdf:about="https://server:9443/ram/oslc/search">
              <dc:title>Assets queries</dc:title>
          </oslc_asset:simpleQuery>
      </oslc_asset:assets>
</oslc_asset:ServiceDescriptor>

References

Topic revision: r13 - 17 Mar 2010 - 18:41:45 - ScottBosworth

Main

Webs
Main
Sandbox
TWiki

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