Skip navigation links

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

E12907-02


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

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

All Implemented Interfaces:
Serializable

public class SealingOptions
extends Object
implements Serializable

Sealing Options type. 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).

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>

See Also:
Serialized Form

Constructor Summary
SealingOptions()
          No argument constructor.
SealingOptions(Classification classification, CustomData[] customData, ContentSchema contentSchema, Date creationTime, EncryptionOptions encryptionOptions)
          Constructor.

 

Method Summary
 Classification getClassification()
          Classification.
 ContentSchema getContentSchema()
          Content schema.
 Date getCreationTime()
          Creation time.
 CustomData[] getCustomData()
          Custom data.
 EncryptionOptions getEncryptionOptions()
          Encryption options.
 void setClassification(Classification value)
          Classification.
 void setContentSchema(ContentSchema value)
          Content schema.
 void setCreationTime(Date value)
          Creation time.
 void setCustomData(CustomData[] value)
          Custom data.
 void setEncryptionOptions(EncryptionOptions value)
          Encryption options.

 

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

 

Constructor Detail

SealingOptions

public SealingOptions()
No argument constructor.

SealingOptions

public SealingOptions(Classification classification,
                      CustomData[] customData,
                      ContentSchema contentSchema,
                      Date creationTime,
                      EncryptionOptions encryptionOptions)
Constructor.

Method Detail

getClassification

public Classification getClassification()
Classification. The classification to use when sealing the content.
Returns:
the value of the property.

setClassification

public void setClassification(Classification value)
Classification. The classification to use when sealing the content.
Parameters:
value - the new value for the property.

getCustomData

public CustomData[] getCustomData()
Custom data. Custom meta data is sealed into the sealed content public header. This information can be accessed using peek.
Returns:
the value of the property.

setCustomData

public void setCustomData(CustomData[] value)
Custom data. Custom meta data is sealed into the sealed content public header. This information can be accessed using peek.
Parameters:
value - the new value for the property.

getContentSchema

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

setContentSchema

public void setContentSchema(ContentSchema value)
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.
Parameters:
value - the new value for the property.

getCreationTime

public 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.
Returns:
the value of the property.

setCreationTime

public void setCreationTime(Date value)
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.
Parameters:
value - the new value for the property.

getEncryptionOptions

public EncryptionOptions getEncryptionOptions()
Encryption options. Encryption options allow fine grained control over the structure of the encrypted sealed content.
Returns:
the value of the property.

setEncryptionOptions

public void setEncryptionOptions(EncryptionOptions value)
Encryption options. Encryption options allow fine grained control over the structure of the encrypted sealed content.
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-02


Copyright © 2010, Oracle. All rights reserved.