Technical Spec

Learning Registry Technical Specification V 0.51.0

See the Change Log for links to prior stable versions.

Major changes and additions from the prior version (0.50.1) are marked with ▲.

Significant deletions use strikethrough text.

Features to be deprecated in a future version are indicated with ▼.

This document is the whole of the Learning Registry Technical Specification.

Technical Specification Introduction

This document provides the technical specification for the Learning Registry. It specifies the network model, data models and APIs. It does not specify policy-based operational procedures or the instantiation or deployment of the Learning Registry. It does not specify internal data models or internal APIs. The specification focuses on the APIs used by external agents and the data models and APIs required for overall operations of a network and general interoperability of external agents. While targeted at a document-oriented infrastructure, the specification itself is independent of any particular toolset. The document is currently a work in progress; its structure, organization and content are subject to change.

Technical Specification Contents

• 1. General Matter: Learning Registry Technical Specification - V GM:0.51.0
  • 1.1. Learning Registry Overview
  • 1.2. Specification License
  • 1.3. Notation
  • 1.4. Conformance
  • 1.5. Specification Versioning
  • 1.6. Technical Specification Overview
    • 1.6.1. Design Principles
  • 1.7. Glossary
  • 1.8. References
  • 1.9. Change Log
  • 1.10. Working Notes and Placeholder Text
• 2. Resource Distribution Network Model: Learning Registry Technical Specification V NM:0.50.1
  • 2.1. Resource Distribution Network Model
    • 2.1.1. Network Nodes and Node Services
    • 2.1.2. Network Topology
    • 2.1.3. Network Data Models
    • 2.1.4. Network Description
  • 2.2. Change Log
  • 2.3. Working Notes and Placeholder Text
• 3. Resource Data Data Model: Learning Registry Technical Specification V RM:0.51.0
  • 3.1. Resource Data Data Models
    • 3.1.1. Resource Data Description Data Model
    • 3.1.2. Metadata Formats
    • 3.1.3. Paradata Formats
    • 3.1.4. Resource Data
    • 3.1.5. Tombstones
  • 3.2. Change Log
  • 3.3. Working Notes and Placeholder Text
• 4. Identity, Trust, Auth and Security: Learning Registry Technical Specification V IT:0.51.0
  • 4.1. Identity and Digital Signatures
    • 4.1.1. Signing a Resource Data Description Document
    • 4.1.2. Validation the Signature of a Resource Data Description Document
  • 4.2. Authorization and Authentication
    • 4.2.1. Authentication
    • 4.2.2. Authorization
    • 4.2.3. Network Communications Security
    • 4.2.4. Network Ports
  • 4.3. Trust
  • 4.4. Security and Information Assurance
  • 4.5. Change Log
  • 4.6. Working Notes and Placeholder Text
• 5. Data Model and API Attributes and Behaviors: Learning Registry Technical Specification V RQ:0.50.1
  • 5.1. Common Data Model and API Attributes and Behaviors
    • 5.1.1. Data Model Attributes
    • 5.1.2. API Attributes and Behaviors
• 6. Services and APIs: Learning Registry Technical Specification V SA:0.50.1
  • 6.1. Services and APIs
  • 6.2. Change Log
  • 6.3. Working Notes and Placeholder Text
• 7. Distribution Services: Learning Registry Technical Specification V DS:0.50.1
  • 7.1. Resource Data Distribution Service
    • 7.1.1. API: Data Distribution
    • 7.1.2. Resource Distribution: Source Node Process
    • 7.1.3. Resource Distribution: Destination Node Process
    • 7.1.4. API: Destination Node Information
    • 7.1.5. Resource Distribution: Destination Node Information
    • 7.1.6. Service Description
  • 7.2. Change Log
  • 7.3. Working Notes and Placeholder Text
• 8. Publish Services: Learning Registry Technical Specification V PS:0.50.1
  • 8.1. Resource Data Publish Services
    • 8.1.1. Basic Publish Service
    • 8.1.2. SWORD Publish Service
    • 8.1.3. Basic Delete Service
    • 8.1.4. Change Log
    • 8.1.5. Working Notes and Placeholder Text
• 9. Access Services: Learning Registry Technical Specification V AS:0.50.1
  • 9.1. Resource Data Access Services
    • 9.1.1. Basic Obtain Service
    • 9.1.2. Basic Harvest Service
    • 9.1.3. OAI-PMH Harvest Service
• 10. Broker Services: Learning Registry Technical Specification V BS:0.50.1
  • 10.1. Broker Services
  • 10.2. Change Log
  • 10.3. Working Notes and Placeholder Text
• 11. Management, Administrative and Discovery Services: Learning Registry Technical Specification V MS:0.50.1
  • 11.1. Administrative Services
    • 11.1.1. Network Node Status Service
    • 11.1.2. Network Node Description Service
    • 11.1.3. Network Node Services Service
    • 11.1.4. Resource Distribution Network Policy Service
    • 11.1.5. Change Log
    • 11.1.6. Working Notes and Placeholder Text
• 12. Learning Registry Operations: Learning Registry Technical Specification V OP:0.50.1
  • 12.1. Operations
  • 12.2. Networks and Communities
  • 12.3. Building the Network Description
    • 12.3.1. Establish a Network Node
    • 12.3.2. Establish a Resource Distribution Network
    • 12.3.3. Establish a Network Community
    • 12.3.4. Add a Network Node to a Resource Distribution Network
    • 12.3.5. Adding Connections within a Resource Distribution Network
    • 12.3.6. Connect Networks within a Community
    • 12.3.7. Connect Communities
  • 12.4. Maintaining Networks and Communities
    • 12.4.1. Change Network Node Description
    • 12.4.2. Delete a Network Node
    • 12.4.3. Change Node Service Description
    • 12.4.4. Add Node Service
    • 12.4.5. Delete Node Service
    • 12.4.6. Change Node Network Connectivity
    • 12.4.7. Delete Node Network Connectivity
    • 12.4.8. Change Node Filters
    • 12.4.9. Delete Node Filters
    • 12.4.10. Change Resource Distribution Network Description
    • 12.4.11. Delete Resource Distribution Network Description
    • 12.4.12. Change Resource Distribution Network Policy
    • 12.4.13. Delete Resource Distribution Network Policy
    • 12.4.14. Change Network Community Description
    • 12.4.15. Delete Network Community Description
    • 12.4.16. Network Discovery
  • 12.5. Network Design
  • 12.6. Resource Data Publication, Distribution and Access
    • 12.6.1. Resource Data Persistence
  • 12.7. Network Administration
  • 12.8. Change Log
  • 12.9. Working Notes and Placeholder Text

Change Log

NB: The change log only lists major updates to the specification.

NB: Updates and edits may not results in a version update.

NB: See the individual partsg of the Technical Specification for specific changes to that part.

Version	Date	Author	Change
0.10.0	20110117	DR	Initial public release (lacks resource data model). Archived copy (V 0.10.0)
0.15.0	20110222	DR	Added filtering. Added basic harvest. Added resource data model. Added basic delete. Archived copy (V 0.15.0)
0.16.0	20110310	DR	Added OAI-PMH harvest. Obtain extended to support by doc_ID or by resource_ID/locator access. Documented Obtain. Basic Harvest extended to support doc_ID or by resource_ID/locator access for GetRecord. Archived copy (V 0.16.0)
0.17.0	20110415	DR	Clarified that services are optional, described operational requirements to provision services. Revised XSD to support OAI-PMH harvest by resouce_ID. Clarified times are UTC 0. Clarified distributeAPI to uncouple it from other APIs. Add ToS checks to distribute and publish. Update reource doc to include ToS attribution. Added SWORD API. Archived copy (V 0.17.0)
0.20.0	20110422	DR	Added digital signature k-v pairs to resource documents. Added public key k-v pairs to all description documents. Updated network and node policy descripitons. Added signature, trust, ... verification to publish. Added identity section. Defined ALL behavior for obtain for size limited. Defined returning spec JSON vs. stored JSON for obtain and harvest. Authn (none, basic, SSH, Oauth, ...). Authz (access keys). Archived copy (V 0.20.0)
0.21.0	20110706	DR	Updated how to sign documents. Modified resource document description to restructure identity. Added JSONP to APIs. Obtain flow control (to be moved to a common location to add to other APIs). Archived copy (V 0.21.0)
0.22.0	20110708	DR	Made resource doc type an open vocabulary. Added trust weight. Added requirement that a service document exist for a service. Archived copy (V 0.22.0)
0.23.0	20110921	DR	Added k-v pair to mark documents as non distributable and process to block publication and distribution (take down process is policy, not part of the specification. Added checks on max doc size. Indicated that node time stamp is to be depricated. Indicated services to be deprecated. Documented obtain get interface. Archived copy (V 0.23.0)
0.24.0	20110921	DR	Remove deprecated servcies (query, SRW, Sitemap). Archived copy (V 0.24.0)
NA	20110921	DR	This document extracted from the monolithic V 0.24.0 document.Archived copy NA
0.49.0	20110927	DR	Changed license from OWA CLA 0.9 to OWA CLA 1.0. Added GM section on versioning.Archived copy location TBD (V 0.49.0)
Future	TBD		Add service code version to service documents (extracted from code on install). Renumber all documentmodels and service documents. Added node policy to control storage of attachments (default is stored). Add page size as service doc setting with flow control.Archived copy location TBD (V x.xx.x)
Future	TBD		ToS attribution output to OAI. Harvest flow control. Flow control to OAI. Logging/tracking emit as paradata to services. Assertion (relation/sameas) and trust documents. Deduplication service. RESTful APIs. Details of attachments on publish, obtain, harvest. Depricate node_timestampArchived copy location TBD (V x.xx.x)
Future	TBD		XXXArchived copy location TBD (V x.xx.x)
0.50.1	20130312	JK	Converted spec source format to RestructuredText. node_timestamp removed from deprecation. Archive copy (V 0.5x.x)
0.51.0	20140219	jH	Updated version number and shading of changes only. Updates to the spec are in the Resource Data Data Model

Working Notes and Placeholder Text