Package org.apache.poi.hssf.record

Class FilePassRecord

java.lang.Object

org.apache.poi.hssf.record.RecordBase

org.apache.poi.hssf.record.Record

org.apache.poi.hssf.record.StandardRecord

org.apache.poi.hssf.record.FilePassRecord

public final class FilePassRecord
extends StandardRecord

Title: File Pass Record (0x002F)

Description: Indicates that the record after this record are encrypted.

Author:

Jason Height (jheight at chariot dot net dot au)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FilePassRecord.Rc4KeyData
static class	FilePassRecord.XorKeyData

Field Summary

Fields

Modifier and Type	Field	Description
static short	sid

Constructor Summary

Constructors

Constructor	Description
FilePassRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()
protected int	getDataSize()
byte[]	getDocId()	Deprecated. use getRc4KeyData().getSalt()
FilePassRecord.Rc4KeyData	getRc4KeyData()
byte[]	getSaltData()	Deprecated. use getRc4KeyData().getEncryptedVerifier()
byte[]	getSaltHash()	Deprecated. use getRc4KeyData().getEncryptedVerifierHash()
short	getSid()	return the non static version of the id for this record.
FilePassRecord.XorKeyData	getXorKeyData()
void	serialize(LittleEndianOutput out)	Write the data content of this BIFF record.
void	setDocId(byte[] docId)	Deprecated. use getRc4KeyData().setSalt()
void	setSaltData(byte[] saltData)	Deprecated. use getRc4KeyData().setEncryptedVerifier()
void	setSaltHash(byte[] saltHash)	Deprecated. use getRc4KeyData().setEncryptedVerifierHash()
java.lang.String	toString()	get a string representation of the record (for biffview/debugging)

Methods inherited from class java.lang.Object

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

Methods inherited from class org.apache.poi.hssf.record.Record

cloneViaReserialise, serialize

Methods inherited from class org.apache.poi.hssf.record.StandardRecord

getRecordSize, serialize

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

FilePassRecord

public FilePassRecord(RecordInputStream in)

Method Detail

serialize

public void serialize(LittleEndianOutput out)

Description copied from class: StandardRecord

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.
The number of bytes written must equal the record size reported by RecordBase.getRecordSize()} minus four ( record header consiting of a 'ushort sid' and 'ushort reclength' has already been written by thye superclass).

Specified by:

serialize in class StandardRecord

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class StandardRecord

getRc4KeyData

public FilePassRecord.Rc4KeyData getRc4KeyData()

getXorKeyData

public FilePassRecord.XorKeyData getXorKeyData()

getDocId

public byte[] getDocId()

Deprecated.

use getRc4KeyData().getSalt()

Returns:

the rc4 salt

setDocId

public void setDocId(byte[] docId)

Deprecated.

use getRc4KeyData().setSalt()

Parameters:

docId - the new rc4 salt

getSaltData

public byte[] getSaltData()

Deprecated.

use getRc4KeyData().getEncryptedVerifier()

Returns:

the rc4 encrypted verifier

setSaltData

public void setSaltData(byte[] saltData)

Deprecated.

use getRc4KeyData().setEncryptedVerifier()

Parameters:

saltData - the new rc4 encrypted verifier

getSaltHash

public byte[] getSaltHash()

Deprecated.

use getRc4KeyData().getEncryptedVerifierHash()

Returns:

the rc4 encrypted verifier hash

setSaltHash

public void setSaltHash(byte[] saltHash)

Deprecated.

use getRc4KeyData().setEncryptedVerifierHash()

Parameters:

saltHash - the new rc4 encrypted verifier

getSid

public short getSid()

Description copied from class: Record

return the non static version of the id for this record.

Specified by:

getSid in class Record

clone

public java.lang.Object clone()

Overrides:

clone in class Record

toString

public java.lang.String toString()

Description copied from class: Record

get a string representation of the record (for biffview/debugging)

Overrides:

toString in class Record