s-ramp message

Subject: Re: [s-ramp] atom bind question - 'artifact' and 'content'

From: Martin Smithson <MSMITHS@uk.ibm.com>
To: kstam@redhat.com
Date: Thu, 3 May 2012 07:50:04 +0100

Hi Kurt,

The rationale for this was that we wanted to make use of the "Media Resource" and "Media Link Entry" concepts that are introduced in the section 9.6 of the Atom Publishing Protocol specification. Example 2 is an example of a Media Link Entry (an entry used to encapsulate metadata about a Media Resource) because it has a content element with a src attribute that points at the Media Resource. As a consequence of this decision, we are unable to make use of the content element for any Media Link Entry that we wish to use in S-RAMP, since section 4.1.3.2, The "src" Attribute, of the Atom Syndication Format specification states that:

If the "src" attribute is present, atom:content MUST be empty.

Rather then make use of foreign markup sections for Media Resources/Media Link Entries and the content element for other types of entry document, it was decided to use foreign markup sections throughout for simplicity/consistency.

I hope that this explains the decision. Please let me know if you have any futher questions.

Thanks.

------------------------------------------------------------------------------
Martin Smithson External Phone: +44 (1962) 817293
Architect Internal Phone: 247293
WebSphere Service Registry & Repository Mobex: 37270676
IBM United Kingdom Ltd Mobile: +44 7734 325082
Hursley Park, Hampshire, SO21 2JN E-Mail: msmiths@uk.ibm.com

From: Kurt T Stam <kstam@redhat.com>
To: "s-ramp@lists.oasis-open.org" <s-ramp@lists.oasis-open.org>
Date: 03/05/2012 02:46
Subject: [s-ramp] atom bind question - 'artifact' and 'content'
Sent by: <s-ramp@lists.oasis-open.org>

Only the complete Atom entry representation also contains a foreign markup section describing a structured extension element called s-ramp:artifact. This extension contains a complete S-RAMP XSD schema compliant instance document representing the S-RAMP artifact object.

In atom bind document, example 2 we specify the 'Full Artifact Entry':

<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="”http://www.w3.org/2005/Atom”" xmlns:s-ramp="”http://s-ramp.org/xmlns/2010/s-ramp”"
xmlns:xlink="http://www.w3.org/1999/xlink">
<id>urn:uuid:aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6a</id>
<updated>2009-05-26T13:13:55.013+02:00</updated>
<title type="“text”">accountingTypes.xsd</title>
<published>2009-05-26T13:13:55.013+02:00</published>
<author>
<name>Bellwood</name>
</author>
<contributor>
<name>Pospisil</name>
</contributor>
<summary type="text">accountingTypes.xsd schema document</summary>
<content type="application/xml;charset=utf-8"
src="">http://example.org/s-ramp/xsd/XsdDocument/
aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6a/media" />
<link type="application/atom+xml;type=entry" rel="self"
href="">http://example.org/s-ramp/xsd/XsdDocument/
aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6a”/>
<link type="
application="application" / atom="atom" + xml="xml" ; type="entry" "
rel="edit-media"
href="">http://example.org/s-ramp/xsd/XsdDocument/
aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6a/media" />
<link type="application/atom+xml;type=entry" rel="edit"
href="">http://example.org/s-ramp/xsd/XsdDocument/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6a” />;
<category term="XsdDocument="XsdDocument" " label="XML Schema"
scheme="urn:x-s-ramp:2010:type” />
<s-ramp:artifact xsi:schemaLocation="
http:="http:" / s-ramp.org="s-ramp.org" / xmlns="xmlns" / s-ramp="s-ramp"
http:="http:" / s-ramp.org="s-ramp.org" / specification="specification" /
schemas="schemas" / xsdmodel.xsd="xsdmodel.xsd" "
xmlns:s-ramp="http://s-ramp.org/xmlns/2010/s-ramp" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<s-ramp:XsdDocument name="”accountingTypes.xsd”"
description="”accountingTypes.xsd”" createdBy="Bellwood" version="1.0"
uuid="aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6a" createdTimestamp="2009-05-26T13:13:55.013+02:00"
lastModifiedTimestamp="2009-06-26T13:13:55.013+02:00" lastModifiedBy="Pospisil"
contentEncoding="UTF-8" contentType="“application/xml”" contentSize="4096">
<s-ramp:classifiedBy>
http://example.org/ontologies/accounting.owl/accounts
</s-ramp:classifiedBy>

<s-ramp:importedXsds>
<s-ramp:target xlink:href="">http://example.org/s-ramp/xsd/XsdDocument" /
aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6b="aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6b" ”>
aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6b
</s-ramp:target>
</s-ramp:importedXsds>
<s-ramp:relationship>
<s-ramp:relationshipType>similarXsds</s-ramp:relationshipType>
<s-ramp:relationshipTarget>
<s-ramp:target xlink:href="">http://example.org/s-ramp/xsd/XsdDocument" /
aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6b="aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6b" ”>
aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6b
</s-ramp:target>
</s-ramp:relationshipTarget>
<s-ramp:relationshipTarget>
<s-ramp:target xlink:href="">http://example.org/s-ramp/xsd/XsdDocument" /
aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6c="aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6c" ”>
aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaa6c
</s-ramp:target>
</s-ramp:relationshipTarget>
</s-ramp:relationship>
<s-ramp:property>
<propertyName>myPropertyName</propertyName>
<propertyValue>myPropertyValue</propertyValue>
</s-ramp:property>
</s-ramp:XsdDocument>
<s-ramp:artifact />
</entry>

Wouldn't it make more sense to use the 'content' element (so we don't need to use a structured extension element). For example, see the section in red:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<atom:entry xmlns:ns2="http://www.w3.org/2005/Atom">
<ns2:title>PO.xsd</ns2:title>
<ns2:link href="">"http://localhost:8080/changeit/s-ramp/xsd/XsdDocument/58fb40be-f1e4-419a-8b94-87a90435c509/media"type="application/atom+xml;charset="utf-8""/>
<ns2:link href="">"http://localhost:8080/changeit/s-ramp/xsd/XsdDocument/58fb40be-f1e4-419a-8b94-87a90435c509" rel="self" type="application/atom+xml;type="entry""/>
<ns2:link href="">"http://localhost:8080/changeit/s-ramp/xsd/XsdDocument/58fb40be-f1e4-419a-8b94-87a90435c509/edit-media" rel="edit-media" type="application/atom+xml;type="entry""/>
<ns2:link href="">"http://localhost:8080/changeit/s-ramp/xsd/XsdDocument/58fb40be-f1e4-419a-8b94-87a90435c509/edit" rel="edit" type="application/atom+xml;type="entry""/>
<ns2:category label="XML Schema" scheme="x-s-ramp:2010:type" term="XsdDocument"/>
<ns2:updated>2012-05-02T19:17:07.075-04:00</ns2:updated>
<ns2:id>58fb40be-f1e4-419a-8b94-87a90435c509</ns2:id>
<ns2:published>2012-05-02T19:17:07.075-04:00</ns2:published>
<ns2:author>
<ns2:name><modeshape-worker></ns2:name>
</ns2:author>
<ns2:content>
<s-ramp:artifact xmlns:atom="http://www.w3.org/2005/Atom" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:s-ramp="http://s-ramp.org/xmlns/2010/s-ramp">
<s-ramp:XsdDocument contentEncoding="UTF-8" contentSize="2376" contentType="application/xsd" createdBy="<modeshape-worker>" createdTimestamp="2012-05-02T19:17:07.075-04:00" description="Purchase order schema for Example.com.
Copyright 2000 Example.com. All rights reserved." lastModifiedBy="<modeshape-worker>" lastModifiedTimestamp="2012-05-02T19:17:07.075-04:00" name="PO.xsd" uuid="58fb40be-f1e4-419a-8b94-87a90435c509" version="1.0"/>
</s-ramp:artifact>
</ns2:content>
<ns2:summary>Purchase order schema for Example.com.
Copyright 2000 Example.com. All rights reserved.</ns2:summary>
</atom:entry>

Love to hear your opinion on this.

Thx,

--Kurt

Unless stated otherwise above:
IBM United Kingdom Limited - Registered in England and Wales with number 741598.
Registered office: PO Box 41, North Harbour, Portsmouth, Hampshire PO6 3AU

Follow-Ups:
- Re: [s-ramp] atom bind question - 'artifact' and 'content'
  - From: Kurt T Stam <kstam@redhat.com>

References:
- atom bind question - 'artifact' and 'content'
  - From: Kurt T Stam <kstam@redhat.com>