Class PDStandardEncryption
java.lang.Object
org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
Made deprecated by the new security layer of PDFBox. Use SecurityHandlers instead.
This class holds information that is related to the standard PDF encryption.
See PDF Reference 1.4 section "3.5 Encryption"
- Version:
- $Revision: 1.7 $
- Author:
- Ben Litchfield
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Deprecated.The default set of permissions which is to allow all.static final int
Deprecated.The default revision of one is not specified.static final String
Deprecated.The 'Filter' name for this security handler.static final int
Deprecated.Encryption revision 2.static final int
Deprecated.Encryption revision 3.static final int
Deprecated.Encryption revision 4.Fields inherited from class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
DEFAULT_LENGTH, DEFAULT_NAME, DEFAULT_VERSION, encryptionDictionary, VERSION0_UNDOCUMENTED_UNSUPPORTED, VERSION1_40_BIT_ALGORITHM, VERSION2_VARIABLE_LENGTH_ALGORITHM, VERSION3_UNPUBLISHED_ALGORITHM, VERSION4_SECURITY_HANDLER
-
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Default constructor that uses Version 2, Revision 3, 40 bit encryption, all permissions allowed.Deprecated.Constructor from existing dictionary. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Deprecated.This will tell if the user can insert/rotate/delete pages.boolean
Deprecated.This will tell if the user can extract text and images from the PDF document.boolean
Deprecated.This will tell if the user can extract text and images from the PDF document for accessibility purposes.boolean
Deprecated.This will tell if the user can fill in interactive forms.boolean
Deprecated.This will tell if the user can modify contents of the document.boolean
Deprecated.This will tell if the user can add/modify text annotations, fill in interactive forms fields.boolean
canPrint()
Deprecated.This will tell if the user can print.boolean
Deprecated.This will tell if the user can print the document in a degraded format.byte[]
Deprecated.This will get the O entry in the standard encryption dictionary.int
Deprecated.This will get the permissions bit mask.int
Deprecated.This will return the R entry of the encryption dictionary.
See PDF Reference 1.4 Table 3.14.byte[]
Deprecated.This will get the U entry in the standard encryption dictionary.void
setCanAssembleDocument
(boolean allowAssembly) Deprecated.Set if the user can insert/rotate/delete pages.void
setCanExtractContent
(boolean allowExtraction) Deprecated.Set if the user can extract content from the document.void
setCanExtractForAccessibility
(boolean allowExtraction) Deprecated.Set if the user can extract content from the document for accessibility purposes.void
setCanFillInForm
(boolean allowFillingInForm) Deprecated.Set if the user can fill in interactive forms.void
setCanModify
(boolean allowModifications) Deprecated.Set if the user can modify the document.void
setCanModifyAnnotations
(boolean allowAnnotationModification) Deprecated.Set if the user can modify annotations.void
setCanPrint
(boolean allowPrinting) Deprecated.Set if the user can print.void
setCanPrintDegraded
(boolean canPrintDegraded) Deprecated.Set if the user can print the document in a degraded format.void
setOwnerKey
(byte[] o) Deprecated.This will set the O entry in the standard encryption dictionary.void
setPermissions
(int p) Deprecated.This will set the permissions bit mask.void
setRevision
(int revision) Deprecated.This will set the R entry of the encryption dictionary.
See PDF Reference 1.4 Table 3.14.void
setUserKey
(byte[] u) Deprecated.This will set the U entry in the standard encryption dictionary.Methods inherited from class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
getCOSDictionary, getCryptFilterDictionary, getFilter, getLength, getRecipientsLength, getRecipientStringAt, getStdCryptFilterDictionary, getStreamFilterName, getStringFilterName, getSubFilter, getVersion, isEncryptMetaData, setFilter, setLength, setRecipients, setSubFilter, setVersion
-
Field Details
-
FILTER_NAME
Deprecated.The 'Filter' name for this security handler.- See Also:
-
DEFAULT_REVISION
public static final int DEFAULT_REVISIONDeprecated.The default revision of one is not specified.- See Also:
-
REVISION2
public static final int REVISION2Deprecated.Encryption revision 2.- See Also:
-
REVISION3
public static final int REVISION3Deprecated.Encryption revision 3.- See Also:
-
REVISION4
public static final int REVISION4Deprecated.Encryption revision 4.- See Also:
-
DEFAULT_PERMISSIONS
public static final int DEFAULT_PERMISSIONSDeprecated.The default set of permissions which is to allow all.- See Also:
-
-
Constructor Details
-
PDStandardEncryption
public PDStandardEncryption()Deprecated.Default constructor that uses Version 2, Revision 3, 40 bit encryption, all permissions allowed. -
PDStandardEncryption
Deprecated.Constructor from existing dictionary.- Parameters:
dict
- The existing encryption dictionary.
-
-
Method Details
-
getRevision
public int getRevision()Deprecated.This will return the R entry of the encryption dictionary.
See PDF Reference 1.4 Table 3.14.- Overrides:
getRevision
in classPDEncryptionDictionary
- Returns:
- The encryption revision to use.
-
setRevision
public void setRevision(int revision) Deprecated.This will set the R entry of the encryption dictionary.
See PDF Reference 1.4 Table 3.14.
Note: This value is used to decrypt the pdf document. If you change this when the document is encrypted then decryption will fail!.- Overrides:
setRevision
in classPDEncryptionDictionary
- Parameters:
revision
- The new encryption version.
-
getOwnerKey
public byte[] getOwnerKey()Deprecated.This will get the O entry in the standard encryption dictionary.- Overrides:
getOwnerKey
in classPDEncryptionDictionary
- Returns:
- A 32 byte array or null if there is no owner key.
-
setOwnerKey
Deprecated.This will set the O entry in the standard encryption dictionary.- Overrides:
setOwnerKey
in classPDEncryptionDictionary
- Parameters:
o
- A 32 byte array or null if there is no owner key.- Throws:
IOException
- If there is an error setting the data.
-
getUserKey
public byte[] getUserKey()Deprecated.This will get the U entry in the standard encryption dictionary.- Overrides:
getUserKey
in classPDEncryptionDictionary
- Returns:
- A 32 byte array or null if there is no user key.
-
setUserKey
Deprecated.This will set the U entry in the standard encryption dictionary.- Overrides:
setUserKey
in classPDEncryptionDictionary
- Parameters:
u
- A 32 byte array.- Throws:
IOException
- If there is an error setting the data.
-
getPermissions
public int getPermissions()Deprecated.This will get the permissions bit mask.- Overrides:
getPermissions
in classPDEncryptionDictionary
- Returns:
- The permissions bit mask.
-
setPermissions
public void setPermissions(int p) Deprecated.This will set the permissions bit mask.- Overrides:
setPermissions
in classPDEncryptionDictionary
- Parameters:
p
- The new permissions bit mask
-
canPrint
public boolean canPrint()Deprecated.This will tell if the user can print.- Returns:
- true If supplied with the user password they are allowed to print.
-
setCanPrint
public void setCanPrint(boolean allowPrinting) Deprecated.Set if the user can print.- Parameters:
allowPrinting
- A boolean determining if the user can print.
-
canModify
public boolean canModify()Deprecated.This will tell if the user can modify contents of the document.- Returns:
- true If supplied with the user password they are allowed to modify the document
-
setCanModify
public void setCanModify(boolean allowModifications) Deprecated.Set if the user can modify the document.- Parameters:
allowModifications
- A boolean determining if the user can modify the document.
-
canExtractContent
public boolean canExtractContent()Deprecated.This will tell if the user can extract text and images from the PDF document.- Returns:
- true If supplied with the user password they are allowed to extract content from the PDF document
-
setCanExtractContent
public void setCanExtractContent(boolean allowExtraction) Deprecated.Set if the user can extract content from the document.- Parameters:
allowExtraction
- A boolean determining if the user can extract content from the document.
-
canModifyAnnotations
public boolean canModifyAnnotations()Deprecated.This will tell if the user can add/modify text annotations, fill in interactive forms fields.- Returns:
- true If supplied with the user password they are allowed to modify annotations.
-
setCanModifyAnnotations
public void setCanModifyAnnotations(boolean allowAnnotationModification) Deprecated.Set if the user can modify annotations.- Parameters:
allowAnnotationModification
- A boolean determining if the user can modify annotations.
-
canFillInForm
public boolean canFillInForm()Deprecated.This will tell if the user can fill in interactive forms.- Returns:
- true If supplied with the user password they are allowed to fill in form fields.
-
setCanFillInForm
public void setCanFillInForm(boolean allowFillingInForm) Deprecated.Set if the user can fill in interactive forms.- Parameters:
allowFillingInForm
- A boolean determining if the user can fill in interactive forms.
-
canExtractForAccessibility
public boolean canExtractForAccessibility()Deprecated.This will tell if the user can extract text and images from the PDF document for accessibility purposes.- Returns:
- true If supplied with the user password they are allowed to extract content from the PDF document
-
setCanExtractForAccessibility
public void setCanExtractForAccessibility(boolean allowExtraction) Deprecated.Set if the user can extract content from the document for accessibility purposes.- Parameters:
allowExtraction
- A boolean determining if the user can extract content from the document.
-
canAssembleDocument
public boolean canAssembleDocument()Deprecated.This will tell if the user can insert/rotate/delete pages.- Returns:
- true If supplied with the user password they are allowed to extract content from the PDF document
-
setCanAssembleDocument
public void setCanAssembleDocument(boolean allowAssembly) Deprecated.Set if the user can insert/rotate/delete pages.- Parameters:
allowAssembly
- A boolean determining if the user can assemble the document.
-
canPrintDegraded
public boolean canPrintDegraded()Deprecated.This will tell if the user can print the document in a degraded format.- Returns:
- true If supplied with the user password they are allowed to print the document in a degraded format.
-
setCanPrintDegraded
public void setCanPrintDegraded(boolean canPrintDegraded) Deprecated.Set if the user can print the document in a degraded format.- Parameters:
canPrintDegraded
- A boolean determining if the user can print the document in a degraded format.
-