Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Lyo/NewMain
Eclipse Lyo promotes the use of Linked Data principles and the OSLC (Open Services for Lifecycle Collaboration) standard for publishing lifecycle data, to enable the interoperability of heterogeneous products, services, and other distributed network resources. The open OASIS OSLC standard is based on a RESTful architecture and Linked Data principles, such as those defined in the RDF family of specifications, and the W3C Linked Data Platform.
Eclipse Lyo supports Java developers with the development of REST-based servers and clients that need to share heterogeneous information as RDF resources.
Contents
What is OSLC?
For an introduction to the OASIS OSLC standard:
- Integrating products with OSLC - A tutorial that explains how to implement OSLC Servers and Clients, with lots of examples and working code.
- Linked Data and OSLC Tutorial - A video introducing Linked Data and OSLC.
- Introduction to OSLC and Linked Data - A slides presentation introducing OSLC.
OSLC4J SDK
Lyo’s central component is the OSLC4J SDK (Software Development Kit) that helps build REST-based servers and clients, compliant with the OSLC standard.
The library provides:
- Annotations that automate the marshaling/unmarshaling of Java objects to/from Linked Data RDF resources (Apache Jena model).
- Annotations that allow servers to publish their RESTful API capabilities, based on the OSLC Discovery approach. This in turn facilitates for clients to discover and use available capabilities.
- JAX-RS Providers and utility classes to facilitate the development of REST operations for accessing, creating, updating and deleting RDF resources.
Lyo Designer
Lyo Designer is an Eclipse plugin that allows one to graphically model (1) the overall system architecture, (2) the information model of the RDF resources being shared, and (3) the individual services and operations of each Server in the system.
Lyo Designer includes a integrated code generator that synthesizes the toolchain model into almost-complete OSLC4J-compliant running implementation. The resulting code includes:
- Java classes with appropriate OSLC4J-annotations to reflect the modelled resources, and hence facilitate the marshaling/unmarshaling of Java instances as Linked Data RDF resources.
- JAX-RS Service operations for accessing, updating, creating and deleting RDF resources.
- These operations handle any of the supported formats (turtle, RDF/XML, Json, etc.)
- For debugging purposes, jsp pages are also produced to deliver HTML representations of all RDF resources.
- JAX-RS Service operations to completely handle Delegated UI for both creation and selection dialogs.
- Including the initial generation of basic jsp pages for the html-representation of the dialogs.
- JAX-RS Service operations to handle Resource Preview
- Including the initial generation of basic jsp pages for the html-representation of the resource previews.
TODO break it down into simple English
Lyo Designer supports incremental development, where manual changes to the generated code are preserved upon changes to the model, and subsequent code regeneration.
Tutorials and Documentation
Installation
- How to setup the Eclipse environment for Lyo development
- How to create an initial REST server application, ready for Lyo-based development
- How to install Lyo Designer
Basic Topics
- How to use Lyo Designer to model a toolchain and generate an initial code base
- How to implement an Tracked Resource Set (TRS) OSLC server
Example OSLC Servers
Lyo also includes instructions and source code for a range of OSLC Server implementations:
- Bugzilla - an example of what Eclipse Lyo can be used for, in the form of an OSLC-CM compatible adapter for the Bugzilla bugtracker application. It wraps Bugzilla (interacting with it through Bugzilla's native XMLRPC API) with an OSLC-CM provider server accessible through REST calls.
- Sample OSLC client - that demonstrates how to use the Lyo client to interact with OSLC Service Providers in various ways.
- SharePoint - This SharePoint adapter looks through the sharepoint OData collections for collections where the ContentType is defined as "Document". For each SharePoint library that contains documents, an OSLC service provider is created with the basic services for OSLC Delegated dialogs for selection and creation as well as listing the documents with a UI preview.
- The Hudson and Jenkins adapor implements the OSLC Automation specification.
- Simulink
- MagicDraw
- The Lyo LDP reference implementation - is a sample Java implementation of the W3C Linked Data Platform 1.0 Candidate Recommendation using JAX-RS (Apache CXF) and Jena TDB.
Additional components
Additional components of the Lyo project include:
- OSLC Client - provides helpful APIs to interact with OSLC Servers. It provides an additional layer of functionality on top of Apache HttpClient, Apache Wink, and OSLC4J that can give you a head start on some of the common use cases such as form login, OAuth handling, service discovery, sending queries, and processing query results. > TODO Build instructions for the client should be replaced with Maven instructions on https://www.eclipse.org/lyo/ > > TODO OSLC4J Client is supposed to be a part of OSLC4J SDK, right?
- OSLC Tracked Resource Specification (TRS) SDK - provides a simple set of java beans that represent the entities within the TRS specification. > TODO current TRS libs live under the Lyo core.
- Lyo Store - a library that provides a simple interface for working with a triplestore via Java objects representing OSLC Resources.
- Test Suite - provides a suite of tests which will test OSLC domain provider implementations against the specification.
- Reference Implementations - See how OSLC works directly with working samples and with a simple server to test against. > TODO is it a typo?
- Reference Implementations (OUTDATED) - a simple, bare-bones reference implementation of the OSLC specifications. RIOs are intended to help those who are adopting OSLC by providing a functioning system that can be explored via a simple UI and REST services, or by taking a look at the source code.
- Lyo OSLC Perl library and samples
- OSLC4JS Javascript OSLC library (experimental).
Advanced topics
- Working with Lyo Designer from source code
- Building and using OSLC4J from source code (Including running sample code and reference implementations)
- Building and using Lyo Client from source code (Including running sample code)
- Building and running the *old* reference implementations (RIOs)
- Building and running the OSLC test suite
Contributing to Lyo
- Introduce yourself on the Lyo development mailing list
- Open a new Lyo Bugzilla ticket (you may check existing open tickets first)
- To contribute code, see the Lyo Contributor's Guide and Tips for Working with Git.
- Eclipse Lyo Release Process
TODO reduce it to two steps: sign ECA, submit pull request on Github.
Project Plans
Lyo project plan for Lyo 1.0-2.1.2
After 2.1 there was a plan for immediate Lyo 3 release, but it was not picked up eagerly enough. Right now the new roadmap continues to make 2.x releases.
Lyo 2.3+ roadmap (updated on 2017-07-29).