Artifact Resource Definition

1.0 Specification (Convergence)

Introduction

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 definitions page for descriptions on asset management related terms used here.

Notation and Conventions

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 RFC2119. Domain name examples use RFC2606.

Artifact Resource

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 - RDF XML namespace - http://www.w3.org/1999/02/22-rdf-syntax-ns#
dc - The Dublin Core Metadata Terms namespace - http://purl.org/dc/terms/

XML Representation of the Artifact Resource

The media type used for this representation MUST be application/x-oslc-asset-artifact+xml.

XML Representation Summary: Asset Element
<oslc_asset:Artifact rdf:about = xsd:anyURI > Content: (dc:title, path?, dc:modified?, dc:subject?, size?, reference?, mimeType?, dc:modified?) </oslc_asset:Artifact>
Property	Representation
dc:title	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.
dc:subject	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.
size	The optional, read-only size string. The size of the artifact content in bytes.
reference	The optional reference. An external pointer to the artifact's content or tracability to its origin.
mimeType	The optional mim type of the artifact content.
content	The optional media resource (the artifact bytes).
dc:modified	The optional, read-only modified date time which must conform to RFC3339 format

Example

<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>

JSON Representation of the Artifact Resource

The media type used for this representation MUST be application/x-oslc-asset-artifact+json.

XML Representation Summary: Asset Element
{ Content: (rdf:about?, dc:title, path?, dc:modified?, dc:subject?, size?, reference?, mimeType?, dc:modified?)}
Property	Representation
dc:title	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.
dc:subject	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.
size	The optional, read-only size string. The size of the artifact content in bytes.
reference	The optional reference. An external pointer to the artifact's content or tracability to its origin.
mimeType	The optional mim type of the artifact content.
content	The optional media resource (the artifact bytes).
dc:modified	The optional, read-only modified date time which must conform to RFC3339 format

Example

{
 "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"
}

Topic revision: r10 - 22 Mar 2010 - 14:37:00 - TWikiAdminUser

Main

Webs
Main
Sandbox
TWiki

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

Artifact Resource Definition

1.0 Specification (Convergence)

Contents

Introduction

Notation and Conventions

Artifact Resource

XML Representation of the Artifact Resource

Example

JSON Representation of the Artifact Resource

Example