|
Open Services for Lifecycle Collaboration
Indexable Linked Data Provider Specification Version 2.0
|
Status: Status: Stable working draft. Implementations welcome to validate the draft. Ongoing work is occurring to validate this draft.
This Version
Latest Version
Previous Version
- This is the first version of this specification.
Authors
- Jim des Rivieres (IBM, OSLC-Core)
Contributors
Table of Contents
Contents
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
The OSLC Tracked Resource Set 2.0 specification TRS2 defines a general-purpose protocol for making a large set of resource URIs discoverable and for reporting ongoing changes affecting the set. This document describes how a lifecycle tool web application exposes a live feed of its linked lifecycle data via a tracked resource set, in a way that permits others tool to build and maintain live, searchable indexes based on that linked data.
A particular pool of linked data resources exposed through a particular Tracked Resource Set is referred to as an Indexable Linked Data Source. When exposing a live feed of its linked lifecycle data, a lifecycle tool server is playing the role of Indexable Linked Data Provider. An Indexable Linked Data Consumer is a client (usually another server) that works with linked lifecycle data coming from an Indexable Linked Data Source.
Note: IBM Rational Team Concert is an example of an Indexable Linked Data Provider; IBM Jazz Lifecycle Query Engine (LQE) is an example of an Indexable Linked Data Consumer that builds and maintains a live, searchable index by combining the linked data from a set of Indexable Linked Data Sources from one or more Indexable Linked Data Providers.
Terminology
This specification uses the term “Tracked Resource Set”, “Change Log”, and “Change Events” defined by the Tracked Resource Set 2.0 specification [TRS2].
This specification also defines the following terms:
Access Context - Grouping of resources with similar security requirements.
Access Context List Resource - Resource describing a list of Access Contexts.
Indexable Linked Data Source - Pool of linked data resources.
Indexable Linked Data Consumer - Client application that uses an Indexable Linked Data Source to discover a set of linked data resources and track changes to them.
Indexable Linked Data Provider - Server that implements an Indexable Linked Data Source.
Index Resource - Resource whose URI is listed in the Tracked Resource Set of an Indexable Linked Data Source.
IMPORTANT NOTE TO READERS: The terminology definitions in this section are a normative portion of this specification, imposing requirements upon implementations. All the capitalized words in the text of this specification, such as “Access Context”, reference these defined terms. Whenever the reader encounters them, their definitions found in this section must be followed.
Appendix A: Samples
(this section is informative)
See samples within the body of this specificiation.
Appendix B: Resource Shapes
Not applicable
Appendix C: Notices and References
Contributors
- Jim des Rivieres (IBM, OSLC-Core)
- Vivek Garg (IBM, OSLC-Core)
- SteveSpeicher (IBM, OSLC-Core Lead)
- Arthur Ryman (IBM, OSLC-Core)
- Nick Crossley (IBM, OSLC-Core)
- Ian Green (IBM, OSLC-Core)
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 Core Mailing List
Also the issues found with this specification and their resolution can be found at Core 2.0 Issues.
License and Intellectual Property
We make this specification available under the terms and conditions set forth in the site Terms of Use, IP Policy, and the Workgroup Participation Agreement for this Workgroup.
References
Appendix D: Changes
Category:Specifications
