This wiki is locked. Future workgroup activity and specification development must take place at
our new wiki
. For more information, see
this blog post about the new governance model
and
this post about changes to the website
.
TWiki
>
Main Web
>
AssetHome
>
AssetMgSpecificationV1
>
ArtifactResourceDefinitionsV1
(22 Mar 2010,
TWikiAdminUser
)
(raw view)
---+ Artifact Resource Definition ---++ 1.0 Specification (Convergence) ---++ Contents <a name="Contents"></a> * [[#introduction][Introduction]] * [[#notationconvention][Notations and Conventions]] * [[#terminology][Terminology]] * [[#artifactResource][Artifact Resource]] * [[#xmlResource][XML Representation of the Artifact Resource]] * [[#xmlExample][Example]] * [[#jsonResource][JSON Representation of the Artifact Resource]] * [[#jsonExample][Example]] ---++ Introduction <a name="introduction" title="introduction"></a> Asset Management resources define the definative software assets for the software delivery lifecycle. This specification will focus on the definition of an artifact, which includes common set of properties that describe a single software artifact (i.e. WSDL file, jar file, word document etc). Implementations can extend this base definition of an asset by contributing their additional properties to the artifact resource defintion. Refer to the [[AssetMgDefinitions][definitions]] page for descriptions on asset management related terms used here. ---++ Notation and Conventions <a name="notationconvention" title="notationconvention"></a> The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [[http://www.ietf.org/rfc/rfc2119.txt][RFC2119]]. Domain name examples use [[http://tools.ietf.org/html/rfc2606][RFC2606]]. ---++ Artifact Resource <a name="artifactResource" title="artifactResource"></a> The artifact resource properties are not limited to the ones defined in this specification. It is recommended to contribute resource properties in their own unique namespace, not to reuse those defined in these specifications. XML namespace abbreviations used in this specification: * =oslc_asset= - The asset management resources - http://open-services.net/xmlns/asset/1.0/ * ras - OMG Reusable Asset Specification - http://www.omg.org/ras/v2.2 * =rdf= - [[http://www.w3.org/TR/rdf-syntax-grammar/][RDF XML]] namespace - =http://www.w3.org/1999/02/22-rdf-syntax-ns#= * =dc= - The [[http://dublincore.org/documents/dcmi-terms/][Dublin Core Metadata Terms]] namespace - =http://purl.org/dc/terms/= ---+++ XML Representation of the Artifact Resource <a name="xmlResource" title="xmlResource"></a> The media type used for this representation MUST be =application/x-oslc-asset-artifact+xml=. <table width="1108" cellspacing="0" cellpadding="0" height="176" border="1"><tbody><tr><td colspan="2" valign="top"> *XML Representation Summary:* *Asset Element* </td></tr><tr><td colspan="2" valign="top"><oslc_asset:Artifact rdf:about = xsd:anyURI > <br /> _Content_: (dc:title, path?, dc:modified?, dc:subject?, size?, reference?, mimeType?, dc:modified?)<br /></oslc_asset:Artifact> </td></tr><tr><td valign="top"> *Property* </td><td valign="top"> *Representation* </td></tr><tr><td valign="top">dc:title</td><td valign="top">The *required* title string. Note that this element comes from the DC namespace, allowing tools unaware of the asset management domain to access this element. This is sometimes also referred to as the artifact's '/' delimetated name. </td></tr><tr><td>dc:subject</td><td>The *optional* subject string. The DC namespace defines this element to be the topic of the asset.This is also known as the artifact's label.<br /></td></tr><tr><td>size<br /></td><td>The *optional*, *read-only* size string. The size of the artifact content in bytes.<br /></td></tr><tr><td valign="top">reference</td><td valign="top">The *optional* reference. An external pointer to the artifact's content or tracability to its origin. </td></tr><tr><td valign="top">mimeType<br /></td><td valign="top">The *optional* mim type of the artifact content. </td></tr><tr><td>content <br /></td><td>The *optional* media resource (the artifact bytes). <br /></td></tr><tr><td>dc:modified <br /></td><td>The *optional*, *read-only* modified date time which must conform to [[http://tools.ietf.org/html/rfc3339][RFC3339]] format </td></tr></tbody></table> ---++++ Example <a name="xmlExample" title="xmlExample"></a> <verbatim><oslc_asset:artifact xml:base="https://server:9443/ram/" rdf:about="oslc/assets/%7B1082CDD3-1E40-5648-E7DC-5137CC841AA5%7D/1.0.20091011/artifacts/bin/services.ear"> <dc:title>bin/services.ear</dc:title> <size>6439267</size> <mimeType>application/java-archive</mimeType> <dc:subject>MyCo's employee web services Java Enterprise Application [2009-10-11T12:10:16.593-04:00]</dc:subject> <reference rdf:resource="https://buildServer/fullcontrol/index.php?mod=jobs&action=edit&bf_id=965518"> <dc:subject>Build Forge Reference</dc:subject> <dc:type>Build</dc:type> </reference> <dc:modified>2009-10-11T12:10:16.593-04:00</dc:modified> </oslc_asset:artifact> </verbatim> ---+++ JSON Representation of the Artifact Resource <a name="jsonResource" title="jsonResource"></a> The media type used for this representation MUST be =application/x-oslc-asset-artifact+json=. <table width="1108" cellspacing="0" cellpadding="0" height="176" border="1"><tbody><tr><td colspan="2" valign="top"> *XML Representation Summary:* *Asset Element* </td></tr><tr><td colspan="2" valign="top">{ _Content_: (rdf:about?, dc:title, path?, dc:modified?, dc:subject?, size?, reference?, mimeType?, dc:modified?)}<br /></td></tr><tr><td valign="top"> *Property* </td><td valign="top"> *Representation* </td></tr><tr><td valign="top">dc:title</td><td valign="top">The *required* title string. Note that this element comes from the DC namespace, allowing tools unaware of the asset management domain to access this element. This is sometimes also referred to as the artifact's '/' delimetated name.<br /></td></tr><tr><td>dc:subject</td><td>The *optional* subject string. The DC namespace defines this element to be the topic of the asset.This is also known as the artifact's label.<br /></td></tr><tr><td>size<br /></td><td>The *optional*, *read-only* size string. The size of the artifact content in bytes.<br /></td></tr><tr><td valign="top">reference</td><td valign="top">The *optional* reference. An external pointer to the artifact's content or tracability to its origin. </td></tr><tr><td valign="top">mimeType<br /></td><td valign="top">The *optional* mim type of the artifact content. </td></tr><tr><td>content<br /></td><td>The *optional* media resource (the artifact bytes). <br /></td></tr><tr><td>dc:modified <br /></td><td>The *optional*, *read-only* modified date time which must conform to [[http://tools.ietf.org/html/rfc3339][RFC3339]] format </td></tr></tbody></table> ---++++ Example <a name="jsonExample" title="jsonExample"></a> <verbatim>{ "xml:base", "https://server:9443/ram/" "rdf:about": "oslc/assets/%7B1082CDD3-1E40-5648-E7DC-5137CC841AA5%7D/1.0.20091011/artifacts/bin/services.ear", "size": 6439267, "dc:title": "bin/services.ear", "mimeType" : "application/java-archive", "dc:subject" : "MyCo's employee web services Java Enterprise Application [2009-10-11T12:10:16.593-04:00]", "reference" : { "rdf:resource": "rdf:resource="https://buildServer/fullcontrol/index.php?mod=jobs&action=edit&bf_id=965518", "dc:subject": "Build Forge Reference", "dc:type", "Build" }, "dc:modified" : "2009-10-11T12:10:16.593-04:00" } </verbatim>
E
dit
|
A
ttach
|
P
rint version
|
H
istory
: r10
<
r9
<
r8
<
r7
<
r6
|
B
acklinks
|
V
iew topic
|
Ra
w
edit
|
M
ore topic actions
Topic revision: r10 - 22 Mar 2010 - 14:37:00 -
TWikiAdminUser
Main
Main Web
Create New Topic
Index
Search
Changes
Notifications
RSS Feed
Statistics
Preferences
Webs
Main
Sandbox
TWiki
Български
Cesky
Dansk
Deutsch
English
Español
Français
Italiano
日本語
Nederlands
Polski
Português
Русский
Svenska
简体中文
簡體中文
Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our
Terms of Use
Ideas, requests, problems regarding this site?
Send feedback