Package com.tom_roush.pdfbox.pdmodel.encryption

Class PDCryptFilterDictionary

java.lang.Object

com.tom_roush.pdfbox.pdmodel.encryption.PDCryptFilterDictionary

public class PDCryptFilterDictionary
extends Object

This class is a specialized view of the crypt filter dictionary of a PDF document. It contains a low level dictionary (COSDictionary) and provides the methods to manage its fields.

Field Summary

Fields

Modifier and Type	Field	Description
protected COSDictionary	cryptFilterDictionary	COS crypt filter dictionary.

Constructor Summary

Constructors

Constructor	Description
PDCryptFilterDictionary()	creates a new empty crypt filter dictionary.
PDCryptFilterDictionary(COSDictionary d)	creates a new crypt filter dictionary from the low level dictionary provided.

Method Summary

Modifier and Type	Method	Description
COSDictionary	getCOSDictionary()	This will get the dictionary associated with this crypt filter dictionary.
COSName	getCryptFilterMethod()	This will return the crypt filter method.
int	getLength()	This will return the Length entry of the crypt filter dictionary. The length in bits for the crypt filter algorithm.
void	setCryptFilterMethod(COSName cfm)	This will set the crypt filter method.
void	setLength(int length)	This will set the number of bits to use for the crypt filter algorithm.

Methods inherited from class java.lang.Object

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

Field Detail

cryptFilterDictionary

protected COSDictionary cryptFilterDictionary

COS crypt filter dictionary.

Constructor Detail

PDCryptFilterDictionary

public PDCryptFilterDictionary()

creates a new empty crypt filter dictionary.

PDCryptFilterDictionary

public PDCryptFilterDictionary(COSDictionary d)

creates a new crypt filter dictionary from the low level dictionary provided.

Parameters:

d - the low level dictionary that will be managed by the newly created object

Method Detail

getCOSDictionary

public COSDictionary getCOSDictionary()

This will get the dictionary associated with this crypt filter dictionary.

Returns:

The COS dictionary that this object wraps.

setLength

public void setLength(int length)

This will set the number of bits to use for the crypt filter algorithm.

Parameters:

length - The new key length.

getLength

public int getLength()

This will return the Length entry of the crypt filter dictionary.

The length in bits for the crypt filter algorithm. This will return a multiple of 8.

Returns:

The length in bits for the encryption algorithm

setCryptFilterMethod

public void setCryptFilterMethod(COSName cfm)
                          throws IOException

This will set the crypt filter method. Allowed values are: NONE, V2, AESV2, AESV3

Parameters:

cfm - name of the crypt filter method.

Throws:

IOException - If there is an error setting the data.

getCryptFilterMethod

public COSName getCryptFilterMethod()
                             throws IOException

This will return the crypt filter method. Allowed values are: NONE, V2, AESV2, AESV3

Returns:

the name of the crypt filter method.

Throws:

IOException - If there is an error accessing the data.