2 |
9 |
10 | For a high-level overview of how to add OSLC support to software, we recommend our video "[Getting started on implementing OSLC](http://www.youtube.com/watch?v=-oXqudLmNMI)":
11 |
12 |
13 |
14 |
15 | Explore our tutorial
16 | ----------------------------------------------
17 |
18 | For a more detailed look at what goes into OSLC support, read through our tutorials "[Integrating Products with OSLC](tutorials)", which walks you through building an adapter that adds OSLC support to the popular Bugzilla defect-tracking software.
19 |
20 | The concepts in the tutorial are broadly applicable to other software.
21 |
22 | If you are **building an OSLC provider** (in other words, software that *outputs* OSLC resources), you'll learn how to
23 |
24 | - [Provide Service Providers and catalogs](integrating_products_with_oslc/implementing_an_oslc_provider/1_2_providing_service_resources)
25 | - [Represent Bugzilla bugs as OSLC Change Management resources](integrating_products_with_oslc/implementing_an_oslc_provider/1_3_intro_to_oslc4j)
26 | - [Provide UI Previews](integrating_products_with_oslc/implementing_an_oslc_provider/1_4_ui_preview)
27 | - [Provide a delegated UI for finding existing bugs](integrating_products_with_oslc/implementing_an_oslc_provider/1_5_ui_selection)
28 | - [Provide a delegated UI for creating new bugs](integrating_products_with_oslc/implementing_an_oslc_provider/1_6_ui_creation)
29 | - [Allow software to programmatically create new bugs](integrating_products_with_oslc/implementing_an_oslc_provider/1_7_factory)
30 |
31 | If you are **building an OSLC consumer application**, you'll learn how to:
32 |
33 | - [Link to OSLC resources in another application and display previews](integrating_products_with_oslc/integrating_with_an_oslc_provider/2_2_links_and_previews)
34 | - [Find, select, and create bugs without leaving the application with delegated UIs](integrating_products_with_oslc/integrating_with_an_oslc_provider/2_3_delegatedUI)
35 | - [Parse OSLC resources](integrating_products_with_oslc/integrating_with_an_oslc_provider/2_4_notify_customers)
36 | - [Create new bugs automatically](integrating_products_with_oslc/integrating_with_an_oslc_provider/2_5_automatic_bugs)
37 |
38 | The tutorial has working sample applications and [detailed instructions for running them](integrating_products_with_oslc/running_the_examples).
39 |
40 |
--------------------------------------------------------------------------------
/_harp/integrating_products_with_oslc/_data.json:
--------------------------------------------------------------------------------
1 | {
2 | "index": {
3 | "title": "Tutorial Overview",
4 | "parent_uri": "../tutorials.html"
5 | },
6 | "overview_of_oslc": {
7 | "title": "A brief overview of OSLC",
8 | "parent_uri": "../tutorials.html"
9 | },
10 | "running_the_examples": {
11 | "title": "Downloading and starting the sample applications",
12 | "parent_uri": "../tutorials.html"
13 | },
14 | "implementing_an_oslc_provider/1_0_implementing_a_provider": {
15 | "title": "Part 1, turning Bugzilla into a provider of the Change Management OSLC specification"
16 | },
17 | "implementing_an_oslc_provider/1_1_planning_partial_cm_provider": {
18 | "title": "Part 1.1, Planning Partial CM Provider"
19 | },
20 | "implementing_an_oslc_provider/1_2_providing_service_resources": {
21 | "title": "Part 1.2, Providing Service Resources"
22 | },
23 | "implementing_an_oslc_provider/1_3_intro_to_oslc4j": {
24 | "title": "Part 1.3, Intro to Eclipse Lyo"
25 | },
26 | "implementing_an_oslc_provider/1_4_ui_preview": {
27 | "title": "Part 1.4, UI Preview"
28 | },
29 | "implementing_an_oslc_provider/1_5_ui_selection": {
30 | "title": "Part 1.5, UI Selection"
31 | },
32 | "implementing_an_oslc_provider/1_6_ui_creation": {
33 | "title": "Part 1.6, UI Creation"
34 | },
35 | "implementing_an_oslc_provider/1_7_factory": {
36 | "title": "Part 1.7, Factory"
37 | },
38 | "integrating_with_an_oslc_provider/2_0_implementing_consumer": {
39 | "title": "Part 2, Implementing Consumer"
40 | },
41 | "integrating_with_an_oslc_provider/2_1_consumer_use_cases": {
42 | "title": "Part 2.1, Consumer Use Cases"
43 | },
44 | "integrating_with_an_oslc_provider/2_2_links_and_previews": {
45 | "title": "Part 2.2, Links and Previews"
46 | },
47 | "integrating_with_an_oslc_provider/2_3_delegatedUI": {
48 | "title": "Part 2.3, DelegatedUI"
49 | },
50 | "integrating_with_an_oslc_provider/2_4_notify_customers": {
51 | "title": "Part 2.4, Notify Customers"
52 | },
53 | "integrating_with_an_oslc_provider/2_5_automatic_bugs": {
54 | "title": "Part 2.5, Automatic Bugs"
55 | }
56 | }
57 |
--------------------------------------------------------------------------------
/_harp/integrating_products_with_oslc/_harp.json:
--------------------------------------------------------------------------------
1 | {
2 | "globals": {
3 | "org_name": "Open Services for Lifecycle Collaboration",
4 | "org_abbr": "OSLC",
5 | "site_name": "Developer Guide"
6 | }
7 | }
--------------------------------------------------------------------------------
/_harp/integrating_products_with_oslc/implementing_an_oslc_provider/1_0_implementing_a_provider.md:
--------------------------------------------------------------------------------
1 | # Implementing an OSLC provider
2 |
3 | In this section, we'll be creating an adapter to add [OSLC Change Management](https://docs.oasis-open-projects.org/oslc-op/cm/v3.0/os/change-mgt-spec.html) support
4 | to [Bugzilla](https://www.bugzilla.org/), an open source Defect Tracking system.
5 | Although the Bugzilla adapter is available now as part of Eclipse Lyo, its
6 | features and architecture are broadly applicable to any OSLC adaptor that adds OSLC Server
7 | support to an existing product.
8 |
9 | This video explores some of the challenges and considerations in getting
10 | started with adding OSLC support to existing applications:
11 |
12 |
13 |
14 | Next: [Part 1.1, Planning Partial CM Provider](1_1_planning_partial_cm_provider)
--------------------------------------------------------------------------------
/_harp/integrating_products_with_oslc/implementing_an_oslc_provider/1_1_planning_partial_cm_provider.md:
--------------------------------------------------------------------------------
1 | # Planning out a partial implementation of OSLC-CM
2 |
3 | Our integration use cases that we want to add to Bugzilla require only a partial implementation of the [OSLC Change Management](https://docs.oasis-open-projects.org/oslc-op/cm/v3.0/os/change-mgt-spec.html) specification:
4 |
5 | + __Service Provider and Catalogs__: These resources describe the services offered and make it possible for consumers of the OSLC CM service to find the ones they need. In Part 2, you will use these to help implement [Automated Bug Creation](../integrating_with_an_oslc_provider/2_5_automatic_bugs) so that the Testing team's build scripts can use Service Provider documents to locate a URL.
6 | + **OSLC representations for bugs**: This means making each Bug available at a stable URI as an OSLC-CM Change Request resource, with RDF/XML and UI Preview representations via content negotiation. In Part 2, these RDF/XML representations will help [automate customer notifications](../integrating_with_an_oslc_provider/2_4_notify_customers).
7 | + **Delegated UI for Creation & Selection**: Enables users of other systems to create and select bugs in Bugzilla without leaving the web UI of those other systems. You'll use these dialogs in Part 2's to [make it easy to link a customer incident to a Bugzilla bug](../integrating_with_an_oslc_provider/2_3_delegatedUI).
8 | + **Creation Factories for bugs**: Enables creation of new bugs by HTTP posting RDF/XML bug representations to the server. We also used this feature in Part 2 [for Automated Bug Creation](../integrating_with_an_oslc_provider/2_5_automatic_bugs).
9 |
10 | Although this leaves out some seemingly critical parts of OSLC (including UPDATE and DELETE via HTTP and OSLC Query), that's OK.
11 |
12 | First, though, we need to decide how we'll add OSLC support to the existing applications.
13 |
14 | ## Different approaches to implementing OSLC support
15 |
16 | There are (broadly) three different approaches to implementing an OSLC-CM provider for Bugzilla (or any other software):
17 |
18 | + The __Native Support__ approach is to add OSLC-CM support directly into Bugzilla, modifying whatever code is necessary to implement the OSLC-CM specification.
19 | + The __Plugin__ approach is add OSLC-CM support to Bugzilla by developing code that plugs-in to Bugzilla and uses its add-on API.
20 | + The __Adapter__ approach is to create new web application that acts as an OSLC Adapter, runs along-side of Bugzilla, provides OSLC-CM support and "under the hood" makes calls to the Bugzilla web APIs to create, retrieve, update and delete resources.
21 |
22 | Although any of these approaches are valid approaches for an OSLC implementation, here are some of the pros and cons of each:
23 |
24 |
3 |
5 | “OSL-whaaaat now?”
4 |
6 | Open Services for Lifecycle Collaboration (OSLC) is a community that writes specifications to integrate software. Learn more at Why develop OSLC applications and at our main site.
7 |
8 | | Approach | 28 |Pros | 29 |Cons | 30 |
|---|---|---|
| Native approach | 35 |
36 |
|
41 |
42 |
|
48 |
| Plugin approach | 51 |
52 |
|
56 |
57 |
|
62 |
| 65 | Adapter approach | 66 |
67 |
|
72 |
73 |
|
78 |
In older versions of this tutorial and Bugzilla adapter, we defined many individual servlets in the application's web.xml file; now, the OSLC4J Bugzilla adapter uses JAX-RS to handle URLs, requests, and resources.
6 |
14 |
15 | First up, we'll discuss the specific use cases that we want to support.
16 |
17 | [Next: Part 2.1, Consumer Use Cases](2_1_consumer_use_cases)
--------------------------------------------------------------------------------
/_harp/integrating_products_with_oslc/integrating_with_an_oslc_provider/2_1_consumer_use_cases.md:
--------------------------------------------------------------------------------
1 | # Sample use cases for an OSLC-CM Consumer
2 |
3 | Our NinaCRM sample application presents a number of use cases that could benefit from OSLC.
4 |
5 | NinaCRM is a [Customer Relationship Management](http://en.wikipedia.org/wiki/Customer_relationship_management) system that allows employees to store and track interactions with customers. First, let's explore how a typical interaction between a customer and a support representative:
6 |
7 | 1. Customer calls with a problem
8 | 2. Support rep brings up the record for the Customer, or creates one if necessary
9 | 3. Support rep finds the last incident involving the customer, or creates a new one if necessary.
10 | 4. Support rep searches for the customer's problem in the company's defect system (Bugzilla). If found, add the defect ID number to the Incident record.
11 | 5. If Defect includes work-around or fix, give it to the Customer
12 | 6. If the customer is satisfied with the solution, close the Incident
13 |
14 | A better integration between Bugzilla and the NinaCRM system will make the process work more smoothly and efficiently. Here are the top items we want to target with our integration work:
15 |
16 | 3. **Linking Incidents to bugs is too difficult**: It takes support reps too much time to leave the CRM web UI and search for solutions to customer problems manually using Bugzilla. First, we should use OSLC UI previews to allow reps to see more details about linked bugs without leaving the NinaCRM application. Then we should automate the process of entering bugs by modifying NinaCRM system to use OSLC Delegated UI and let support reps search, create, and link to bugss without leaving the CRM web UI.
17 | 2. **Customer notifications are a manual process**: Customers can request notification whenever a specific bug is updated. Customer reps have to set aside time each week to review customer requests and check on bug status. We can surely automate this entire process, including writing and sending an email notification to each customer.
18 |
19 |
20 | ## A Plan of Action
21 |
22 | Here's our plan of action to add OSLC-CM support to NinaCRM.
23 |
24 | ### Milestone 1: Use links and OSLC UI Preview
25 |
26 | + Modify NinaCRM to enable OSLC UI Preview for links to Bugzilla bugs
27 |
28 | ### Milestone 2: Use OSLC Delegated UI for creating and selecting Bugzilla bugs to link to
29 |
30 | + Add to CRM's Incident page ability to link via Delegated UI
31 |
32 | ### Milestone 3: Use OSLC protocol to automate customer notifications
33 |
34 | + Create a program that can run as a scheduled job, e.g. via build system
35 | + This program will query NinaCRM for list of notification requests and check the associated bugs
36 | + If the bug has updated since last run, send an email to customer with summary
37 |
38 | First up, we'll implement OSLC links and previews in NinaCRM.
39 |
40 | [Next: Part 2.2, Links and Previews](2_2_links_and_previews)
--------------------------------------------------------------------------------
/_harp/integrating_products_with_oslc/integrating_with_oslc_tutorial.pdf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/integrating_products_with_oslc/integrating_with_oslc_tutorial.pdf
--------------------------------------------------------------------------------
/_harp/integrating_products_with_oslc/overview_of_oslc.md:
--------------------------------------------------------------------------------
1 |
7 |
9 |
10 | Why is the sample application called "NinaCRM"?
8 |
11 | In older versions of this tutorial, we had a fictional protagonist named Nina who "designed" these applications. I've removed her story from this tutorial, but her legacy lives on in our sample application.
12 |
13 | 2 | 3 |
4 | 5 | Open Services for Lifecycle Collaboration (OSLC) is an initiative to define standards that enable easier and more effective integrations between the many tools that software and product developers use. OSLC is a different approach to tool integration that seeks to integrate the resources managed by those tools into the web of data. OSLC uses variety of web integration patterns, which are all either based on or complementary to what the World Wide Web Consortium (W3C) calls [Linked Data](http://www.w3.org/standards/semanticweb/data). 6 | 7 | To learn more about core OSLC concepts and architectural underpinnings, read the [OSLC Primer](https://open-services.net/resources/oslc-primer). We'll be implementing many of these core resources and services in this tutorial. 8 | 9 | For more information on the value of integrating with open protocols, read our whitepaper ["The Case for Open Services"](https://archive.open-services.net/resources/whitepapers/the-case-for-open-services/). 10 | 11 | Next: [Downloading and starting the sample applications](running_the_examples) 12 | 13 | -------------------------------------------------------------------------------- /_harp/integrating_products_with_oslc/running_the_examples.md: -------------------------------------------------------------------------------- 1 | ## Running the example applications 2 | 3 | This section explains how to setup the development environment to run the OSLC4J Bugzilla Adapter and the NinaCRM example application. 4 | 5 | ## Environment Setup 6 | 7 | Make sure your environment is set up for Lyo development as instructed on [Eclipse Setup for Lyo-based Development](../eclipse_lyo/eclipse-setup-for-lyo-based-development). The tutorial requires JDK 8 to be used. The code may run on JDK 11 with the warnings, and certain parts may fail to run on JDK 17 as of 2022-05. 8 | 9 | ## Bugzilla Setup 10 | 11 | Unless you have a Bugzilla system (with admin access) you can integrate against, you need to setup a running [Bugzilla system using Docker](https://hub.docker.com/r/smarx008/bugzilla-dev-lyo) for the purposes of this tutorial. 12 | 13 | 1. [Set up your Docker environment](https://docs.docker.com/get-started/). This is beyond the scope of this tutorial. You should be able to use [Rancher Desktop](https://rancherdesktop.io/) as well. 14 | 15 | 1. Launch the Bugzilla container that will be destroyed once you stop it: 16 | ```bash 17 | docker run --rm -p 80:80 --name bugzilla-dev smarx008/bugzilla-dev-lyo 18 | ``` 19 | 20 | 1. You can now browse to the Bugzilla homepage at http://localhost/bugzilla and use `admin:password` as admin credentials. 21 | 22 | ## Importing the tutorial projects into Eclipse 23 | 24 | The [Lyo documentation](https://github.com/eclipse/lyo.docs) Git repository contains the necessary code for this tutorial, while https://github.com/OSLC/lyo-adaptor-ninacrm contains the sample application, NinaCRM, which is used to demonstrate how a 3rd-party tool would integrate with a newly developed OSLC Server. **The finished OSLC Server can be found under [OSLC/lyo-adaptor-bugzilla](https://github.com/OSLC/lyo-adaptor-bugzilla)** 25 | 26 | 1. Clone the [Lyo documentation](https://github.com/eclipse/lyo.docs) Git repository 27 | 1. In Eclipse, open the Git Repositories view. (**Window** → **Show View** → **Other**, search for `Git repo` and click **OK**.) 28 | 2. Click **Clone a Git Repository**. 29 | 3. In the Clone Git Repository window, in the **URI** field paste the following [https://github.com/eclipse/lyo.docs](https://github.com/eclipse/lyo.docs). The **Host** and **Repository** fields will autofill. Leave the **Username** and **Password** fields empty. 30 | 4. Click **Next**. 31 | 5. On the Branch Selection page, select **master** and click **Next**. 32 | 6. For the **Destination**, select a folder for the files or accept the default of your Eclipse workspace. 33 | 7. Click **Finish**. `lyo.docs` will appear in the Git Repositories view. 34 | 35 | 2. Next, import the tutorial projects into Eclipse 36 | 1. In Eclipse, switch to the Java perspective. (**Window** → **Perspective** → **Open Perspective** → **Java**) 37 | 1. Open the Project Explorer view. (**Window** → **Show View** → **Project Explorer**) 38 | 1. Select **File** → **Import...** 39 | 1. In the Import dialog that appears select **Maven** → **Existing Maven Projects**, and click **Next**. 40 | 1. Browse to the root directory of the recently cloned git repository. 41 | 1. Select the project **./lyo.docs/lyo-rest-workshop/Lab6** from the `lyo.docs` repo and click **Finish**. 42 | 1. Repeat the steps above for the **./lyo-adaptor-ninacrm** project from the `lyo-adaptor-ninacrm` repo. 43 | 44 | ## Configuring the Bugzilla adapter 45 | 46 | Configure the Bugzilla adapter to point to your Bugzilla application. 47 | 48 | 1. In the Project Explorer view, find and edit the file `src/main/resources/bugz.properties` in the Lab6 project. 49 | 1. Edit the `bugzilla_uri` property to the URL of your Bugzilla server. If you’re using the Bugzilla docker container, it will be: 50 | `bugzilla_uri=http://localhost/bugzilla` 51 | 1. For the `admin` property, provide your Bugzilla user ID. 52 | 1. Save `bugz.properties`. 53 | 54 | ## Update the applications 55 | 56 | Update the project configurations for the projects. 57 | 58 | 1. In Eclipse, open the Package Explorer view. (**Window** → **Show View** → **Package Explorer**) 59 | 2. In the Package Explorer view, select the following packages: 60 | 61 | * **ninacrm** 62 | * **oslc4j-bugzilla-sample-lab6** 63 | 64 | 3. Right-click and select **Maven** → **Update Project**. 65 | 4. In the Update Maven Project window, verify that those projects are selected and click **OK**. 66 | 67 | ## Running the sample applications 68 | 69 | ### Starting the OSLC4J Bugzilla adapter: 70 | 71 | 1. In the Package Explorer view, expand **Lab6**. 72 | 2. Find the file **pom.xml** 73 | 3. Right-click on **pom.xml** and select **Run as** → **Maven Build...**. 74 | 4. Enter **jetty:run** in the **Goals** field. 75 | 5. Select **Run** 76 | 77 | This will start the application. You will see a lot of messages in the Console view. The application will be running when you see this: 78 | 79 | [INFO] Started Jetty Server 80 | [INFO] Starting scanner at interval of 5 seconds. 81 | 82 | In your web browser navigate to the OSLC Catalog at [http://localhost:8080/OSLC4JBugzilla/services/catalog/singleton](http://localhost:8080/OSLC4JBugzilla/services/catalog/singleton) 83 | 84 | Log in with your Bugzilla user ID and password. 85 | 86 | ### Starting NinaCRM 87 | 88 | 1. In the Package Explorer view, expand **ninacrm**. 89 | 2. Find the file **pom.xml** 90 | 3. Right-click on **pom.xml** and select **Run as** → **Maven Build...**. 91 | 4. Enter **jetty:run** in the **Goals** field. 92 | 5. Select **Run** 93 | 94 | This will start the application. You will see a lot of messages in the Console view. The application will be running when you see this: 95 | 96 | [INFO] Started Jetty Server 97 | [INFO] Starting scanner at interval of 5 seconds. 98 | 99 | 100 | When the server starts, in your web browser navigate to [http://localhost:8181/ninacrm](http://localhost:8181/ninacrm) to see the NinaCRM example. 101 | 102 | Next: [Part 1, turning Bugzilla into a provider of the Change Management OSLC specification](implementing_an_oslc_provider/1_0_implementing_a_provider) 103 | -------------------------------------------------------------------------------- /_harp/iotp-adaptor-sample.md: -------------------------------------------------------------------------------- 1 | iotp-adaptor is a partial implementation of an OSLC adapter for IBM Watson IoT Platform resources developed using eclipse/Lyo Designer. This adaptor provides an example of how to build an OSLC adaptor using [Lyo Designer](https://github.com/eclipse/lyo.designer/wiki), and how to customize the generated adaptor to expose Watson IoT Platform resources through OSLC capabilities and enable integration with IBM's jazz.net based [Continuous Engineering](https://jazz.net/products/continuous-engineering-solution/) solution. 2 | 3 | The [iotp-adaptor project](https://github.com/OSLC/iotp-adaptor) provides source code for a subset of [IBM Rational Engineering Lifecycle Manager](https://jazz.net/products/rational-engineering-lifecycle-manager/) (CE) version 6.0.6. The intent of providing this source code and documentation is help others who are developing OSLC integrations with IBM offerings. The [Developer Guide](./iotp_adaptor/developer-guide) provides the additional information you need to integrate OSLC clients and servers with the IBM jazz-based applications. This includes: 4 | 5 | * Providing a rootservices document for discovering server discovery capabilities 6 | * Establishing Consumer/Friend relationships using OAuth to allow servers to interact 7 | * Creating project area artifact container associations to enable linking between jazz.net CE tools and OSLC resources provided by adaptors 8 | * What link types are available in each of the applications based on the chosen artifact container association 9 | * Specific integration requirements of each CE application (RDNG, RTC and RQM) that you need to know to get the integrations working 10 | 11 | [iotp-adaptor User Guide](./iotp_adaptor/userGuide/user-guide) is a simple user's guide for installing, configuring, administering and using iotp-adapter with the CE tools. 12 | 13 | [iotp-adaptor Developer Guide](./iotp_adaptor/developer-guide) provides the complete documentation on how the server was developed. 14 | 15 | ## What is an Adaptor? 16 | 17 | Developing integrations using OSLC follows a number of common patterns: 18 | 19 | * **Facade** - OSLC native implementation in the tool or through a plugin using tool’s extensibility mechanisms - very tool specific 20 | * **Mediator** - OSLC adapter for the tool (tool responsible for storage) - using Lyo Designer, factors out all OSLC capabilities and requires only implementation of connector manager. 21 | * **Data mining** - into common OSLC manager (e.g. Rational Design Manager, MID Smartfacts) can result in data redundancy and ETL overhead 22 | * **Synchronization** - of common or overlapping data between tools - limited traceability and impact analysis (e.g., Tasktop Integration Hub) 23 | 24 | An OSLC adaptor (or adapter) follows the Mediator pattern. The adaptor can be quite simple: providing only OSLC capabilities and delegating all user management, persistence and user interaction to the integrated tools. Or the adaptor can be quite complex: providing OSLC capabilities on one or more adapted data sources, but also providing an integration hub with its own storage facilities, user management and UI in order to support integrations that are not possible or appropriate to implement in the individual tools. 25 | 26 | This range of adaptors represents a continuum between enabling and supporting integration. Enabling integration is primarily about providing OSLC capabilities on data sources in order to link resources across tools. These OSLC capabilities or services include: 27 | 28 | * **CRUD operations** - on resources using RDF resource representations (provides predictable resource formats, rich semantics, and goos support for links) 29 | * **Service discovery** - ServiceProviderCatalog, ServiceProvicers (containers of managed resources), Services that describe what OSLC capabilities are provided on what resources 30 | * **Query Capability** – persistent independent query capability for integration 31 | * **Delegated dialogs** – to allow an application to create and select resources in another application for the purpose of establishing links 32 | * **Resource preview** – to provide icons and labels in order to view a link to a resource managed by another tool 33 | * **Tracked Resource Sets** – in order to efficiently contribute data from many data sources into a single repository for cross-tool views, queries and reporting 34 | 35 | Providing these capabilities enables the integration of OSLC based clients and servers. But supporting integration can go beyond simple enabling of links to establishing and maintaining the meaning of the links, and the ability to automate workflow based on link semantics. 36 | 37 | iotp-adaptor is a simple OSLC adaptor that has no persistence of its own and does no user management. Login is delegated to the IBM Watson IoT Platform using your IBM Cloud credentials. All resources are stored in the Watson IoT Platform, and all links between the CE tools and the IoT Platform resources are stored in the CE tools repositories. 38 | 39 | Lyo Designer does generate a Web application that uses OSLC discovery to provide a "debug" interface on the OSLC representations of the IoT Platform resources. See [Generated Debug Web App](./iotp_adaptor/userGuide/debug-interface) for details. This generated Web application could be extended to provide additional UI and integration capabilities that could compliment the Watson IoT Platform UI. However this is not necessary in this case because the Watson IoT Platform already provides a sufficient Web UI. 40 | 41 | Other adaptors may need additional UI, workflow scripting and other capabilities. Lyo Designer can be used to create a starting point for such applications. 42 | 43 | 44 | 45 | 46 | -------------------------------------------------------------------------------- /_harp/iotp_adaptor/_data.json: -------------------------------------------------------------------------------- 1 | { 2 | "developer-guide": { 3 | "title": "Developer Guide", 4 | "parent_uri": "../iotp-adaptor-sample.html" 5 | }, 6 | "environment-setup": { 7 | "title": "eclipse environment setup", 8 | "parent_uri": "../iotp-adaptor-sample.html" 9 | }, 10 | "toolchain-model": { 11 | "title": "The toolchain model", 12 | "parent_uri": "../iotp-adaptor-sample.html" 13 | }, 14 | "code-generator": { 15 | "title": "Generating the server code", 16 | "parent_uri": "../iotp-adaptor-sample.html" 17 | }, 18 | "exploring-the-code" : { 19 | "title": "Exploring the generated code", 20 | "parent_uri": "../iotp-adaptor-sample.html" 21 | }, 22 | "ssl-support": { 23 | "title": "https and SSL support", 24 | "parent_uri": "../iotp-adaptor-sample.html" 25 | }, 26 | "authentication": { 27 | "title": "Authentication", 28 | "parent_uri": "../iotp-adaptor-sample.html" 29 | }, 30 | "rootservices": { 31 | "title": "Creating the rootservices document", 32 | "parent_uri": "../iotp-adaptor-sample.html" 33 | }, 34 | "consumer-friend": { 35 | "title": "Connecting Servers", 36 | "parent_uri": "../iotp-adaptor-sample.html" 37 | }, 38 | "artifact-container-associations": { 39 | "title": "Artifact Container Associations", 40 | "parent_uri": "../iotp-adaptor-sample.html" 41 | }, 42 | "dialogs": { 43 | "title": "Updating generated dialogs", 44 | "parent_uri": "../iotp-adaptor-sample.html" 45 | }, 46 | "implement-domain-class": { 47 | "title": "Implementing a Domain Class", 48 | "parent_uri": "../iotp-adaptor-sample.html" 49 | }, 50 | "trs-provider": { 51 | "title": "Implementing a TRS Provider", 52 | "parent_uri": "../iotp-adaptor-sample.html" 53 | }, 54 | "junit-tests": { 55 | "title": "JUnit Tests", 56 | "parent_uri": "../iotp-adaptor-sample.html" 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /_harp/iotp_adaptor/_harp.json: -------------------------------------------------------------------------------- 1 | { 2 | "globals": { 3 | "org_name": "Open Services for Lifecycle Collaboration", 4 | "org_abbr": "OSLC", 5 | "site_name": "Developer Guide" 6 | } 7 | } -------------------------------------------------------------------------------- /_harp/iotp_adaptor/artifact-container-associations.md: -------------------------------------------------------------------------------- 1 | # Artifact Container Associations 2 | 3 | OSLC discovery allows a client application to discover the services provided by and OSLC server application. Discovery capabilities include: 4 | 5 | * Service Provider Catalog: a list of Service Providers provided by the server. Jazz-apps obtain links to service provider catalogs using the rootservices document (an OSLC extension) 6 | * Service Provider: a container of managed resources accessed through OSLC capabilities. Jazz-app service providers correspond to project areas, the container of managed resources. 7 | * Services: includes creation factory, query capability, delegated creation and selection dialog and resource preview service URLs as shown below 8 | 9 |  10 | 11 | Jazz-apps initiate discovery by adding a friend application. This provides a link to the app's rootservices document which specifies the information needed to establish client/server interactions including: 12 | 13 | * Service provider catalogs using oalc_rm:rmServiceProviders, oslc_cm:cmServiceProviders, oslc_am:amServiceProviders for Requirement, Change Request and Architecture Management service providers 14 | * OAuth URLs required to establish OAuth authentication between OSLC client and server applications 15 | * TRS providers 16 | 17 | But this isn't enough to be able to create links between resources managed by a server's service providers. Artifact container associations are used to configure a project area for connections with service providers or project areas in another application. This is used in the client applications selection/creation dialog to allow user to select application and artifact container that has the resource to link to or create, based on the chosen link type. The association describes the relationship i.e. what kind of links can exist between resources managed by the client and server . So when you create a specific link type, the list is scoped based on the associations for that type of relationship. 18 | 19 | For iotp-adaptor, the organization as the service provider and users configure the project area to organization association because they are both the unit of user login and authentication. 20 | 21 | Table 1. Associations and links by application 22 | 23 | | Application Name | Associations | Links | 24 | | ---------------- | ------------ | ------ | 25 | | Change and Configuration Management | Provides: Implementation RequestsProvides: Related Change Requests
Provides: Requirements Change Requests | Tracks Requirement
Implements Requirement
Affects Requirement
Related Change Request 26 | | Quality Management | Uses: Defect
Uses: Requirement | Test Development Items
Validates Requirements | 27 | | DOORS Next Generation | Provides: Related Requirements | References | 28 | -------------------------------------------------------------------------------- /_harp/iotp_adaptor/consumer-friend.md: -------------------------------------------------------------------------------- 1 | Integration between jazz.net apps and iotp-adaptor requires an established, authenticated communication between the Jazz Team Server that hosts the lifecycle management applications and the iotp-adaptor OSLC server. This relationship between the two servers is called a friend relationship. It indicates that the requests coming from the servers can be trusted, and the two servers can communicate with each other. 2 | 3 | By creating this friend relationship and associating project areas, you can link tasks, defects, stories, or requirements from the lifecycle management applications with IoT Platform artifacts. To establish the friend relationship between Jazz Team Server and the connector, you must log in to Jazz Team Server with an account that has Jazz Project Administrator privileges. 4 | 5 | ## Adding A Friend 6 | 7 | [The User Guide](./userGuide/administration) documents how to add a friend to the jazz.net consumer apps to the iotp-adaptor server. Adding a friend requires the URL to the iotp-adaptor rootservices document. This URL must be known to the user and is typically `https://server:port/rootservices`. 8 | 9 | An administrator opens the jazz.net server admin page, typically the Jazz Team Server (JTS), and adds a friend providing the iotp-adaptor server rootservices URL. The JTS uses the OAuth1.0a URLs in the rootservices document to know what authentication scheme to use. The administrator specifies the OAuth secret and the server generates the consumer key. The authentication is completed by having an admin of the iotp-adaptor server accept the provisional key which completes the OAuth authentication sequence. 10 | 11 | The jazz.net apps and the iotp-adaptor can now communicate using OAuth tokens. 12 | 13 | ## OAuth Implementation 14 | 15 | The OAuth implementation used by iotp-adaptor is provided by eclipse/Lyo. There are four Maven projects in [https://github.com/eclipse/lyo.server](https://github.com/eclipse/lyo.server) that implement the OAuth support. 16 | 17 | 1. oauth-consumer-store - an implementation of an encrypted consumer store for OAuth tokens. This is where consumer keys created when the iotp-adaptor server is added as a friend to the jazz.net consumer apps 18 | 2. oauth-core - the OSLC4J implementation of OAuth1.0a 19 | 3. oauth-test - test cases for the OAuth implementation 20 | 4. oauth-webapp - a JEE web application that Lyo Designer uses to provide needed user interaction for OAuth authentication 21 | 22 | Lyo Designer generates the Application.java OslcWinkApplication file, but does not by default include OAuth support. You have to add it in the user code inside the static initializer in Application class. 23 | 24 | ``` 25 | // Start of user code Custom Resource Classes 26 | // OAuth service and Swagger.io service 27 | try { 28 | RESOURCE_CLASSES.add(Class.forName("org.eclipse.lyo.server.oauth.webapp.services.ConsumersService")); 29 | RESOURCE_CLASSES.add(Class.forName("org.eclipse.lyo.server.oauth.webapp.services.OAuthService")); 30 | RESOURCE_CLASSES.add(io.swagger.jaxrs.listing.ApiListingResource.class); 31 | RESOURCE_CLASSES.add(io.swagger.jaxrs.listing.SwaggerSerializers.class); 32 | } catch (ClassNotFoundException e) { 33 | // TODO Auto-generated catch block 34 | e.printStackTrace(); 35 | } 36 | // TRS service 37 | RESOURCE_CLASSES.add(TrackedResourceSetService.class); 38 | 39 | // trigger Jena init 40 | ModelFactory.createDefaultModel(); 41 | // force plain XML writer 42 | RDFWriterFImpl.alternative(null); 43 | // End of user code 44 | ``` 45 | This add additional services to your Web app in order to support OAuth1.0a. The OAuth classes need to be added using the Class.ForName method instead of through imports because they are defined in a separate, reusable Web application WAR file, not a Java JAR file. 46 | 47 | This dependency in the iotp-adaptor pom.xml file causes the oauth-webapp to be merged with the iotp-adaptor app when the user does a maven install. 48 | ``` 49 |
2 |
9 |
10 |
11 |
12 | # Introduction
13 |
14 | See the [iotp-adaptor User Guide](./userGuide/user-guide) for information on how to install, configure, administer and use the iotp-adaptor OSLC server. This Developer Guide explains how the adaptor was build and integrated with the IBM CE jazz.net applications. The source code is available in a the GitHub [iotp-adaptor Project](https://github.com/OSLC/iotp-adaptor).
15 |
16 | iotp-adaptor was designed and initially created using the [eclipse/Lyo Designer](https://github.com/eclipse/lyo.designer/wiki). This tool using model-based development techniques to generate an OSLC server implementation with a minimal Web UI "debug" application that allows you to browse the OSLC services and adapted resources. The code generator uses [M2T](https://www.eclipse.org/modeling/m2t/) templates that were developed using the eclipse/Lyo [OSLC4J Bugzilla](https://wiki.eclipse.org/Lyo/BuildOSLC4JBugzilla) sample application.
17 |
18 | The Lyo Designer code generator creates an [OSLC Core 2.0](https://archive.open-services.net/bin/view/Main/OslcCoreSpecification) compliant OSLC server. This server is sufficient to explore the adapted resources using OSLC capabilities, but it is not enough to be able to integrate that server with the IBM jazz.net based applications. Additional considerations must be addressed in order to integrate with these applications including:
19 |
20 | * Providing a rootservices document for discovering server discovery capabilities
21 | * Establishing Consumer/Friend relationships using OAuth to allow servers to interact
22 | * Creating project area artifact container associations to enable linking between jazz.net CE tools and OSLC resources provided by adaptors
23 | * What link types are available in each of the applications based on the chosen artifact container association
24 | * Specific integration requirements of each CE application (RDNG, RTC and RQM) that you need to know to get the integrations working
25 | * Creating a TRS provider that can contribute to IBM [RELM](https://www.ibm.com/support/knowledgecenter/en/SS2L6K_6.0.5/com.ibm.team.jp.relm.doc/topics/c_node_product_relm.html) and [LQE](https://www.ibm.com/support/knowledgecenter/en/SS2L6K_6.0.5/com.ibm.team.jp.lqe2.doc/topics/t_lqe_admin.html).
26 |
27 | The iotp-adaptor Developer Guide walks through all of these considerations and provides example solutions. Here's an overview of each of the sections in the Developer Guide:
28 |
29 | * [eclipse environment setup](./environment-setup.html): describes how to setup an eclipse development environment for developing the model and code. Eclipse is required in order to use Lyo Designer, which is an eclipse plug-in.
30 | * [The toolchain model](./toolchain-model.html) - describes the design of the Watson IoT Platform OSLC domain model, and the model of the OSLC services that are provided
31 | * [Generating the server code](./code-generator.html) - explains how to generate the server implementation using the Lyo Designer code generator with additional details for managing embedded user code.
32 | * [Exploring the generated code](./exploring-the-code.html) - looks at the structure of the iotp-adaptor eclipse project, and discusses the key folders and files of the generated application.
33 | * [https and SSL support](./ssl-support.html) - discusses the important topic of secure connections and how to configure the Web application to support SSL, and how to manage self-assigned certificates.
34 | * [Authentication](./authentication.html) - addresses the often sticky problem of end-user login as well as server-to-server connections through OAuth.
35 | * [Creating the rootservices document](./rootservices.html) - Describes how to provide a rootservices document which is required to establish consumer/friend connections between the jazz.net applications (primarily the Jazz Team Server) and the iotp-adaptor.
36 | * [Connecting Servers](./consumer-friend.html) - describes how to create a consumer/friend relationship using OAuth in order to establish server-to-server communications with jazz.net applications
37 | * [Artifact Container Associations](./artifact-container-associations.html) - describes how to configure jazz.net application project areas so they are able to access OSLC services provided by iotp-adaptor
38 | * [Updating generated dialogs](./dialogs.html) - explains how to customize the preview and delegated dialogs created by the Lyo Designer code generator
39 | * [Implementing a Domain Class](./implement-domain-class.html) - summarizes all of the user code that needs to be developed to implement an adaptor domain class, using DeviceType as an example.
40 | * [Implementing a TRS Provider](./trs-provider.html) - provides and overview of the design and implementation of the iotp-adaptor TRS provider
41 | * [JUnit Tests](./junit-tests.html) - describes an example of a typical JUnit test that tests the OSLC CRUD operations of an IoT Platform resource.
42 |
43 | # Resources
44 |
45 | * [OSLC Web Site](https://open-services.net)
46 | * [OSLC Developer Guide](http://oslc.github.io/developing-oslc-applications/)
47 | * [OSLC Primer](https://archive.open-services.net/primer)
48 | * [eclipse/Lyo Project](https://www.eclipse.org/lyo/)
49 | * [Lyo Designer](https://github.com/eclipse/lyo.designer/wiki)
50 | * [OSLC Swagger.io](https://github.com/OSLC/OSLC-API)
51 | * [OSLC GitHub Organization](https://github.com/OSLC)
52 | * [iotp-adaptor Project](https://github.com/OSLC/iotp-adaptor)
53 |
54 | # Call for Contrubtion
55 |
56 | This documentation site is under continuous development as we discover more information about how to develop OSLC clients and servers that integrate with the jazz.net applications. We encourage you to contribute if you find something missing, incorrect, or unclear. You can email suggestions to [Jim Amsden](mailto:jamsden@us.ibm.com).
57 |
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/environment-setup.md:
--------------------------------------------------------------------------------
1 | # Environment Setup
2 |
3 | iotp-adaptor was developed using [eclipse/Lyo Designer](https://github.com/eclipse/lyo.designer/wiki) which is an eclipse plug-in. So you'll need to use eclipse to follow along in this Developer Guide, as well as create your own adpaters using a similar technique.
4 |
5 | This section summarizes how to install and configure eclipse so it is ready to be used for adapter development. It doesn't go into a lot of detail, and assumes some familiarity with eclipse, JEE and git. If you need help on any of these, the Web is full of great tutorials, references and samples that are a quick Google/Bing search away.
6 |
7 | If you run into trouble, you can ask questions on [stackoverflow](https://stackoverflow.com) or the [jazz.net/forum](https://jazz.net/forum).
8 |
9 | ## Installing Eclipse
10 |
11 | Go to the [eclipse.org/downloads](https://www.eclipse.org/downloads/) page and download [Eclipse Eclipse 2020-03](https://www.eclipse.org/downloads/packages/installer) (or later) to access the Eclipse Installer for your platform. Run the Eclipse Installer and install Eclipse IDE for Java EE Developers. The Web app generated by Lyo Designer is a JEE WAR file, so you'll need the plug-ins that are already installed in the Eclipse IDE for Java EE Developers. This includes additional components you'll need:
12 |
13 | * Data Tools Platform
14 | * Git integration for Eclipse
15 | * Eclipse Java Development Tools
16 | * Eclipse Java EE Developer Tools
17 | * JavaScript Development Tools
18 | * Maven Integration for Eclipse
19 | * Mylyn Task List
20 | * Eclipse Plug-in Development Environment
21 | * Code Recommenders Tools for Java Developers
22 | * Eclipse XML Editors and Tools
23 |
24 | Once eclipse is installed, start it up and open the Eclipse Marketplace and add the following additional solutions
25 | Added the following:
26 |
27 | * Install the Eclipse Jetty 5.0.0 or later
28 |
29 | ## Install eclipse/Lyo Designer
30 |
31 | Eclipse/Lyo designer comes in two parts, the Lyo Toolchain editor (which is built on [Sirius](https://www.eclipse.org/sirius/)), and the Lyo Code Generator. These two components are installed using and eclipse install and update site.
32 |
33 | 1. Start eclipse and invoke Help/Install New Software...
34 | 2. Configure an install and update site called Lyo Designer with one of the following update site URLs:
35 | * https://download.eclipse.org/lyo/product/binaries/stable/ - these are the most recent released versions
36 | * https://download.eclipse.org/lyo/product/binaries/edge/ - these are the latest builds from eclipse.org
37 | 3. Install the following features:
38 | * Lyo Toolchain
39 | * Lyo Code Generator
40 |
41 | You'll need to restart eclipse to complete the installation.
42 |
43 | Note: If the About Eclipse menu item, and clicking on the Installation Details button show no installed software, restart with eclipse with the -clean option.
44 |
45 | ## Install Jetty
46 |
47 | You can deploy the WAR file created in the iotp-adaptor/iotp-adaptor eclipse Maven project to any JEE container. However, Jetty is a very convenient container to use for rapid development. Install Jetty from https://www.eclipse.org/jetty/download.html.
48 |
49 | 1. Start eclipse
50 |
51 | After installing, edit your .bash_profile or whatever is appropriate for your platform and set the JETTY_HOME environment variable. For example:
52 |
53 | export JETTY_HOME=~/Applications/jetty-distribution-9.4.5.v20170502
54 |
55 | Next use the Eclipse Marketplace to install Eclipse Jetty if you want to be able to lanuch iotp-adaptor as a Jetty Webapp. Use `src/main/webapp` as the WebApp Folder so that changes made during debugging will be immediately available. Typically use `/iotp` as the Context Path.
56 |
57 | Add the following VM arguments:
58 |
59 | ```
60 | -Diot.platform.base=internetofthings.ibmcloud.com
61 | -Diot.platform.api.version=v0002
62 | -Dlog4j.debug=true
63 | ```
64 |
65 | ## Install git and GitHub Desktop
66 |
67 | [iotp-adaptor](https://github.com/OSLC/iotp-adaptor) is a GitHub project, so you'll need to use git to access the source code. If you're here, you are likely already quite familiar with git. But just in case, here's a few notes to get you started.
68 |
69 | You can use EGit in eclipse, [git](https://git-scm.com/downloads) command line interface, and/or [GitHub Desktop](https://desktop.github.com). These are all efficient, effective ways to use git and each has characteristics that make it useful in different contexts. The [git reference manual](https://git-scm.com/docs) is also a very useful resource if you forget the specifics of a particular git command. There more at the [git documentation site](https://git-scm.com/doc).
70 |
71 |
72 | # Getting the iotp-adaptor Code
73 |
74 | Now that your eclipse platform is all setup, you're ready to clone the iotp-adaptor repository and install the eclipse Maven projects. The following is a brief summary of how to do this:
75 |
76 | 1. Start eclipse
77 | 2. Open the Git perspective
78 | 3. paste the following URI in the Git Repositories view: https://github.com/OSLC/iotp-adaptor.git
79 | 4. Select the iotp-adaptor repository, right click, and invoke Import Maven Projects... to import the iotp-adaptor maven project. Note: if this menu item isn't available, you will need to install the m2e egit connector from the eclipse marketplace. Follow [these instructions](https://stackoverflow.com/questions/4542104/how-do-you-get-git-integration-working-with-m2eclipse).
80 | 5. Select the iotp-awaptor repository again, right click and invoke Import Projects... to import the iotp-adaptor-model project.
81 | 5. Switch to the Java EE perspective
82 | 6. Expand eclipse maven project iotp-adaptor
83 | 7. Select the pom.xml file, right click and invoke Run As > Maven install
84 |
85 | If all goes well, you should have completed the build of iotp-adaptor, and the deployable WAR file will be in target/iotp-0.0.1-SNAPSHOT (or something similar, the version might be different).
86 |
87 | Note, when you load a Maven project (instead of an eclipse project), Maven automatically updates the eclipse project settings from information in the Maven pom.xml file. If you make significant changes to the pom.xml file, you may need to update the eclipse project settings again. To do this, select the iotp-adaptor project, right click, and invoke Maven > Update Project.... This will ensure the eclipse automatic build will use the same settings and dependencies as the Maven commands (e.g., mvn install from the command line or Run As > Maven install from the Project Explorer). This way compilation errors will show up in the Project Explorer and Markers view as you are editing.
88 |
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/Bluemix-Domain.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/Bluemix-Domain.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/CE4IoTConnector.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/CE4IoTConnector.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/CRUD-Operations.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/CRUD-Operations.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/CoreDiscovery.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/CoreDiscovery.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/Creation-Dialogs.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/Creation-Dialogs.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/Creation-Factories.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/Creation-Factories.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/Device-BasicCapability.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/Device-BasicCapability.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/DeviceType-Creation-Factory.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/DeviceType-Creation-Factory.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/Generate-the-code.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/Generate-the-code.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/Generated-project.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/Generated-project.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/IoT-Platform-Domain.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/IoT-Platform-Domain.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/LQE-process-resources.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/LQE-process-resources.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/Project-Dependencies.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/Project-Dependencies.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/Query-Capability.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/Query-Capability.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/Selection-Dialogs.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/Selection-Dialogs.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/images/authenticating-with-oauth.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/_harp/iotp_adaptor/images/authenticating-with-oauth.png
--------------------------------------------------------------------------------
/_harp/iotp_adaptor/junit-tests.md:
--------------------------------------------------------------------------------
1 | # JUnit Tests
2 |
3 | Sample JUnit tests are provided to test the CRUD operations on the IoT Platform DeviceType resource in `com.ibm.oslc.adaptor.tests.iotp-adaptorTests.java`. This can be used as a pattern to develop tests for other resources as they are supported.
4 |
5 |
6 |
7 | There are a few considerations to address in implementing these JUnit test cases that are covered in this section.
8 |
9 | There are also opportunities to introduce other automated tests for the generated Web UI, especially for the creation and selection dialogs, and the small and large preview dialogs. These tests are currently done manually.
10 |
11 | ## OslcClient login
12 |
13 | The OSLC4J OslcClient provides OAuth and Jazz FORM based login, and these are what is supported by the jazz.net apps. But does not directly support pre-emptive login with user credentials which is required by the IBM Watson IoT Platform. There's no constructor `OslcClient(String userId, String password)`. These a straightforward work around demonstrated in the following code fragment (which comes from C4IoTConnectorTests.java). The workaround is to construct a simple OslcClient, and then add an Authorization header that will be included on all requests.
14 |
15 | ```
16 | try {
17 | client = new OslcClient();
18 | // Add a receptor to set the Authorization header as a default
19 | // header for all requests
20 | Header header = new BasicHeader(HttpHeaders.AUTHORIZATION,
21 | "Basic "+Base64.encode((userId+":"+password).getBytes()));
22 | List
3 |
5 | Developing an OSLC adaptor for Watson IoT Platform
4 |
6 | iotp-adapter is an OSLC server that exposes IBM Watson IoT Platform resources as OSLC resources. The Developer Guid explains how this server was developed and integrated with the IBM jazz.net applications.
7 |
8 | ><%= video %>
'
55 | );
56 |
57 | // Filter out .no-resize videos
58 | videos = _.reject(videos, function (vid) {
59 | return vid.classList.contains("no-resize");
60 | });
61 |
62 | _.each(videos, function (vid) {
63 | var data = {
64 | style:
65 | 'style="padding-bottom: ' + (vid.height / vid.width) * 100 + '%;"',
66 | video: vid.outerHTML,
67 | };
68 |
69 | // Replace the videos HTML with the new template
70 | vid.outerHTML = fluidVidTemplate(data);
71 | });
72 | },
73 | };
74 |
75 | var polyfills = ["classlist"];
76 | var libraries = ["underscore", "$", "delegate"];
77 | var load = [];
78 |
79 | polyfills.forEach(function (test) {
80 | Modernizr[test] ||
81 | load.push(window.site_url + "js/lib/polyfills/" + test + ".js");
82 | });
83 |
84 | libraries.forEach(function (lib) {
85 | load.push(window.site_url + "js/lib/" + lib + ".js");
86 | });
87 |
88 | Modernizr.load({
89 | load: load,
90 | // must .bind to own object, as this will get called in the window context
91 | complete: OSLC.init.bind(OSLC),
92 | });
93 | }
94 |
95 | // http://blog.parkermoore.de/2014/08/01/header-anchor-links-in-vanilla-javascript-for-github-pages-and-jekyll/
96 | var anchorForId = function (id) {
97 | var anchor = document.createElement("a");
98 | anchor.className = "header-link";
99 | anchor.href = "#" + id;
100 | anchor.innerHTML = '';
101 | return anchor;
102 | };
103 |
104 | // https://gist.github.com/codeguy/6684588
105 | var slugify = function (string) {
106 | const a =
107 | "àáâäæãåāăąçćčđďèéêëēėęěğǵḧîïíīįìłḿñńǹňôöòóœøōõőṕŕřßśšşșťțûüùúūǘůűųẃẍÿýžźż·/_,:;";
108 | const b =
109 | "aaaaaaaaaacccddeeeeeeeegghiiiiiilmnnnnoooooooooprrsssssttuuuuuuuuuwxyyzzz------";
110 | const p = new RegExp(a.split("").join("|"), "g");
111 |
112 | return string
113 | .toString()
114 | .toLowerCase()
115 | .replace(/\s+/g, "-") // Replace spaces with -
116 | .replace(p, (c) => b.charAt(a.indexOf(c))) // Replace special characters
117 | .replace(/&/g, "-and-") // Replace & with 'and'
118 | .replace(/[^\w\-]+/g, "") // Remove all non-word characters
119 | .replace(/\-\-+/g, "-") // Replace multiple - with single -
120 | .replace(/^-+/, "") // Trim - from start of text
121 | .replace(/-+$/, ""); // Trim - from end of text
122 | };
123 |
124 | var linkifyAnchors = function (level, containingElement) {
125 | var headers = containingElement.getElementsByTagName("h" + level);
126 | for (var h = 0; h < headers.length; h++) {
127 | var header = headers[h];
128 |
129 | if (typeof header.id == "undefined" || header.id == "") {
130 | header.id = slugify(header.innerText);
131 | }
132 | header.appendChild(anchorForId(header.id));
133 | }
134 | };
135 |
136 | document.onreadystatechange = function () {
137 | if (this.readyState === "complete") {
138 | var contentBlock = document.getElementsByClassName("copy")[0];
139 | if (!contentBlock) {
140 | return;
141 | }
142 | for (var level = 1; level <= 6; level++) {
143 | linkifyAnchors(level, contentBlock);
144 | }
145 | }
146 | };
147 |
--------------------------------------------------------------------------------
/_harp/oslc-open-source-node-projects.md:
--------------------------------------------------------------------------------
1 | Eclipse/Lyo provides a set of Java based APIs and generative tools to support the creation of OSLC domain servers and integrated client applications. While Eclipse/Lyo provides a very rich and robust platfrom for OSLC development, it has a relatively high learning curve and that can increase development time, costs and risks.
2 |
3 | OSLC4JS represents a set of related Open Source projects supporting the creation and integration of OSLC based client and server applications that leverage the dynamic and asynchronous capabilities of JavaScript and Node.js. The LDP Service and OSLC Service projects provide Express.js middleware components that can be used to add LDP and/or OSLC services to any Express Web application. The OSLC Browser and OSLC Server projects use these services to create sample OSLC client and server apps that can easily and dynamically adapted to any OSLC domain, extensions to domains, and/or integrations between domains.
4 |
5 | OSLC4JS's goal is to minimize the cost of developing the OSLC specifications, reference implementation and test suites. The OASIS OSLC specifications would also benefit from a reference implementation in dynamic language such as JavaScript.
6 |
7 | ## The OSLC4JS Projects
8 |
9 | The following sections provide a brief description of each OSLC4JS sub-project and provide links to the development sites and related work products. The figure below shows the relationship between the modules created in the projects, and how they are assembled into a Web application.
10 |
11 | 
12 |
13 | Adapter middleware in the figure represents some Express.js middleware component that provides CRUD access to some existing data source. This provides a simple way for vendors to provide OSLC access to their data sources without having to implement the details of OSLC and/or LDP.
14 |
15 | A [oslc4js Slack Channel](https://openintegrations.slack.com/archives/oslc4js) has been created to facilitate collaborative development of these Open Source Projects. Documentation and collaboration will be capture in the GitHub Wikis for each of the repositories. GitHub issues will be used to manage the development work.
16 |
17 | Project | Description | More information
18 | ------- | ----------- | ----------------
19 | [OSLC Browser](https://github.com/OSLC/oslc-browser) | A sample OSLC Web application that uses the OSLC Service to provide a means of browsing OSLC resources. OSLC Browser allows you to configure a connection pool of contributing OSLC servers, and provides a convenient means of browsing the content contributed by those servers. The federation of thigs information is supported by the OSLC service with can also support OSLC domains, extension to domains, integration between domains. This allows the OSLC Browser to act as a federation hub for OSLC resources where stakeholder viewpoints, views (i.e., active dashboards) can be created to support integration needs. | [Mural Design](https://app.mural.ly/t/ibm14/m/ibm14/1452806819730)[Wiki](https://github.com/OSLC/oslc-browser/wiki) 20 | [OSLC Client API](https://github.com/OSLC/oslc-client) | A simple Node.js asynchronous OSLC client API to facilitate rich application development in JavaScript. This API may be attractive to client developers who wish to access OSLC capabilities and resources through a more logical API abstraction rather than more raw REST services. | [Wiki](https://github.com/OSLC/oslc-client/wiki)
npm package 21 | [OSLC Service](https://github.com/OSLC/oslc-service) | A generic Node.js Express middleware OSLC 3.0 service that can support any domain and can be easily adapted to any applicable data source. This services also utilizes the LDP Service. | [ Wiki](https://github.com/OSLC/oslc-service/wiki)
npm package 22 | [OSLC Server](https://github.com/OSLC/oslc-server) | A minimal OSLC server that uses the oslc-service and ldp-service and can be accessed using a browser REST client. An instance of this server is deployed to IBM Bluemix in order to provide a platform for OSLC experimentation and testing. | [Wiki](https://github.com/OSLC/oslc-server/wiki) 23 | [LDP App](https://github.com/OSLC/ldp-app) | A sample [Linked Data Platform](https://www.w3.org/TR/2015/REC-ldp-20150226/) (LDP) Web application that uses the LDP Service and supports CRUD operations and a graph of linked data. | [Wiki](https://github.com/OSLC/ldp-app/wiki) 24 | [LDP Service](https://github.com/OSLC/ldp-service) | Express middleware providing LDP capabilities to Web apps, with storage of JSON-DL in MongoDB. | [Wiki](https://github.com/OSLC/ldp-service/wiki)
[npm package](https://www.npmjs.com/package/ldp-service) 25 | -------------------------------------------------------------------------------- /_harp/sample-applications-and-code.md: -------------------------------------------------------------------------------- 1 | ## Sample applications 2 | 3 | Having done the [tutorials](./tutorials), if you'd like to explore some existing code, there are a variety of samples and existing applications available to be inspired from. 4 | 5 | * [OSLC 2020 Reference Implementation](https://github.com/oslc-op/refimpl) 6 | * The [iotp-adaptor](./iotp-adaptor-sample) is an OSLC adapter for IBM Watson IoT Platform. This sample provides a thourough user guide, as well as a developer guide covering many topics such as authentication, TRS, using [Lyo Designer](./eclipse_lyo/eclipse-lyo#lyo-designer), etc. 7 | * [Lyo Client sample code](https://github.com/OSLC/lyo-samples) - A Github repository that includes sample code to demonstrates how to use the oslc4j-client in Lyo SDK to interact with OSLC Service Providers in various ways. It addresses a variety of common OSLC use cases including login, OAuth, service discovery, and queries. See the [README.md](https://github.com/OSLC/lyo-samples/blob/master/README.md) file in the repository for further pointers. 8 | * [JIRA OSLC Plugin](https://github.com/Ericsson/jira-oslc-plugin) - is a Lyo-based implementation of an OSLC Server and Client, realized as an OSGI (JIRA) plugin. 9 | * [Hansoft OSLC Adaptor](https://github.com/Ericsson/hansoft-oslc-adapter) - is a Lyo-based implementation of an OSLC adaptor for the product planning tool Hansoft. 10 | * [SharePoint](https://wiki.eclipse.org/Lyo/SharepointAdapter) - 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. 11 | * The [Hudson and Jenkins](https://wiki.eclipse.org/Lyo/JenkinsPlugin) adapor implements the OSLC Automation specification. 12 | * [Simulink](https://wiki.eclipse.org/Lyo/Simulink) 13 | * [MagicDraw](https://wiki.eclipse.org/Lyo/MagicDraw) 14 | * The [Lyo LDP reference implementation](https://wiki.eclipse.org/Lyo/BuildLDPSample) - is a sample Java implementation of the W3C Linked Data Platform 1.0 Candidate Recommendation using JAX-RS (Apache CXF) and Jena TDB. 15 | 16 | 17 | 18 | * The Communications Workgroup has [a list of **Open Source OSLC projects**](https://archive.open-services.net/wiki/communications/Open-source-software-and-tools/) (along with their licenses). 19 | * If you'd like to explore a basic application that provides OSLC Service Provider resources and UI previews, Vijay Kalangumvathakkal of developerWorks [has some simple applications available to download and try out](https://www.ibm.com/developerworks/mydeveloperworks/blogs/69ec672c-dd6b-443d-add8-bb9a9a490eba/entry/build_your_own_serviceprovider_that_provides_resource_preview_based_on_oslc_specifications_in_no_time4?lang=en). 20 | 21 | The [OSLC4Net](https://github.com/OSLC/oslc4net) project includes sample applications if you favor .NET/C#. 22 | -------------------------------------------------------------------------------- /_harp/services-resources-and-design-patterns.md: -------------------------------------------------------------------------------- 1 | The [OSLC Core specification](https://archive.open-services.net/bin/view/Main/OslcCoreSpecification) defines the basic patterns and protocols that any OSLC software must implement. The other workgroups define additional resources or extend existing ones, but they do not add new protocols. 2 | 3 | Here are the major resources defined in the [OSLC Core specification](https://archive.open-services.net/bin/view/Main/OslcCoreSpecification): 4 | 5 | | Resource or Pattern | Description | More information | 6 | | ------------------- | ----------- | ---------------- | 7 | | Service Provider | A resource that describes a collection of resources and tells you how to create new resources, find existing resources, or expose a user interface to do either | [OSLC Primer: Service Provider](https://open-services.net/resources/oslc-primer/#serviceprovider) | 8 | | Resource Paging | A pattern to break long lists of resources into smaller pages, and provide a URL for the next page | [OSLC Primer: Resource Paging](https://open-services.net/resources/oslc-primer/#resource-paging) | 9 | | Queries | Standard query string patterns to retrieve a subset of resources or properties | [OSLC Primer: Query mechanisms](https://open-services.net/resources/oslc-primer/#query-mechanisms) | 10 | | Resource Shapes | Documents that define and describe the properties a resources should have, including acceptable values, cardinality, and whether or not those properties are required | [OSLC Primer: Resource Shapes](https://open-services.net/resources/oslc-primer/#resourceshapes) | 11 | | Creation Factory | A service that creates new resources and (via HTTP `POST`) and may also provide the Resource Shape for new resources | [Core 2.0: Creation Factories](https://archive.open-services.net/bin/view/Main/OslcCoreSpecification#Creation_Factories) 12 | | Service Provider Catalog | A resources that lists a set of ServiceProviders | [OSLC Primer: ServiceProvider](https://open-services.net/resources/oslc-primer/#serviceprovider) | 13 | | Delegated User Interface (UI) dialogs | A method for embedding an interface to create or find resources inside another tool | [OSLC Primer: Delegated UI dialogs](https://open-services.net/resources/oslc-primer/#delegated-user-interface-dialogs) | 14 | | UI Previews | A method for discovering and displaying a preview of a resource in another tool | [OSLC Primer: UI Preview](https://open-services.net/resources/oslc-primer/#ui-preview) | 15 | 16 | 17 | To explore some of our other specifications, the OSLC Core Workgroup maintains [a list of OSLC vocabularies and specifications](https://archive.open-services.net/wiki/core/Vocabulary-index/) that includes relationship diagrams. 18 | -------------------------------------------------------------------------------- /_harp/technical-foundations.md: -------------------------------------------------------------------------------- 1 | To build software that supports OSLC, you should be familiar with the following concepts: 2 | 3 | ### Linked data 4 | 5 | [Linked data](http://www.w3.org/DesignIssues/LinkedData.html) is the main technical foundation of all of our specifications. The video below provides a brief overview of the value of linked data and how we implement it with OSLC: 6 | 7 | 8 | 9 | If you're new to linked data and RDF, we've put together [a playlist of videos](https://archive.open-services.net/resources/videos/linked-data-and-rdf-overview-playlist/) that can help you catch up. 10 | 11 | 12 | ### RESTful web architecture and HTTP 13 | 14 | You should be familiar with designing [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer#Architectural_constraints) applications. 15 | 16 | For a quick primer, we recommend [“Learn REST” by Dr. M. Elkstein](http://rest.elkstein.org/), particularly these sections: 17 | 18 | 1. [What is REST?](http://rest.elkstein.org/2008/02/what-is-rest.html) 19 | 2. [REST as Lightweight Web Services](http://rest.elkstein.org/2008/02/rest-as-lightweight-web-services.html) 20 | 3. [How Simple is REST?](http://rest.elkstein.org/2008/02/how-simple-is-rest.html) 21 | 4. [More Complex REST Requests](http://rest.elkstein.org/2008/02/more-complex-rest-requests.html) 22 | 5. [REST Server Responses](http://rest.elkstein.org/2008/02/rest-server-responses.html) 23 | 24 | For OSLC implementations, you must use [HTTP protocol](http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol). 25 | 26 | 27 | ### RDF, Turtle, JSON, and HTML 28 | 29 | We require services and resources to be represented in [**RDF**](http://www.w3.org/RDF/), but you might prefer to supplement that with a variety of machine-readable and human-readable formats like Turtle, JSON, or HTML. 30 | 31 | Instead of string parsing and regular expressions, you will definitely want to explore using an RDF parser such as [Apache Jena](http://jena.apache.org/). 32 | 33 | 34 | ### OAuth 35 | 36 | OSLC does not require OAuth, but it is the most common approach for managing authentication between clients. 37 | -------------------------------------------------------------------------------- /_harp/tutorials.md: -------------------------------------------------------------------------------- 1 | ## Tutorials 2 | 3 | 1. The [walkthrough tutorial](integrating_products_with_oslc) walks you through a working adapter that adds OSLC Change Management support to Bugzilla and a simple consumer application. You will work with a fully developed adapter, with no need to code. 4 | 5 | 1. The [hands-on tutorial](https://github.com/eclipse/lyo.docs/blob/master/lyo-rest-workshop/Lyo_OSLC_Workshop.pdf) takes you through the incremental programming steps to enable Bugzilla as an OSLC-CM service provider. 6 | -------------------------------------------------------------------------------- /_harp/why-develop-oslc-applications.md: -------------------------------------------------------------------------------- 1 | Integrating software is hard; we want it to be easier. And we need your help. 2 | 3 | [We define standardized ways](https://open-services.net/specifications/) to represent common resources in software development (for example, a defect or a performance test). We also define standardized methods to allow other applications to access, display, preview, find, create, and update those resources. 4 | 5 | With standardized resources and methods, any tool can access and manipulate the data and artifacts from any other compliant tool. So instead of a variety of fragile point-to-point integrations you have **one common way to connect and integrate [many products](https://archive.open-services.net/software/)**. It's not quite plug-and-play, but it's close. 6 | 7 | **We want OSLC to succeed because better and easier integrations will save everyone time and money**. And we think that software with OSLC integration has a competitive advantage. 8 | 9 | Don't just take our word for it. [Icaro Technologies](https://archive.open-services.net/resources/presentations/reducing-system-integration-costs-with-oslc-and-data-federation/) estimated that they could have saved *two million dollars* over two years if they used OSLC standards for a project with more than 10 integrations. And major industry groups like [SPRINT](http://www.sprint-iot.eu/) and [EADS (Airbus)](https://www.airbus.com/en/what-we-do/protect) have decided that OSLC-compliant software can help them collaborate and verify requirements [on highly complex products like commercial airplanes](https://archive.open-services.net/resources/videos/concurrent-engineering-for-systems-based-on-oslc). 10 | 11 | OSLC specifications are *free to adopt*, and we want them to spread. So help us out! 12 | -------------------------------------------------------------------------------- /docs/.nojekyll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OSLC/developing-oslc-applications/0f0a0e3442112b3f61f6b15acdca9e9c117361ba/docs/.nojekyll -------------------------------------------------------------------------------- /docs/404.html: -------------------------------------------------------------------------------- 1 |
><%= video %>
'
55 | );
56 |
57 | // Filter out .no-resize videos
58 | videos = _.reject(videos, function (vid) {
59 | return vid.classList.contains("no-resize");
60 | });
61 |
62 | _.each(videos, function (vid) {
63 | var data = {
64 | style:
65 | 'style="padding-bottom: ' + (vid.height / vid.width) * 100 + '%;"',
66 | video: vid.outerHTML,
67 | };
68 |
69 | // Replace the videos HTML with the new template
70 | vid.outerHTML = fluidVidTemplate(data);
71 | });
72 | },
73 | };
74 |
75 | var polyfills = ["classlist"];
76 | var libraries = ["underscore", "$", "delegate"];
77 | var load = [];
78 |
79 | polyfills.forEach(function (test) {
80 | Modernizr[test] ||
81 | load.push(window.site_url + "js/lib/polyfills/" + test + ".js");
82 | });
83 |
84 | libraries.forEach(function (lib) {
85 | load.push(window.site_url + "js/lib/" + lib + ".js");
86 | });
87 |
88 | Modernizr.load({
89 | load: load,
90 | // must .bind to own object, as this will get called in the window context
91 | complete: OSLC.init.bind(OSLC),
92 | });
93 | }
94 |
95 | // http://blog.parkermoore.de/2014/08/01/header-anchor-links-in-vanilla-javascript-for-github-pages-and-jekyll/
96 | var anchorForId = function (id) {
97 | var anchor = document.createElement("a");
98 | anchor.className = "header-link";
99 | anchor.href = "#" + id;
100 | anchor.innerHTML = '';
101 | return anchor;
102 | };
103 |
104 | // https://gist.github.com/codeguy/6684588
105 | var slugify = function (string) {
106 | const a =
107 | "àáâäæãåāăąçćčđďèéêëēėęěğǵḧîïíīįìłḿñńǹňôöòóœøōõőṕŕřßśšşșťțûüùúūǘůűųẃẍÿýžźż·/_,:;";
108 | const b =
109 | "aaaaaaaaaacccddeeeeeeeegghiiiiiilmnnnnoooooooooprrsssssttuuuuuuuuuwxyyzzz------";
110 | const p = new RegExp(a.split("").join("|"), "g");
111 |
112 | return string
113 | .toString()
114 | .toLowerCase()
115 | .replace(/\s+/g, "-") // Replace spaces with -
116 | .replace(p, (c) => b.charAt(a.indexOf(c))) // Replace special characters
117 | .replace(/&/g, "-and-") // Replace & with 'and'
118 | .replace(/[^\w\-]+/g, "") // Remove all non-word characters
119 | .replace(/\-\-+/g, "-") // Replace multiple - with single -
120 | .replace(/^-+/, "") // Trim - from start of text
121 | .replace(/-+$/, ""); // Trim - from end of text
122 | };
123 |
124 | var linkifyAnchors = function (level, containingElement) {
125 | var headers = containingElement.getElementsByTagName("h" + level);
126 | for (var h = 0; h < headers.length; h++) {
127 | var header = headers[h];
128 |
129 | if (typeof header.id == "undefined" || header.id == "") {
130 | header.id = slugify(header.innerText);
131 | }
132 | header.appendChild(anchorForId(header.id));
133 | }
134 | };
135 |
136 | document.onreadystatechange = function () {
137 | if (this.readyState === "complete") {
138 | var contentBlock = document.getElementsByClassName("copy")[0];
139 | if (!contentBlock) {
140 | return;
141 | }
142 | for (var level = 1; level <= 6; level++) {
143 | linkifyAnchors(level, contentBlock);
144 | }
145 | }
146 | };
147 |
--------------------------------------------------------------------------------
/docs/technical-foundations.html:
--------------------------------------------------------------------------------
1 |