Skip navigation links

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

java.lang.Object
oracle.irm.engine.types.content.sealing.EncryptionOptions

All Implemented Interfaces:

Serializable

public class EncryptionOptions

extends Object

implements Serializable

Encryption Options type. The most common use of this class is to alter the size of the encrypted content blocks in the sealed file. Note that most of the important parameters (algorithm, key-size, etc.) are determined by the choice of CryptoSchema associated with the classification.

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<content:EncryptionOptions xmlns:content="http://xmlns.oracle.com/irm/content">
<publicHeaderPeriod>1</publicHeaderPeriod>
<encryptedContentBlockSize>16384</encryptedContentBlockSize>
</content:EncryptionOptions>

See Also:

Serialized Form

Constructor Summary

EncryptionOptions()
No argument constructor.

EncryptionOptions(int publicHeaderPeriod, int encryptedContentBlockSize)
Constructor.

Method Summary

int	getEncryptedContentBlockSize() Encrypted content block size.
int	getPublicHeaderPeriod() Public header repeat period.
void	setEncryptedContentBlockSize(int value) Encrypted content block size.
void	setPublicHeaderPeriod(int value) Public header repeat period.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EncryptionOptions

public EncryptionOptions()

No argument constructor.

EncryptionOptions

public EncryptionOptions(int publicHeaderPeriod,
                         int encryptedContentBlockSize)

Constructor.

Method Detail

getPublicHeaderPeriod

public int getPublicHeaderPeriod()

Public header repeat period. If non-zero, then the public header period defines how often to repeat the public header. After the specified number of encrypted chunks, the public header will be repeated. This feature can be used with content that is provided in stream form so that clients can observe the data stream and start de-crypting once a public header has been encountered.

Returns:

the value of the property.

setPublicHeaderPeriod

public void setPublicHeaderPeriod(int value)

Public header repeat period. If non-zero, then the public header period defines how often to repeat the public header. After the specified number of encrypted chunks, the public header will be repeated. This feature can be used with content that is provided in stream form so that clients can observe the data stream and start de-crypting once a public header has been encountered.

Parameters:

value - the new value for the property.

getEncryptedContentBlockSize

public int getEncryptedContentBlockSize()

Encrypted content block size. This is the length (in bytes) of an individual cipher-text block. This value must be a multiple of the cipher block size used to encrypt content. The default value is 16K.

Returns:

the value of the property.

setEncryptedContentBlockSize

public void setEncryptedContentBlockSize(int value)

Encrypted content block size. This is the length (in bytes) of an individual cipher-text block. This value must be a multiple of the cipher block size used to encrypt content. The default value is 16K.

Parameters:

value - the new value for the property.

Skip navigation links