Skip navigation links

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

E12907-03


oracle.irm.engine.content.key
Interface KeySet


public interface KeySet

A set of cryptography keys used in the sealing and unsealing process. A key set is the set of cryptography keys (and associated information) needed to create and open sealed content. Key sets are identified by a UUID. This UUID is stamped into sealed content and used to associate the content with the key set used to encrypt that content. The cryptography Schema determines what type and strength of cryptography keys are used. These cryptography keys, if required, can be provided with the key set in the Extensions property. This extensions property, for example, could contain the cryptography key values in wrapped form.

Creation

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

KeySet object = createKeySet(uuid);

Collections

Collections for KeySet objects can be created using the following factory method. This method creates the most appropriate collection implementation class for storing KeySet elements.

 Collection<KeySet> object = createKeySets();

Consult the Uuid property for more information on how this property can relate to KeySet collections.

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<content:KeySet xmlns:content="http://xmlns.oracle.com/irm/content">
    <uuid>213f8f65-c5d1-4868-9fff-ad156daa2dd6</uuid>
    <schema>
        <id>AES128</id>
    </schema>
    <creationTime>2007-01-01T12:00:00.000+01:00</creationTime>
</content:KeySet>

Key Set instances can also be serialized by reference. A reference contains all the information needed to uniquely identify a Key Set without needing to serialize the complete object. The reference form of the XML document can be seen below.

<?xml version="1.0" encoding="UTF-8"?>
<content:KeySetRef xmlns:content="http://xmlns.oracle.com/irm/content">
    <uuid>213f8f65-c5d1-4868-9fff-ad156daa2dd6</uuid>
</content:KeySetRef>


Method Summary
 Date getCreationTime()
          Date and time the key was created.
 KeySetExtensions getExtensions()
          Extended information for the key set.
 CryptoSchema getSchema()
          The cryptography schema used to create this key.
 UUID getUuid()
          Key UUID.

 

Method Detail

getUuid

UUID getUuid()
Key UUID. An immutable and unique UUID for the key. This identifier will be sealed into content so cannot not be altered for the lifetime of content.

Collections

This property value can be used to retrieve the object from a collection using getKeySetByUuid.
Returns:
the value of the property. This method will never return null.

getSchema

CryptoSchema getSchema()
The cryptography schema used to create this key.
Returns:
the value of the property. This method will never return null.

getCreationTime

Date getCreationTime()
Date and time the key was created.

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.

getExtensions

KeySetExtensions getExtensions()
Extended information for the key set. Extensions are optional, so this property may have a null value.
Returns:
the value of the property. This method can 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.