Skip navigation links

Oracle® Information Rights Management Server Java API Reference
11g Release 1 (11.1.1)

E12907-01


oracle.irm.engine.types.content.sealing
Class ContentDescription

java.lang.Object
  extended by oracle.irm.engine.types.content.sealing.ContentDescription

All Implemented Interfaces:
Serializable

public class ContentDescription
extends Object
implements Serializable

Content Description type. The sealed content description is meta data that is added to content during the sealing process. The content description contains the classification details and any user defined meta data. The content description can be extracted from sealed content using the peek method.

XML Serialization

Content Description instances can be serialized as an XML document. This XML document can also be used to recreate a Content Description object. The following XML document shows an example Content Description in XML form.

<?xml version="1.0" encoding="UTF-8"?>
<content:ContentDescription xmlns:content="http://xmlns.oracle.com/irm/content" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <schema>
        <schemaVersion>
            <version>6.0</version>
        </schemaVersion>
    </schema>
    <classification>
        <id>7ec1c191-0531-4876-813e-c554676df09b</id>
        <system>
            <uuid>588403f9-9cff-4cce-88e4-e030cc57282a</uuid>
        </system>
        <keySet>
            <uuid>213f8f65-c5d1-4868-9fff-ad156daa2dd6</uuid>
        </keySet>
        <uri>http://irm.example.com/irm_desktop</uri>
        <classifications:ContextCookie xmlns:classifications="http://xmlns.oracle.com/irm/classifications">
            <context>
                <uuid>588403f9-9cff-4cce-88e4-e030cc57282a</uuid>
            </context>
            <itemCode>
                <value>sample.sdoc</value>
            </itemCode>
        </classifications:ContextCookie>
        <classificationTime>2008-02-01T13:00:00.000+01:00</classificationTime>
        <labels>
            <locale>en</locale>
            <name>Top Secret</name>
        </labels>
    </classification>
    <customData>
        <uuid>2b8cd20a-d4f5-47b6-9097-d12547f2b707</uuid>
        <car>
            <name>Ford</name>
            <colour>Blue</colour>
        </car>
    </customData>
    <customData>
        <uuid>036ee988-e63a-4824-8ed5-9efddc5e41a5</uuid>
        <image>CgzVe1FgQLNWyaAPNrupZluaVKXyODQpKgUpf2mYNt2EYy12RAmMQ/xKMt1/EXPui27L9Dt7zXd4NpE/5tveTQ==</image>
    </customData>
    <customData>
        <uuid>a6ec786e-10e5-4d47-b588-9aa75fd26d24</uuid>
        <foo:a xmlns:foo="foo">
            <b>
                <c>
                    <d> </d>
                </c>
            </b>
        </foo:a>
    </customData>
    <creationTime>2007-01-01T12:00:00.000+01:00</creationTime>
    <editTime>2007-01-01T12:00:00.000+01:00</editTime>
    <sealedMime>application/vnd.sealed.doc</sealedMime>
    <unsealedSize>1234567</unsealedSize>
</content:ContentDescription>

See Also:
Serialized Form

Constructor Summary
ContentDescription()
          No argument constructor.
ContentDescription(ContentSchema schema, Classification classification, CustomData[] customData, Date creationTime, Date editTime, String sealedMime, long unsealedSize)
          Constructor.

 

Method Summary
 Classification getClassification()
          The classification used to seal the content.
 Date getCreationTime()
          Date and time when the content was originally sealed.
 CustomData[] getCustomData()
          Optional custom data.
 Date getEditTime()
          Date and time when the content was last (re)sealed.
 ContentSchema getSchema()
          Content schema version.
 String getSealedMime()
          The MIME type of the sealed file.
 long getUnsealedSize()
          The size of the original unsealed file.
 void setClassification(Classification value)
          The classification used to seal the content.
 void setCreationTime(Date value)
          Date and time when the content was originally sealed.
 void setCustomData(CustomData[] value)
          Optional custom data.
 void setEditTime(Date value)
          Date and time when the content was last (re)sealed.
 void setSchema(ContentSchema value)
          Content schema version.
 void setSealedMime(String value)
          The MIME type of the sealed file.
 void setUnsealedSize(long value)
          The size of the original unsealed file.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

ContentDescription

public ContentDescription()
No argument constructor.

ContentDescription

public ContentDescription(ContentSchema schema,
                          Classification classification,
                          CustomData[] customData,
                          Date creationTime,
                          Date editTime,
                          String sealedMime,
                          long unsealedSize)
Constructor.

Method Detail

getSchema

public ContentSchema getSchema()
Content schema version.
Returns:
the value of the property.

setSchema

public void setSchema(ContentSchema value)
Content schema version.
Parameters:
value - the new value for the property.

getClassification

public Classification getClassification()
The classification used to seal the content.
Returns:
the value of the property.

setClassification

public void setClassification(Classification value)
The classification used to seal the content.
Parameters:
value - the new value for the property.

getCustomData

public CustomData[] getCustomData()
Optional custom data.
Returns:
the value of the property.

setCustomData

public void setCustomData(CustomData[] value)
Optional custom data.
Parameters:
value - the new value for the property.

getCreationTime

public Date getCreationTime()
Date and time when the content was originally sealed.
Returns:
the value of the property.

setCreationTime

public void setCreationTime(Date value)
Date and time when the content was originally sealed.
Parameters:
value - the new value for the property.

getEditTime

public Date getEditTime()
Date and time when the content was last (re)sealed.
Returns:
the value of the property.

setEditTime

public void setEditTime(Date value)
Date and time when the content was last (re)sealed.
Parameters:
value - the new value for the property.

getSealedMime

public String getSealedMime()
The MIME type of the sealed file.
Returns:
the value of the property.

setSealedMime

public void setSealedMime(String value)
The MIME type of the sealed file.
Parameters:
value - the new value for the property.

getUnsealedSize

public long getUnsealedSize()
The size of the original unsealed file. -1 if unknown.
Returns:
the value of the property.

setUnsealedSize

public void setUnsealedSize(long value)
The size of the original unsealed file. -1 if unknown.
Parameters:
value - the new value for the property.

Skip navigation links

Oracle® Information Rights Management Server Java API Reference
11g Release 1 (11.1.1)

E12907-01


Copyright © 2010, Oracle. All rights reserved.