org.apache.poi.hslf.record
Class DocumentEncryptionAtom

java.lang.Object
  org.apache.poi.hslf.record.Record
      org.apache.poi.hslf.record.RecordAtom
          org.apache.poi.hslf.record.PositionDependentRecordAtom
              org.apache.poi.hslf.record.DocumentEncryptionAtom

All Implemented Interfaces:

PositionDependentRecord

public final class DocumentEncryptionAtom
extends PositionDependentRecordAtom

A Document Encryption Atom (type 12052). Holds information on the Encryption of a Document

Author:

Nick Burch

DocumentEncryptionAtom

protected DocumentEncryptionAtom(byte[] source,
                                 int start,
                                 int len)
                          throws java.io.IOException

For the Document Encryption Atom

Throws:

java.io.IOException

DocumentEncryptionAtom

public DocumentEncryptionAtom()

initializeEncryptionInfo

public void initializeEncryptionInfo(int keyBits)

Initializes the encryption settings

Parameters:

keyBits - see CipherAlgorithm.rc4 for allowed values, use -1 for default size

getKeyLength

public int getKeyLength()

Return the length of the encryption key, in bits

getEncryptionProviderName

public java.lang.String getEncryptionProviderName()

Return the name of the encryption provider used

getEncryptionInfo

public EncryptionInfo getEncryptionInfo()

Returns:

the EncryptionInfo object for details about encryption settings

getRecordType

public long getRecordType()

We are of type 12052

Specified by:

getRecordType in class Record

writeOut

public void writeOut(java.io.OutputStream out)
              throws java.io.IOException

Write the contents of the record back, so it can be written to disk

Specified by:

writeOut in class Record

Throws:

java.io.IOException

updateOtherRecordReferences

public void updateOtherRecordReferences(java.util.Map<java.lang.Integer,java.lang.Integer> oldToNewReferencesLookup)

Description copied from class: PositionDependentRecordAtom

Offer the record the list of records that have changed their location as part of the writeout. Allows records to update their internal pointers to other records locations

Specified by:

updateOtherRecordReferences in interface PositionDependentRecord

Specified by:

updateOtherRecordReferences in class PositionDependentRecordAtom