Skip navigation links

oracle.irm.engine.content.sealing
Interface ContentDescription

public interface ContentDescription

Sealed content meta data. 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.

Creation

Instances of Content Description objects can be created using the following factory style method(s).

ContentDescription object = createContentDescription(
    schema,
    classification,
    customData,
    creationTime,
    editTime,
    sealedMime,
    unsealedSize);

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>

Field Summary

static long

UNSPECIFIED_UNSEALED_SIZE The value of the unsealed size if no size was specified during sealing.

Method Summary

Classification	getClassification() The classification used to seal the content.
Date	getCreationTime() Date and time when the content was originally sealed.
Collection<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.

Field Detail

UNSPECIFIED_UNSEALED_SIZE

static final long UNSPECIFIED_UNSEALED_SIZE

The value of the unsealed size if no size was specified during sealing. Value: -1L

See Also:

Constant Field Values

Method Detail

getSchema

ContentSchema getSchema()

Content schema version.

Returns:

the value of the property. This method will never return null.

getClassification

Classification getClassification()

The classification used to seal the content.

Returns:

the value of the property. This method will never return null.

getCustomData

Collection<CustomData> getCustomData()

Optional custom data.

State

The collection returned by this method is an unmodifiable view on the internal collection state of the object.

Returns:

the value of the property. If this collection is empty this method returns an empty collection rather than returning null.

getCreationTime

Date getCreationTime()

Date and time when the content was originally sealed.

State

The date returned by this method can be safely altered without affecting the internal state of the object.

Returns:

the value of the property. This method will never return null.

getEditTime

Date getEditTime()

Date and time when the content was last (re)sealed.

State

The date returned by this method can be safely altered without affecting the internal state of the object.

Returns:

the value of the property. This method will never return null.

getSealedMime

String getSealedMime()

The MIME type of the sealed file.

Returns:

the value of the property. This method will never return null.

getUnsealedSize

long getUnsealedSize()

The size of the original unsealed file. -1 if unknown.

Returns:

the value of the property.

Skip navigation links