Skip navigation links

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

E12907-02


oracle.irm.engine.types.content.crypto
Class CryptoSchemaRef

java.lang.Object
  extended by oracle.irm.engine.types.content.crypto.CryptoSchemaRef

All Implemented Interfaces:
Serializable

public class CryptoSchemaRef
extends Object
implements Serializable

Crypto Schema reference. A cryptography schema is used to link a KeySet with the set of cryptography algorithms used when working with that key set. A cryptography schema must be specified when creating a key set. The schema defines what types of cryptography key are generated and what key sizes are used. The cryptography schema is also used (via the key set) when sealing or unsealing content. When performing operations such as sealing or unsealing the schema defines what algorithms are used for encrypting (and decrypting) the content, signing the content and calculating digests.

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

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<content:CryptoSchema xmlns:content="http://xmlns.oracle.com/irm/content">
    <id>AES128</id>
    <encryptionTransformation>AES/CTR/NoPadding</encryptionTransformation>
    <encryptionKeySize>128</encryptionKeySize>
    <sessionKeyEncryptionTransformation>AES/ECB/NoPadding</sessionKeyEncryptionTransformation>
    <sessionKeyEncryptionKeySize>128</sessionKeyEncryptionKeySize>
    <hmacSigningAlgorithm>HmacSHA256</hmacSigningAlgorithm>
    <hmacSigningKeySize>128</hmacSigningKeySize>
    <digestAlgorithm>SHA-256</digestAlgorithm>
    <useFips>false</useFips>
</content:CryptoSchema>

Crypto Schema instances can also be serialized by reference. A reference contains all the information needed to uniquely identify a Crypto Schema 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:CryptoSchemaRef xmlns:content="http://xmlns.oracle.com/irm/content">
    <id>AES128</id>
</content:CryptoSchemaRef>

See Also:
Serialized Form

Constructor Summary
CryptoSchemaRef()
          No argument constructor.
CryptoSchemaRef(String id)
          Constructor.

 

Method Summary
 String getId()
          The identity of the schema.
 void setId(String value)
          The identity of the schema.

 

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

 

Constructor Detail

CryptoSchemaRef

public CryptoSchemaRef()
No argument constructor.

CryptoSchemaRef

public CryptoSchemaRef(String id)
Constructor.

Method Detail

getId

public String getId()
The identity of the schema. The identity must refer to a built-in engined defined cryptography schema.

Size

This property is limited to 50 characters in length.
Returns:
the value of the property.

setId

public void setId(String value)
The identity of the schema. The identity must refer to a built-in engined defined cryptography schema.

Size

This property is limited to 50 characters in length.
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.