Skip navigation links

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

E12907-03


oracle.irm.engine.content.sealing
Interface SealingOptions


public interface SealingOptions

Sealing options. There are a number of parameters required when content is sealed. These include the Classification details, additional user defined custom meta data, a content schema and fine-grained control of the content encryption processes (using encryption options).

Creation

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

SealingOptions object = createSealingOptions(classification);
SealingOptions object = createSealingOptions(
    classification,
    customData,
    contentSchema,
    creationTime,
    encryptionOptions);

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<content:SealingOptions xmlns:content="http://xmlns.oracle.com/irm/content">
    <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>
    <contentSchema>
        <schemaVersion>
            <version>6.0</version>
        </schemaVersion>
    </contentSchema>
    <creationTime>2008-02-01T13:00:00.000+01:00</creationTime>
    <encryptionOptions>
        <publicHeaderPeriod>1</publicHeaderPeriod>
        <encryptedContentBlockSize>16</encryptedContentBlockSize>
    </encryptionOptions>
</content:SealingOptions>


Method Summary
 Classification getClassification()
          Classification.
 ContentSchema getContentSchema()
          Content schema.
 Date getCreationTime()
          Creation time.
 Collection<CustomData> getCustomData()
          Custom data.
 EncryptionOptions getEncryptionOptions()
          Encryption options.

 

Method Detail

getClassification

Classification getClassification()
Classification. The classification to use when sealing the content.
Returns:
the value of the property. This method will never return null.

getCustomData

Collection<CustomData> getCustomData()
Custom data. Custom meta data is sealed into the sealed content public header. This information can be accessed using peek.

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.

getContentSchema

ContentSchema getContentSchema()
Content schema. The content schema is a content specific version number that can be used by the desktop to help interpret any version specific details there may be with the sealed content.
Returns:
the value of the property. This method will never return null.

getCreationTime

Date getCreationTime()
Creation time. When content is sealed a creation time stamp is added to the sealed content meta-data. This information can be accessed using peek. Usually the creation time is the time the content was sealed, but it could be a specified to be a different time, perhaps to match the attributes of the unsealed content.

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.

getEncryptionOptions

EncryptionOptions getEncryptionOptions()
Encryption options. Encryption options allow fine grained control over the structure of the encrypted sealed content.
Returns:
the value of the property. This method will never return null.

Skip navigation links

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

E12907-03


Copyright © 2011, Oracle. All rights reserved.