Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.encryption.AccessPermission

Modifier and Type	Field and Description
private static final int	ASSEMBLE_DOCUMENT_BIT
private int	bytes
private static final int	DEFAULT_PERMISSIONS
private static final int	EXTRACT_BIT
private static final int	EXTRACT_FOR_ACCESSIBILITY_BIT
private static final int	FAITHFUL_PRINT_BIT
private static final int	FILL_IN_FORM_BIT
private static final int	MODIFICATION_BIT
private static final int	MODIFY_ANNOTATIONS_BIT
private static final int	PRINT_BIT
private boolean	readOnly

Access	Constructor and Description
public	AccessPermission() Create a new access permission object.
public	AccessPermission(byte[] the bytes as defined in PDF specs b) Create a new access permission object from a byte array.
public	AccessPermission(int The permission bits. permissions) Creates a new access permission object from a single integer.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true If supplied with the user password they are allowed to assemble the document. canAssembleDocument() This will tell if the user can insert/rotate/delete pages.
public boolean	Returns: true If supplied with the user password they are allowed to extract content from the PDF document canExtractContent() This will tell if the user can extract text and images from the PDF document.
public boolean	Returns: true If supplied with the user password they are allowed to extract content from the PDF document canExtractForAccessibility() This will tell if the user can extract text and images from the PDF document for accessibility purposes.
public boolean	Returns: true If supplied with the user password they are allowed to fill in form fields. canFillInForm() This will tell if the user can fill in interactive form fields (including signature fields) even if `canModifyAnnotations()` returns false.
public boolean	Returns: true If supplied with the user password they are allowed to modify the document canModify() This will tell if the user can modify contents of the document.
public boolean	Returns: true If supplied with the user password they are allowed to modify annotations. canModifyAnnotations() This will tell if the user can add or modify text annotations and fill in interactive forms fields and, if `canModify()` returns true, create or modify interactive form fields (including signature fields).
public boolean	Returns: true If supplied with the user password they are allowed to print. canPrint() This will tell if the user can print.
public boolean	Returns: true If supplied with the user password they are allowed to print the document in a faithful format. canPrintFaithful() This will tell if the user can print the document in a faithful format or in a degraded format (if print is enabled).
public static AccessPermission	Returns: A standard owner access permission set. getOwnerAccessPermission() returns an access permission object for a document owner.
public int	Returns: the integer representing the access permissions getPermissionBytes() The returns an integer representing the access permissions.
public int	Returns: the integer representing access permissions getPermissionBytesForPublicKey() This returns an integer representing the access permissions.
protected boolean	Returns: true if any revision 3 access permission is set hasAnyRevision3PermissionSet() Indicates if any revision 3 access permission is set or not.
public boolean	Returns: true if the access permission does not restrict the use of the document isOwnerPermission() This will tell if the access permission corresponds to owner access permission (no restriction).
private boolean	isPermissionBitOn(int bit)
public boolean	Returns: true if the object is in read only mode. isReadOnly() This will tell if the object has been set as read only.
public void	setCanAssembleDocument(boolean A boolean determining if the user can assemble the document. allowAssembly) Set if the user can insert/rotate/delete pages.
public void	setCanExtractContent(boolean A boolean determining if the user can extract content from the document. allowExtraction) Set if the user can extract content from the document.
public void	setCanExtractForAccessibility(boolean A boolean determining if the user can extract content from the document. allowExtraction) Set if the user can extract content from the document for accessibility purposes.
public void	setCanFillInForm(boolean A boolean determining if the user can fill in interactive forms. allowFillingInForm) Set if the user can fill in interactive form fields (including signature fields) even if `canModifyAnnotations()` returns false.
public void	setCanModify(boolean A boolean determining if the user can modify the document. allowModifications) Set if the user can modify the document.
public void	setCanModifyAnnotations(boolean A boolean determining the new setting. allowAnnotationModification) Set if the user can add or modify text annotations and fill in interactive forms fields and, if `canModify()` returns true, create or modify interactive form fields (including signature fields).
public void	setCanPrint(boolean A boolean determining if the user can print. allowPrinting) Set if the user can print.
public void	setCanPrintFaithful(boolean A boolean determining if the user can print the document in a faithful format. canPrintFaithful) Set if the user can print the document in a faithful format or in a degraded format (if print is enabled).
private boolean	setPermissionBit(int bit, boolean value)
public void	setReadOnly() Locks the access permission read only (ie, the setters will have no effects).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

ASSEMBLE_DOCUMENT_BIT	back to summary
private static final int ASSEMBLE_DOCUMENT_BIT

bytes	back to summary
private int bytes

DEFAULT_PERMISSIONS	back to summary
private static final int DEFAULT_PERMISSIONS

EXTRACT_BIT	back to summary
private static final int EXTRACT_BIT

EXTRACT_FOR_ACCESSIBILITY_BIT	back to summary
private static final int EXTRACT_FOR_ACCESSIBILITY_BIT

FAITHFUL_PRINT_BIT	back to summary
private static final int FAITHFUL_PRINT_BIT

FILL_IN_FORM_BIT	back to summary
private static final int FILL_IN_FORM_BIT

MODIFICATION_BIT	back to summary
private static final int MODIFICATION_BIT

MODIFY_ANNOTATIONS_BIT	back to summary
private static final int MODIFY_ANNOTATIONS_BIT

PRINT_BIT	back to summary
private static final int PRINT_BIT

readOnly	back to summary
private boolean readOnly

AccessPermission	back to summary
public AccessPermission() Create a new access permission object. By default, all permissions are granted.

AccessPermission	back to summary
public AccessPermission(byte[] b) Create a new access permission object from a byte array. Bytes are ordered most significant byte first. Parameters b:byte[] the bytes as defined in PDF specs

AccessPermission	back to summary
public AccessPermission(int permissions) Creates a new access permission object from a single integer. Parameters permissions:int The permission bits.

Method Detail

canAssembleDocument	back to summary
public boolean canAssembleDocument() This will tell if the user can insert/rotate/delete pages. Returns:boolean true If supplied with the user password they are allowed to assemble the document.

canAssembleDocument

back to summary

public boolean canAssembleDocument()

This will tell if the user can insert/rotate/delete pages.

Returns:boolean: true If supplied with the user password they are allowed to assemble the document.

canExtractContent	back to summary
public boolean canExtractContent() This will tell if the user can extract text and images from the PDF document. Returns:boolean true If supplied with the user password they are allowed to extract content from the PDF document

canExtractContent

back to summary

public boolean canExtractContent()

This will tell if the user can extract text and images from the PDF document.

Returns:boolean: true If supplied with the user password they are allowed to extract content from the PDF document

canExtractForAccessibility	back to summary
public boolean canExtractForAccessibility() This will tell if the user can extract text and images from the PDF document for accessibility purposes. Returns:boolean true If supplied with the user password they are allowed to extract content from the PDF document

canExtractForAccessibility

back to summary

public boolean canExtractForAccessibility()

This will tell if the user can extract text and images from the PDF document for accessibility purposes.

Returns:boolean: true If supplied with the user password they are allowed to extract content from the PDF document

canFillInForm back to summary

canFillInForm	back to summary
public boolean canFillInForm() This will tell if the user can fill in interactive form fields (including signature fields) even if `canModifyAnnotations()` returns false. Returns:boolean true If supplied with the user password they are allowed to fill in form fields.

public boolean canFillInForm()

This will tell if the user can fill in interactive form fields (including signature fields) even if canModifyAnnotations() returns false.

Returns:boolean: true If supplied with the user password they are allowed to fill in form fields.

canModify	back to summary
public boolean canModify() This will tell if the user can modify contents of the document. Returns:boolean true If supplied with the user password they are allowed to modify the document

canModify

back to summary

public boolean canModify()

This will tell if the user can modify contents of the document.

Returns:boolean: true If supplied with the user password they are allowed to modify the document

canModifyAnnotations back to summary

canModifyAnnotations	back to summary
public boolean canModifyAnnotations() This will tell if the user can add or modify text annotations and fill in interactive forms fields and, if `canModify()` returns true, create or modify interactive form fields (including signature fields). Note that if `canFillInForm()` returns true, it is still possible to fill in interactive forms (including signature fields) even if this method here returns false. Returns:boolean true If supplied with the user password they are allowed to modify annotations.

public boolean canModifyAnnotations()

This will tell if the user can add or modify text annotations and fill in interactive forms fields and, if canModify() returns true, create or modify interactive form fields (including signature fields). Note that if canFillInForm() returns true, it is still possible to fill in interactive forms (including signature fields) even if this method here returns false.

Returns:boolean: true If supplied with the user password they are allowed to modify annotations.

canPrint	back to summary
public boolean canPrint() This will tell if the user can print. Returns:boolean true If supplied with the user password they are allowed to print.

canPrint

back to summary

public boolean canPrint()

This will tell if the user can print.

Returns:boolean: true If supplied with the user password they are allowed to print.

canPrintFaithful	back to summary
public boolean canPrintFaithful() This will tell if the user can print the document in a faithful format or in a degraded format (if print is enabled). Returns:boolean true If supplied with the user password they are allowed to print the document in a faithful format.

canPrintFaithful

back to summary

public boolean canPrintFaithful()

This will tell if the user can print the document in a faithful format or in a degraded format (if print is enabled).

Returns:boolean: true If supplied with the user password they are allowed to print the document in a faithful format.

getOwnerAccessPermission	back to summary
public static AccessPermission getOwnerAccessPermission() returns an access permission object for a document owner. Returns:AccessPermission A standard owner access permission set.

getOwnerAccessPermission

back to summary

public static AccessPermission getOwnerAccessPermission()

returns an access permission object for a document owner.

Returns:AccessPermission: A standard owner access permission set.

getPermissionBytes	back to summary
public int getPermissionBytes() The returns an integer representing the access permissions. This integer can be used for standard PDF encryption as specified in the PDF specifications. Returns:int the integer representing the access permissions

getPermissionBytes

back to summary

public int getPermissionBytes()

The returns an integer representing the access permissions. This integer can be used for standard PDF encryption as specified in the PDF specifications.

Returns:int: the integer representing the access permissions

getPermissionBytesForPublicKey	back to summary
public int getPermissionBytesForPublicKey() This returns an integer representing the access permissions. This integer can be used for public key encryption. This format is not documented in the PDF specifications but is necessary for compatibility with Adobe Acrobat and Adobe Reader. Returns:int the integer representing access permissions

getPermissionBytesForPublicKey

back to summary

public int getPermissionBytesForPublicKey()

This returns an integer representing the access permissions. This integer can be used for public key encryption. This format is not documented in the PDF specifications but is necessary for compatibility with Adobe Acrobat and Adobe Reader.

Returns:int: the integer representing access permissions

hasAnyRevision3PermissionSet	back to summary
protected boolean hasAnyRevision3PermissionSet() Indicates if any revision 3 access permission is set or not. Returns:boolean true if any revision 3 access permission is set

hasAnyRevision3PermissionSet

back to summary

protected boolean hasAnyRevision3PermissionSet()

Indicates if any revision 3 access permission is set or not.

Returns:boolean: true if any revision 3 access permission is set

isOwnerPermission	back to summary
public boolean isOwnerPermission() This will tell if the access permission corresponds to owner access permission (no restriction). Returns:boolean true if the access permission does not restrict the use of the document

isOwnerPermission

back to summary

public boolean isOwnerPermission()

This will tell if the access permission corresponds to owner access permission (no restriction).

Returns:boolean: true if the access permission does not restrict the use of the document

isPermissionBitOn	back to summary
private boolean isPermissionBitOn(int bit)

isReadOnly	back to summary
public boolean isReadOnly() This will tell if the object has been set as read only. Returns:boolean true if the object is in read only mode.

isReadOnly

back to summary

public boolean isReadOnly()

This will tell if the object has been set as read only.

Returns:boolean: true if the object is in read only mode.

setCanAssembleDocument	back to summary
public void setCanAssembleDocument(boolean allowAssembly) Set if the user can insert/rotate/delete pages. This method will have no effect if the object is in read only mode. Parameters allowAssembly:boolean A boolean determining if the user can assemble the document.

setCanAssembleDocument

back to summary

public void setCanAssembleDocument(boolean allowAssembly)

Set if the user can insert/rotate/delete pages.

This method will have no effect if the object is in read only mode.

Parameters

allowAssembly:boolean: A boolean determining if the user can assemble the document.

setCanExtractContent	back to summary
public void setCanExtractContent(boolean allowExtraction) Set if the user can extract content from the document. This method will have no effect if the object is in read only mode. Parameters allowExtraction:boolean A boolean determining if the user can extract content from the document.

setCanExtractContent

back to summary

public void setCanExtractContent(boolean allowExtraction)

Set if the user can extract content from the document.

This method will have no effect if the object is in read only mode.

Parameters

allowExtraction:boolean: A boolean determining if the user can extract content from the document.

setCanExtractForAccessibility	back to summary
public void setCanExtractForAccessibility(boolean allowExtraction) Set if the user can extract content from the document for accessibility purposes. This method will have no effect if the object is in read only mode. Parameters allowExtraction:boolean A boolean determining if the user can extract content from the document.

setCanExtractForAccessibility

back to summary

public void setCanExtractForAccessibility(boolean allowExtraction)

Set if the user can extract content from the document for accessibility purposes.

This method will have no effect if the object is in read only mode.

Parameters

allowExtraction:boolean: A boolean determining if the user can extract content from the document.

setCanFillInForm back to summary

setCanFillInForm	back to summary
public void setCanFillInForm(boolean allowFillingInForm) Set if the user can fill in interactive form fields (including signature fields) even if `canModifyAnnotations()` returns false. Therefore, if you want to prevent a user from filling in interactive form fields, you need to call `setCanModifyAnnotations(false)` as well. This method will have no effect if the object is in read only mode. Parameters allowFillingInForm:boolean A boolean determining if the user can fill in interactive forms.

public void setCanFillInForm(boolean allowFillingInForm)

Set if the user can fill in interactive form fields (including signature fields) even if canModifyAnnotations() returns false. Therefore, if you want to prevent a user from filling in interactive form fields, you need to call setCanModifyAnnotations(false) as well.

This method will have no effect if the object is in read only mode.

Parameters

allowFillingInForm:boolean: A boolean determining if the user can fill in interactive forms.

setCanModify	back to summary
public void setCanModify(boolean allowModifications) Set if the user can modify the document. This method will have no effect if the object is in read only mode. Parameters allowModifications:boolean A boolean determining if the user can modify the document.

setCanModify

back to summary

public void setCanModify(boolean allowModifications)

Set if the user can modify the document.

This method will have no effect if the object is in read only mode.

Parameters

allowModifications:boolean: A boolean determining if the user can modify the document.

setCanModifyAnnotations back to summary

setCanModifyAnnotations	back to summary
public void setCanModifyAnnotations(boolean allowAnnotationModification) Set if the user can add or modify text annotations and fill in interactive forms fields and, if `canModify()` returns true, create or modify interactive form fields (including signature fields). Note that if `canFillInForm()` returns true, it is still possible to fill in interactive forms (including signature fields) even the parameter here is false. This method will have no effect if the object is in read only mode. Parameters allowAnnotationModification:boolean A boolean determining the new setting.

public void setCanModifyAnnotations(boolean allowAnnotationModification)

Set if the user can add or modify text annotations and fill in interactive forms fields and, if canModify() returns true, create or modify interactive form fields (including signature fields). Note that if canFillInForm() returns true, it is still possible to fill in interactive forms (including signature fields) even the parameter here is false.

This method will have no effect if the object is in read only mode.

Parameters

allowAnnotationModification:boolean: A boolean determining the new setting.

setCanPrint	back to summary
public void setCanPrint(boolean allowPrinting) Set if the user can print. This method will have no effect if the object is in read only mode. Parameters allowPrinting:boolean A boolean determining if the user can print.

setCanPrint

back to summary

public void setCanPrint(boolean allowPrinting)

Set if the user can print.

This method will have no effect if the object is in read only mode.

Parameters

allowPrinting:boolean: A boolean determining if the user can print.

setCanPrintFaithful	back to summary
public void setCanPrintFaithful(boolean canPrintFaithful) Set if the user can print the document in a faithful format or in a degraded format (if print is enabled). The PDF version must be 1.5 or higher. This method will have no effect if the object is in read only mode. Parameters canPrintFaithful:boolean A boolean determining if the user can print the document in a faithful format.

setCanPrintFaithful

back to summary

public void setCanPrintFaithful(boolean canPrintFaithful)

Set if the user can print the document in a faithful format or in a degraded format (if print is enabled). The PDF version must be 1.5 or higher.

This method will have no effect if the object is in read only mode.

Parameters

canPrintFaithful:boolean: A boolean determining if the user can print the document in a faithful format.

setPermissionBit	back to summary
private boolean setPermissionBit(int bit, boolean value)

setReadOnly	back to summary
public void setReadOnly() Locks the access permission read only (ie, the setters will have no effects). After that, the object cannot be unlocked. This method is used for the currentAccessPermission of a document to avoid users to change access permission.

public Class AccessPermission

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail