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 KeySet

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

All Implemented Interfaces:
Serializable

public class KeySet
extends Object
implements Serializable

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

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
KeySet()
          No argument constructor.
KeySet(UUID uuid, CryptoSchemaRef schema, Date creationTime, KeySetExtensions extensions)
          Constructor.

 

Method Summary
 Date getCreationTime()
          Date and time the key was created.
 KeySetExtensions getExtensions()
          Extended information for the key set.
 CryptoSchemaRef getSchema()
          The cryptography schema used to create this key.
 UUID getUuid()
          Key UUID.
 void setCreationTime(Date value)
          Date and time the key was created.
 void setExtensions(KeySetExtensions value)
          Extended information for the key set.
 void setSchema(CryptoSchemaRef value)
          The cryptography schema used to create this key.
 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

KeySet

public KeySet()
No argument constructor.

KeySet

public KeySet(UUID uuid,
              CryptoSchemaRef schema,
              Date creationTime,
              KeySetExtensions extensions)
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.

getSchema

public CryptoSchemaRef getSchema()
The cryptography schema used to create this key.
Returns:
the value of the property.

setSchema

public void setSchema(CryptoSchemaRef value)
The cryptography schema used to create this key.
Parameters:
value - the new value for the property.

getCreationTime

public Date getCreationTime()
Date and time the key was created.
Returns:
the value of the property.

setCreationTime

public void setCreationTime(Date value)
Date and time the key was created.
Parameters:
value - the new value for the property.

getExtensions

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

setExtensions

public void setExtensions(KeySetExtensions value)
Extended information for the key set. Extensions are optional, so this property may have a null value.
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.