Package com.ironsoftware.ironpdf.security

Class SecurityOptions

java.lang.Object

com.ironsoftware.ironpdf.security.SecurityOptions

public class SecurityOptions
extends Object

A class defining user security settings for a PDF document.

Allows the developer to control user access passwords, encryption, and also who may edit, print and copy content from the PDF document

See: SecurityManager.setSecurityOptions(SecurityOptions).

Constructor Summary

Constructors

Constructor	Description
SecurityOptions()	Instantiates a new Security options.

Method Summary

Modifier and Type	Method	Description
PdfEditSecurity	getAllowUserEdits()	Gets allow user edits.
PdfPrintSecurity	getAllowUserPrinting()	Gets allow user printing.
String	getOwnerPassword()	Gets owner password.
String	getUserPassword()	Gets user password.
Boolean	isAllowUserAnnotations()	Is allow user annotations boolean.
Boolean	isAllowUserCopyPasteContent()	Is allow user copy and paste content boolean.
Boolean	isAllowUserCopyPasteContentForAccessibility()	Is allow user copy and paste content for accessibility boolean.
Boolean	isAllowUserFormData()	Is allow user form data boolean.
void	setAllowUserAnnotations(Boolean value)	Sets allow user annotations.
void	setAllowUserCopyPasteContent(Boolean value)	Sets allow user copy and paste content.
void	setAllowUserCopyPasteContentForAccessibility(Boolean value)	Sets allow user copy and paste content for accessibility.
void	setAllowUserEdits(PdfEditSecurity value)	Sets allow user edits.
void	setAllowUserFormData(Boolean value)	Sets allow user form data.
void	setAllowUserPrinting(PdfPrintSecurity value)	Sets allow user printing.
void	setOwnerPassword(String value)	Sets owner password.
void	setUserPassword(String value)	Sets user password.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityOptions

public SecurityOptions()

Instantiates a new Security options. A class defining user security settings for a PDF document.

Allows the developer to control user access passwords, encryption, and also who may edit, print and copy content from the PDF document

See: SecurityManager.setSecurityOptions(SecurityOptions).

Method Detail

isAllowUserAnnotations

public final Boolean isAllowUserAnnotations()

Is allow user annotations boolean. The permissions for users to annotate the PDF document with comments.

If AllowUserAnnotations is set false, the setOwnerPassword(String) must be set for the security measure to take effect.

Returns:

the boolean

setAllowUserAnnotations

public final void setAllowUserAnnotations(Boolean value)

Sets allow user annotations. The permissions for users to annotate the PDF document with comments.

If AllowUserAnnotations is set false, the setOwnerPassword(String) must be set for the security measure to take effect.

Parameters:

value - the value

isAllowUserCopyPasteContent

public final Boolean isAllowUserCopyPasteContent()

Is allow user copy and paste content boolean. The permissions for users to extract or 'copy & paste' content (text and images) from the PDF document.

If AllowUserCopyPasteContent is set false, the setOwnerPassword(String) must also be set for the security measure to take effect.

Returns:

the boolean

setAllowUserCopyPasteContent

public final void setAllowUserCopyPasteContent(Boolean value)

Sets allow user copy and paste content. The permissions for users to extract or 'copy & paste' content (text and images) from the PDF document.

If AllowUserCopyPasteContent is set false, the setOwnerPassword(String) must also be set for the security measure to take effect.

Parameters:

value - the value

isAllowUserCopyPasteContentForAccessibility

public final Boolean isAllowUserCopyPasteContentForAccessibility()

Is allow user copy and paste content for accessibility boolean. The permissions for users to extract or 'copy & paste' content (text and images) from the PDF document for accessibility.

Returns:

the boolean

setAllowUserCopyPasteContentForAccessibility

public final void setAllowUserCopyPasteContentForAccessibility(Boolean value)

Sets allow user copy and paste content for accessibility. The permissions for users to extract or 'copy & paste' content (text and images) from the PDF document for accessibility.

Parameters:

value - the value

getAllowUserEdits

public final PdfEditSecurity getAllowUserEdits()

Gets allow user edits. The permissions for users edit the PDF document. The features to edit the document depends entirely on the PDF client software used by the end user.

If editing rights are restricted, then the setOwnerPassword(String) must be set for the security measure to take effect.

Returns:

allow user edits value

setAllowUserEdits

public final void setAllowUserEdits(PdfEditSecurity value)

Sets allow user edits. The permissions for users edit the PDF document. The features to edit the document depends entirely on the PDF client software used by the end user.

If editing rights are restricted, then the setOwnerPassword(String) must be set for the security measure to take effect.

Parameters:

value - the value

isAllowUserFormData

public final Boolean isAllowUserFormData()

Is allow user form data boolean. The permissions for users to fill-in (enter data into) forms in the PDF document.

If AllowUserFormData is set false, the setOwnerPassword(String) must be set for the security measure to take effect.

Note. If you want to make the form readonly in Adobe Acrobat Reader please call Security_Api.makePdfDocumentReadOnly(InternalPdfDocument, String) method or set setAllowUserEdits(PdfEditSecurity) to PdfEditSecurity.NO_EDIT and set setOwnerPassword(String).

Returns:

allow user form data value

setAllowUserFormData

public final void setAllowUserFormData(Boolean value)

Sets allow user form data. The permissions for users to fill-in (enter data into) forms in the PDF document.

If AllowUserFormData is set false, the setOwnerPassword(String) must be set for the security measure to take effect.

Note. If you want to make the form readonly in Adobe Acrobat Reader please call Security_Api.makePdfDocumentReadOnly(InternalPdfDocument, String) method or set setAllowUserEdits(PdfEditSecurity) to PdfEditSecurity.NO_EDIT and set setOwnerPassword(String).

Parameters:

value - the value

getAllowUserPrinting

public final PdfPrintSecurity getAllowUserPrinting()

Gets allow user printing. The permissions for users to print the PDF document.

If print rights are restricted, then the setOwnerPassword(String) must be set for the security measure to take effect.

Returns:

allow user printing value

setAllowUserPrinting

public final void setAllowUserPrinting(PdfPrintSecurity value)

Sets allow user printing. The permissions for users to print the PDF document.

If print rights are restricted, then the setOwnerPassword(String) must be set for the security measure to take effect.

Parameters:

value - the value

getOwnerPassword

public final String getOwnerPassword()

Gets owner password. The owner password and enables 128Bit encryption of PDF content. An owner password is one used to enable and disable all other security settings.

OwnerPassword must be set to a non empty string value for setAllowUserCopyPasteContent(Boolean), setAllowUserAnnotations(Boolean), setAllowUserFormData(Boolean) and setAllowUserEdits(PdfEditSecurity) to be restricted.

Returns:

the owner password

setOwnerPassword

public final void setOwnerPassword(String value)

Sets owner password. The owner password and enables 128Bit encryption of PDF content. An owner password is one used to enable and disable all other security settings.

OwnerPassword must be set to a non empty string value for setAllowUserCopyPasteContent(Boolean), setAllowUserAnnotations(Boolean), setAllowUserFormData(Boolean) and setAllowUserEdits(PdfEditSecurity) to be restricted.

Parameters:

value - the value

getUserPassword

public final String getUserPassword()

Gets user password. The user password and enables 128Bit encryption of PDF content.

A user password is a password that each user must enter to open or print the PDF document.

Returns:

the user password

setUserPassword

public final void setUserPassword(String value)

Sets user password. The user password and enables 128Bit encryption of PDF content.

A user password is a password that each user must enter to open or print the PDF document.

Parameters:

value - the value