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
>
AssetMgResourceDefinitionsV1
(21 Apr 2010,
TWikiAdminUser
)
(raw view)
---+ Asset Resource Definition ---++ 1.0 Specification ---++ <a name="Contents"></a> Contents * [[#introduction][Introduction]] * [[#notationconvention][Notations and Conventions]] * [[#terminology][Terminology]] * [[#assetResource][Asset Resource]] * [[#xmlResource][XML Representation of the Asset Resource]] * [[#xmlExample][Example]] * [[#jsonResource][JSON Representation of the Asset 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 asset, which includes common set of properties, their types and requirements on usage. Implementations can extend this base definition of an asset by contributing their additional properties to the asset resource defintion. <br /><br />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]]. ---++ Asset Resource <a name="assetResource" title="assetResource"></a> The asset 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 Asset Resource <a name="xmlResource" title="xmlResource"></a> The media type used for this representation MUST be =application/xml=. <table width="100%" 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:Asset rdf:about = xsd:anyURI > <br /> _Content_: (ras:id, dc:title, dc:type, dc:subject, dc:state, dc:description?, dc:contributor?, artifactContentFactory, artifact?, relation?, dc:modified?)<br /></oslc_asset:Asset> </td></tr><tr><td valign="top"> *Property* </td><td valign="top"> *Representation* </td></tr><tr><td>ras:id <br /></td><td>The *required* identifier for the asset includes the GUID and version.<br /></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 asset name.<br /></td></tr><tr><td valign="top">dc:type</td><td valign="top">The *required* type string. The type of asset that is represented, such as: Service, Release, etc.</td></tr><tr><td>dc:subject</td><td>The *required* subject string. The DC namespace defines this element to be the topic of the asset.This is also known as the asset's short description.<br /></td></tr><tr><td>dc:description<br /></td><td>The *optional* description string. This element comes from the DC namespace, allowing tools completely unaware of the change management domain to access this element. <br /></td></tr><tr><td>dc:contributor <br /></td><td>The *required* multi-valued property for each of the asset owners. <br /></td></tr><tr><td>state <br /></td><td>The *required* *,* *read-only*, state string. The current state of the asset. This element comes from the DC namespace, allowing tools completely unaware of the change management domain to access this element. <br /></td></tr><tr><td>artifactContentFactory</td><td>The *required* *, read-only* resource URI used to post new Artifacts to the Assset.<br /></td></tr><tr><td valign="top">artifact <br /></td><td valign="top">The *optional* multi valued list of artifacs </td></tr><tr><td> - dc:title <br /></td><td>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. <br /></td></tr><tr><td> - content <br /></td><td>The *required* media resource reference URI (the artifact bytes). <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> - mimeType</td><td>The *required* mime type of the artifact media. </td></tr><tr><td> - size</td><td>The *required* size of the artifact media in bytes. <br /></td></tr><tr><td> - dc:modified</td><td>The *required*, *read-only* modified date time which must conform to <a target="_top" href="http://tools.ietf.org/html/rfc3339">RFC3339</a> format </td></tr><tr><td>relation <br /></td><td>The *optional* multi valued list of relationships to other assets. <br /></td></tr><tr><td> - rdf:resource <br /></td><td>The *required* reference to the related resource. <br /></td></tr><tr><td> - dc:type <br /></td><td>The *optional* type string. The type of relationship (i.e. dependcy, test case, specification...) </td></tr><tr><td> - dc:title</td><td>The *optional* string name of the relation. </td></tr><tr><td>dc:modified <br /></td><td>The *required*, *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> <?xml version="1.0" encoding="UTF-8"?> <oslc_asset:asset rdf:about="https://server:9443/am/oslc/assets/%7B1082CDD3-1E40-5648-E7DC-5137CC841AA5%7D/1.0"> <ras:id> <ras:GUID>{1082CDD3-1E40-5648-E7DC-5137CC841AA5}</ras:GUID> <ras:version>1.0.20091011</ras:version> </ras:id> <dc:title>Myco Services Application</dc:title> <dc:subject>My Company's REST Services Application</dc:subject> <dc:type>Application</dc:type> <oslc_asset:state>Approved</oslc_asset:state> <dc:contributor>bobsmith@myco.com</dc:contributor> <oslc_asset:artifactContentFactory rdf:resource="https://server:9443/am/oslc/assets/%7B1082CDD3-1E40-5648-E7DC-5137CC841AA5%7D/1.0.20091011/artifacts"/> <oslc_asset:artifact> <dc:title>services.ear</dc:title> <dc:subject>Services Enterprise Application</dc:subject> <oslc_asset:mimeType>application/ear</oslc_asset:mimeType> <oslc_asset:content rdf:resource="oslc/assets/%7B1082CDD3-1E40-5648-E7DC-5137CC841AA5%7D/1.0.20091011/artifactConetnts/ear/services.ear"/> <oslc_asset:size>22130688</oslc_asset:size> <dc:modified>2008-09-16T08:42:11.265Z</dc:modified> </oslc_asset:artifact> <oslc_asset:artifact> <dc:title>buildSummary.html</dc:title> <dc:subject>Build Summary</dc:subject> <content rdf:resource="https://buildServer/fullcontrol/index.php?mod=jobs&action=edit&bf_id=965518"/> <dc:modified>2008-09-16T08:42:11.265Z</dc:modified> </oslc_asset:artifact> <oslc_asset:relation rdf:resource="https://server:9443/am/oslc/assets/%7B882B4FD7-3C72-4DB0-8097-66866E7D45F6%7D/1.2"> <dc:title>Appache Logging Service</dc:title> <dc:type>Dependency</dc:type> </oslc_asset:relation> <dc:modified>2008-09-16T08:42:11.265Z</dc:modified> </oslc_asset:asset> </verbatim> ---+++ JSON Representation of the Asset Resource <a name="jsonResource" title="jsonResource"></a> The media type used for this representation MUST be =application/json=. <table width="100%" 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_: (ras:id, dc:title, dc:type, dc:subject, dc:state, dc:description?, owner?, artifactContentFactory, artifact?, relation?, dc:modified?) }</td></tr><tr><td valign="top"> *Property* </td><td valign="top"> *Representation* </td></tr><tr><td>ras:id <br /></td><td>The *required* identifier for the asset includes the GUID and version.<br /></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 asset name.<br /></td></tr><tr><td valign="top">dc:type</td><td valign="top">The *required* type string. The type of asset that is represented, such as: Service, Release, etc.</td></tr><tr><td>dc:subject</td><td>The *required* subject string. The DC namespace defines this element to be the topic of the asset.This is also known as the asset's short description.<br /></td></tr><tr><td>dc:description<br /></td><td>The *optional* description string. This element comes from the DC namespace, allowing tools completely unaware of the change management domain to access this element. <br /></td></tr><tr><td>dc:contributor <br /></td><td>The *required* multi-valued property for each of the asset owners. <br /></td></tr><tr><td>state <br /></td><td>The *required* *,* *read-only*, state string. The current state of the asset. This element comes from the DC namespace, allowing tools completely unaware of the change management domain to access this element. <br /></td></tr><tr><td>artifactContentFactory</td><td>The *required* *, read-only* resource URI used to post new Artifacts to the Assset.<br /></td></tr><tr><td valign="top">artifact <br /></td><td valign="top">The *optional* multi valued list of artifats </td></tr><tr><td> - dc:title <br /></td><td>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. <br /></td></tr><tr><td> - content <br /></td><td>The *required* media resource reference URI (the artifact bytes). <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> - mimeType</td><td>The *required* mime type of the artifact media. </td></tr><tr><td> - size<br /></td><td>The *required* size of the artifact media in bytes. <br /></td></tr><tr><td> - dc:modified</td><td>The *required*, *read-only* modified date time which must conform to <a target="_top" href="http://tools.ietf.org/html/rfc3339">RFC3339</a> format </td></tr><tr><td>relation <br /></td><td>The *optional* multi valued list of relationships to other assets. <br /></td></tr><tr><td> - rdf:resource <br /></td><td>The *required* reference to the related resource. <br /></td></tr><tr><td> - dc:type <br /></td><td>The *optional* type string. The type of relationship (i.e. dependcy, test case, specification...) </td></tr><tr><td> - dc:title</td><td>The *optional* string name of the relation. </td></tr><tr><td>dc:modified <br /></td><td>The *required*, *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>{ "rdf:about": "https://server:9443/am/"oslc/assets/%7B1082CDD3-1E40-5648-E7DC-5137CC841AA5%7D/1.0", "ras:id": {"ras:GUID": "{1082CDD3-1E40-5648-E7DC-5137CC841AA5}", "ras:version", "1.0.20091011"}, "dc:title": "Myco Services Application", "dc:subject" : "My Company's REST Services Application", "dc:type" : "Application", "oslc_asset:state" : "Approved", "dc:contributor" : "bobsmith@myco.com", "oslc_asset:artifactFactory" :{ "rdf:resource": "https://server:9443/am/"oslc/assets/%7B1082CDD3-1E40-5648-E7DC-5137CC841AA5%7D/1.0.20091011/artifacts"}, "oslc_asset:artifact" : {"dc:title" : "services.ear", "dc:subject": "Services Enterprise Application", "oslc_asset:mimeType": "application/ear" "oslc_asset:size": "22130688", "dc:modified": "2008-09-16T08:42:11.265Z"}, "oslc_asset:artifact" : {"dc:title" : "buildSummary.html", "dc:subject", "Build Summary" "oslc_asset:content" : "https://buildServer/fullcontrol/index.php?mod=jobs&action=edit&bf_id=965518"}, "dc:relation": {"dc:type": {"value": "Dependency", "rdf:resource": "https://server:9443/am/"oslc/assets/%7B882B4FD7-3C72-4DB0-8097-66866E7D45F6%7D/1.2"}} "dc:modified" : "2008-09-16T08:42:11.265Z" } </verbatim>
E
dit
|
A
ttach
|
P
rint version
|
H
istory
: r25
<
r24
<
r23
<
r22
<
r21
|
B
acklinks
|
V
iew topic
|
Ra
w
edit
|
M
ore topic actions
Topic revision: r25 - 21 Apr 2010 - 17:45:46 -
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