Skip navigation links

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

E12907-03


oracle.irm.engine.types.content.key
Class KeySetRef

java.lang.Object
  extended by oracle.irm.engine.types.content.key.KeySetRef

All Implemented Interfaces:
Serializable

public class KeySetRef
extends Object
implements Serializable

Key Set reference. 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.

This class can be used to reference an instance of a KeySet object. It contains all the properties needed to uniquely identify a KeySet. The serialized form of this class can be used to identify an object without the need to serialize the complete object.

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>

See Also:
Serialized Form

Constructor Summary
KeySetRef()
          No argument constructor.
KeySetRef(UUID uuid)
          Constructor.

 

Method Summary
 UUID getUuid()
          Key UUID.
 void setUuid(UUID value)
          Key UUID.

 

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

 

Constructor Detail

KeySetRef

public KeySetRef()
No argument constructor.

KeySetRef

public KeySetRef(UUID uuid)
Constructor.

Method Detail

getUuid

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

setUuid

public void setUuid(UUID value)
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.
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-03


Copyright © 2011, Oracle. All rights reserved.