RESTFul IDEAS

RESTful IDEAS: Integrated Documentation Environment for Aircraft Support‏ Originally presented at the XML 2007 Conference by: Joel Amoussou, Founder & CEO, Efasoft [email_address]

Agenda Security 5 IDEAS Use Cases 1 S1000D 2 AtomPub and OpenSearch 3 Getting Started 4

How Information is Distributed Today?

Shipping of Physical Products

Paper, CD-ROM, DVD

Four revisions a year

Temporary Revisions

Online Access

Hosted by manufacturers

Boeing MPT

Airbus|World

Current Digital File Formats S1000D Military Specifications (CALS)‏ ATA iSpec 2200 PDF and Proprietary Formats S1000D

Beyond S1000D: IDEAS IDEAS AtomPub OpenSearch Syndication Federated Search Ex- change Library Services

Maintenance and Flight Operations Airframe Manufacturer Engine Manufacturer Component Manufacturer FAA/Transport Canada Airline Policies & Procedures Feeds Reader Aggregator OpenSearch Client

Distributed Aircraft Manufacturing AtomPub Server Airframer (Systems Integrator)‏ AtomPub Client Partner/Supplier Create content with HTTP POST Get content with HTTP GET Update content with HTTP PUT Delete content with HTTP DELETE

Airline Originated Changes AtomPub Server Airframer/FAA/Suppliers AtomPub Client Airline's Content Repository Create content with HTTP POST Get content with HTTP GET Update content with HTTP PUT Delete content with HTTP DELETE

Syndication-Oriented Architecture (SynOA)‏

ROA and SynOA

REST

Atom

AtomPub

OpenSearch

SOA

XML Schema

SOAP

WSDL

UDDI

WS-*

Web Services

What is S1000D? ASD, AIA, and ATA Military and Civil Aviation Open standards (RDF, Dublin Core, XLink, WebCGM, XML Schema)‏ Common Source DataBase (CSDB) and Reuse Metadata Data Module S1000D

S1000D Data Module Identification and Status (data module code, applicability, issue number, etc.)‏ Content (actual maintenance or operation procedure)‏

Sample S1000D Data Module Metadata <dmodule xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:dc="http://www.purl.org/dc/elements/1.1/"> <rdf:Description> <dc:title>Hydraulic Tank - Clean by ultrasonic</dc:title> <dc:creator>U8234</dc:creator> <dc:subject>Hydraulic Tank - Clean by ultrasonic </dc:subject> <dc:publisher>U8234</dc:publisher> <dc:contributor>U8234</dc:contributor> <dc:date>2007-07-31</dc:date> <dc:type>text</dc:type> <dc:format>text/xml</dc:format> <dc:identifier>8H-A-29-10-05-01A-253B-C</dc:identifier> <dc:language>en-GB</dc:language> <dc:rights>01</dc:rights> </rdf:Description> ... </dmodule>

Sample S1000D Data Module Content <mainfunc> <step1> <para>Clean by ultrasonic.</para> <step2> <para>Press ON to start.</para> </step2> <step2> <para>Monitor the cleaner during operation.<para> </step2> <step2> <para> The cleaner will stop automatically after running for the specified time. <para> </step2> </step1> <mainfunc>

Data Module Code

8H: Model Identification Code

A: System Difference Code

29: System (Hydraulic Power)‏

10: Subsystem (Main Hydraulic Power)‏

05: Unit or Component (Hydraulic Tank)‏

01: Disassembly Code (first assembly removed from the tank)‏

A: Disassembly Code Variant

253: Information Code (clean by ultrasonic with equipment X)‏

B: Information Code Variant (clean by ultrasonic with equipment Y)‏

C: Item Location Code (C = Maintenance on the bench)‏

8H-A-29-10-05-01A-253B-C

S1000D Publication Module (PM)‏ DM Reference DM Reference DM Reference DM Reference DM Reference

S1000D Information Life Cycle DMRL Presentation CSDB Common Source Database Browser-based Interactive Electronic Technical Publication (IETP)‏ Data Modules Requirement List

Sample Atom Feed for S1000D CSDB

<?xml version="1.0" encoding="utf-8"?>

<feed xmlns="http://www.w3.org/2005/Atom">

<title>Example S1000D Feed</title>

<link rel="self" type="application/atom+xml"

href="http://xyz-aero.com/csdb/feed.atom"/>

<updated>2007-11-20T19:30:02Z</updated>

<author>

<name>XYZ Aero</name>

</author>

<id>http://xyz-aero.com/csdb</id>

<entry>

<title>Hydraulic Tank - Clean by ultrasonic with equipment X</title>

<link rel="enclosure" type="image/png" length="1337"

href="http://xyz-aero.com/csdb/illustration/icn.png"/>

<id>http://xyz-aero.com/csdb/dm/DMC-8H-A-29-10-05-01A-253A-C</id>

<content

src="http://xyz-aero.com/csdb/dm/DMC-8H-A-29-10-05-01A-253A-C.xml" type="text/xml"/>

<summary>

Hydraulic Tank – Clean by ultrasonic with equipment X

</summary>

</entry>

...

</feed>

AtomPub Service Document for a CSDB

<?xml version="1.0" encoding="utf-8"?>

<service xmlns="http://www.w3.org/2007/app" xmlns:atom="http://www.w3.org/2005/Atom">

<workspace>

<atom:title>S1000D CSDB</atom:title>

<collection href="http://xyz-aero.com/csdb/dm" >

<atom:title>S1000D Data Modules<title>

<categories href="http://www.s1000d.org/cats/dm.cats" />

</collection>

<collection href="http://xyz-aero.com/csdb/illustration" >

<atom:title>S1000D Illustrations</atom:title>

<accept>image/png</accept>

<accept>image/jpeg</accept>

<accept>image/gif</accept>

<accept>image/tif</accept>

<accept>image/cg4</accept>

<accept>image/cgm</accept>

</collection>

</workspace>

</service

Listing Atom Collection

<feed xmlns="http://www.w3.org/2005/Atom">

<link rel="first"

href="http://xyz-aero.com/csdb/dm/amm" />

<link rel="next"

href="http://xyz-aero.com/csdb/dm/fim" />

<link rel="last"

href="http://xyz-aero.com/csdb/dm/aipc" />

...

</feed>

Posting a Data Module to an Atom Server

POST /csdb/dm HTTP/1.1

Host: xyz-aero.com

Authorization: XYZAeroLogin auth={auth token}

Content-Type: application/atom+xml;type=entry

Content-Length: nnn

Slug: First Post

<?xml version="1.0" ?>

<entry xmlns="http://www.w3.org/2005/Atom">

<author>

<name>XYZ Aero</name>

</author>

<content type="text/xml">

<dmodule>..</dmodule>

</content>

<summary>

</summary>

</entry>

Data Module Created by an Atom Server

HTTP/1.1 201 Created

Date: Sun, 11 Nov 2007 19:01:11 GMT

Content-Length: nnn

Content-Type: application/atom+xml;type=entry;charset="utf-8"

Location: http://xyz-aero.com/csdb/dm/DMC-8H-A-29-10-05-01A-253A-C.atom

ETag: "cj373d8762369g"

<?xml version="1.0" ?>

<entry xmlns="http://www.w3.org/2005/Atom">

<author>

<name>Aero Tanks</name>

</author>

<content type="text/xml">

<dmodule>..</dmodule>

</content>

<summary>

</summary>

</entry>

OpenSearch Description Document

<?xml version="1.0" encoding="UTF-8"?>

<OpenSearchDescription

xmlns="http://a9.com/-/spec/opensearch/1.1/">

<ShortName>FAA's ADs Search</ShortName>

<Description>

Use to search FAA airworthiness directives.

</Description>

<Tags>airworthiness directives</Tags>

<Contact>opensearch.admin@faa.gov</Contact>

<Url type="application/atom+xml"

template="http://faa.gov/ads/

?q={searchTerms}&p={startPage?}&format=atom "/>

</OpenSearchDescription>

OpenSearch Atom Search Result

<feed xmlns="http://www.w3.org/2005/Atom"

xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">

<title>FAA ADs Search: hydraulic tank</title>

<id>http://faa.gov/ads/hydraulic+tank</id>

<opensearch:totalResults>1</opensearch:totalResults>

<opensearch:startIndex>1</opensearch:startIndex>

<opensearch:itemsPerPage>20</opensearch:itemsPerPage>

<opensearch:Query role="request" searchTerms="hydraulic tank" startPage="1" />

<link rel="alternate"

href="http://faa.gov/ads/hydraulic+tank?p=1" type="text/html"/>

<link rel="self"

href="http://faa.gov/ads/hydraulic+tank?p=1&format=atom" type="application/atom+xml"/>

<link rel="search" type="application/opensearchdescription+xml" href="http://faa.gov/ads/opensearchdescription.xml"/>

<entry>... </entry>

</feed>

Getting Started IETP Benefits

Integrate feeds reader

Add OpenSearch provider to browser

Configure feeds aggregator

Users search multiple repositories

Users subscribe to feeds

Up-to-date content is always available

CSDB

Generate and serve Atom feeds from your CSDB (XSLT, Abdera)‏

Turn your search engine into an OpenSearch provider

S1000D Publication Module (PM)‏

<pm xmlns:xlink="http://www.w3.org/1999/xlink">

<idstatus>...</idstatus>

<content>

<pmentry>

<title>

Hydraulic Tank - Clean by ultrasonic with equipment X

</title>

<refdm>

<xlink:locator xlink:label="Clean" xlink:href="DMC-8H-A-29-10-05-01A-253A-C.xml"/>

</refdm>

</pmentry>

<pmentry>

<title>

Hydraulic Tank - Clean by ultrasonic with equipment Y

</title>

<refdm>

<xlink:locator xlink:label="Clean" xlink:href="DMC-8H-A-29-10-05-01A-253B-C.xml"/>

</refdm>

</pmentry>

</content>

</pm>

From S1000D PM to Atom Feed with XSLT

<xsl:for-each select="s:pmentry">

<xsl:variable name="dmc" select="s:refdm/xlink:locator/@xlink:href"/>

<entry>

<title><xsl:value-of select="s:title"/></title>

<id>

<xsl:value-of select="concat

('http://xyz-aero.com/csdb/dm/',

substring-before($dmc, '.'))"/>

</id>

<updated>

<xsl:value-of select="current-dateTime()"/>

</updated>

<content src="{$dmc}" type="text/xml"/>

<summary>

<xsl:value-of select="s:title"/>

</summary>

</entry>

</xsl:for-each>

Posting to an Atom Server with Abdera

String csdb = "http://xyz-aero.com/csdb";

...

Document<Service> serviceDoc = client.get(csdb).getDocument();

Service service = serviceDoc.getRoot();

Collection collection =

service.getWorkspaces().get(0)‏

.getCollections().get(0);

String uri = collection.getHref().toString();

Response response = client. post (uri, entry);

if (response.getStatus() == 201)

System.out.println("Data module successfully uploaded!");

else

System.out.println("Data module upload failed!");

AtomPub Security SSL HTTP Authentication WSSE XML Signature /Encryption Others Security

Signing an Atom Feed with Apache Abdera

Abdera abdera = new Abdera();

AbderaSecurity abderaSecurity = new AbderaSecurity(abdera);

URL url = new

URL("http://xyz-aero.com/csdb/DMC-8H-A-29-10-05-01A-253A-C.atom");

Document<Feed> doc = parser.parse(url.openStream(),url);

Feed feed = doc.getRoot();

PrivateKey privateKey = ...

X509Certificate certificate = ...

Signature signature = abderaSecurity.getNewSignature();

SignatureOptions options = signature.getDefaultSignatureOptions();

options.setSigningKey(privateKey);

options.setCertificate(certificate);

feed = signature. sign (feed, options);

Verifying a Signature with Apache Abdera

ByteArrayInputStream feed = ...

Document<Entry> doc = abdera.getParser().parse(feed);

entry = doc.getRoot();

System.out.println("Valid signature?: " + signature. verify (entry, null));

Standardization with CMIS 1 AtomPub and SOAP bindings Not all deployed CMS will support CMIS. 2 Vanilla AtomPub client and server can be implemented easily with existing tools (e.g. Apache Abdera). 3 Interoperability issues between Vanilla AtomPub client and CMIS AtomPub server.

Thank You ! [email_address]