com.aspose.words

Class PdfEncryptionDetails

java.lang.Object

com.aspose.words.PdfEncryptionDetails

public class PdfEncryptionDetails
extends java.lang.Object

Contains details for encrypting and access permissions for a PDF document.

To learn more, visit the Protect or Encrypt a Document documentation article.

Examples:

Shows how to set permissions on a saved PDF document.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.writeln("Hello world!");

 // Extend permissions to allow the editing of annotations.
 PdfEncryptionDetails encryptionDetails =
         new PdfEncryptionDetails("password", "", PdfPermissions.MODIFY_ANNOTATIONS | PdfPermissions.DOCUMENT_ASSEMBLY);

 // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
 // to modify how that method converts the document to .PDF.
 PdfSaveOptions saveOptions = new PdfSaveOptions();

 // Enable encryption via the "EncryptionDetails" property.
 saveOptions.setEncryptionDetails(encryptionDetails);

 // When we open this document, we will need to provide the password before accessing its contents.
 doc.save(getArtifactsDir() + "PdfSaveOptions.EncryptionPermissions.pdf", saveOptions);
 
 

Constructor Summary

Constructors

Constructor and Description
PdfEncryptionDetails(java.lang.String userPassword, java.lang.String ownerPassword) Initializes an instance of this class.
PdfEncryptionDetails(java.lang.String userPassword, java.lang.String ownerPassword, int permissions) Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOwnerPassword() Specifies the owner password for the encrypted PDF document.
int	getPermissions() Specifies the operations that are allowed to a user on an encrypted PDF document.
java.lang.String	getUserPassword() Specifies the user password required for opening the encrypted PDF document.
void	setOwnerPassword(java.lang.String value) Specifies the owner password for the encrypted PDF document.
void	setPermissions(int value) Specifies the operations that are allowed to a user on an encrypted PDF document.
void	setUserPassword(java.lang.String value) Specifies the user password required for opening the encrypted PDF document.

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfEncryptionDetails

public PdfEncryptionDetails(java.lang.String userPassword,
                            java.lang.String ownerPassword)

Initializes an instance of this class.

PdfEncryptionDetails

public PdfEncryptionDetails(java.lang.String userPassword,
                            java.lang.String ownerPassword,
                            int permissions)

Initializes a new instance of this class.

Method Detail

getUserPassword

public java.lang.String getUserPassword()

Specifies the user password required for opening the encrypted PDF document.

Remarks:

The user password will be required to open an encrypted PDF document for viewing. The permissions specified in getPermissions() / setPermissions(int) will be enforced by the reader software.

The user password can be null or empty string, in this case no password will be required from the user when opening the PDF document. The user password cannot be the same as the owner password.

Examples:

Shows how to set permissions on a saved PDF document.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.writeln("Hello world!");

 // Extend permissions to allow the editing of annotations.
 PdfEncryptionDetails encryptionDetails =
         new PdfEncryptionDetails("password", "", PdfPermissions.MODIFY_ANNOTATIONS | PdfPermissions.DOCUMENT_ASSEMBLY);

 // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
 // to modify how that method converts the document to .PDF.
 PdfSaveOptions saveOptions = new PdfSaveOptions();

 // Enable encryption via the "EncryptionDetails" property.
 saveOptions.setEncryptionDetails(encryptionDetails);

 // When we open this document, we will need to provide the password before accessing its contents.
 doc.save(getArtifactsDir() + "PdfSaveOptions.EncryptionPermissions.pdf", saveOptions);
 
 

Returns:

The corresponding String value.

setUserPassword

public void setUserPassword(java.lang.String value)

Specifies the user password required for opening the encrypted PDF document.

Remarks:

The user password will be required to open an encrypted PDF document for viewing. The permissions specified in getPermissions() / setPermissions(int) will be enforced by the reader software.

The user password can be null or empty string, in this case no password will be required from the user when opening the PDF document. The user password cannot be the same as the owner password.

Examples:

Shows how to set permissions on a saved PDF document.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.writeln("Hello world!");

 // Extend permissions to allow the editing of annotations.
 PdfEncryptionDetails encryptionDetails =
         new PdfEncryptionDetails("password", "", PdfPermissions.MODIFY_ANNOTATIONS | PdfPermissions.DOCUMENT_ASSEMBLY);

 // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
 // to modify how that method converts the document to .PDF.
 PdfSaveOptions saveOptions = new PdfSaveOptions();

 // Enable encryption via the "EncryptionDetails" property.
 saveOptions.setEncryptionDetails(encryptionDetails);

 // When we open this document, we will need to provide the password before accessing its contents.
 doc.save(getArtifactsDir() + "PdfSaveOptions.EncryptionPermissions.pdf", saveOptions);
 
 

Parameters:

value - The corresponding String value.

getOwnerPassword

public java.lang.String getOwnerPassword()

Specifies the owner password for the encrypted PDF document.

Remarks:

The owner password allows the user to open an encrypted PDF document without any access restrictions specified in getPermissions() / setPermissions(int).

The owner password cannot be the same as the user password.

Examples:

Shows how to set permissions on a saved PDF document.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.writeln("Hello world!");

 // Extend permissions to allow the editing of annotations.
 PdfEncryptionDetails encryptionDetails =
         new PdfEncryptionDetails("password", "", PdfPermissions.MODIFY_ANNOTATIONS | PdfPermissions.DOCUMENT_ASSEMBLY);

 // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
 // to modify how that method converts the document to .PDF.
 PdfSaveOptions saveOptions = new PdfSaveOptions();

 // Enable encryption via the "EncryptionDetails" property.
 saveOptions.setEncryptionDetails(encryptionDetails);

 // When we open this document, we will need to provide the password before accessing its contents.
 doc.save(getArtifactsDir() + "PdfSaveOptions.EncryptionPermissions.pdf", saveOptions);
 
 

Returns:

The corresponding String value.

setOwnerPassword

public void setOwnerPassword(java.lang.String value)

Specifies the owner password for the encrypted PDF document.

Remarks:

The owner password allows the user to open an encrypted PDF document without any access restrictions specified in getPermissions() / setPermissions(int).

The owner password cannot be the same as the user password.

Examples:

Shows how to set permissions on a saved PDF document.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.writeln("Hello world!");

 // Extend permissions to allow the editing of annotations.
 PdfEncryptionDetails encryptionDetails =
         new PdfEncryptionDetails("password", "", PdfPermissions.MODIFY_ANNOTATIONS | PdfPermissions.DOCUMENT_ASSEMBLY);

 // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
 // to modify how that method converts the document to .PDF.
 PdfSaveOptions saveOptions = new PdfSaveOptions();

 // Enable encryption via the "EncryptionDetails" property.
 saveOptions.setEncryptionDetails(encryptionDetails);

 // When we open this document, we will need to provide the password before accessing its contents.
 doc.save(getArtifactsDir() + "PdfSaveOptions.EncryptionPermissions.pdf", saveOptions);
 
 

Parameters:

value - The corresponding String value.

getPermissions

public int getPermissions()

Specifies the operations that are allowed to a user on an encrypted PDF document. The default value is PdfPermissions.DISALLOW_ALL.

Examples:

Shows how to set permissions on a saved PDF document.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.writeln("Hello world!");

 // Extend permissions to allow the editing of annotations.
 PdfEncryptionDetails encryptionDetails =
         new PdfEncryptionDetails("password", "", PdfPermissions.MODIFY_ANNOTATIONS | PdfPermissions.DOCUMENT_ASSEMBLY);

 // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
 // to modify how that method converts the document to .PDF.
 PdfSaveOptions saveOptions = new PdfSaveOptions();

 // Enable encryption via the "EncryptionDetails" property.
 saveOptions.setEncryptionDetails(encryptionDetails);

 // When we open this document, we will need to provide the password before accessing its contents.
 doc.save(getArtifactsDir() + "PdfSaveOptions.EncryptionPermissions.pdf", saveOptions);
 
 

Returns:

The corresponding int value. The returned value is a bitwise combination of PdfPermissions constants.

setPermissions

public void setPermissions(int value)

Specifies the operations that are allowed to a user on an encrypted PDF document. The default value is PdfPermissions.DISALLOW_ALL.

Examples:

Shows how to set permissions on a saved PDF document.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.writeln("Hello world!");

 // Extend permissions to allow the editing of annotations.
 PdfEncryptionDetails encryptionDetails =
         new PdfEncryptionDetails("password", "", PdfPermissions.MODIFY_ANNOTATIONS | PdfPermissions.DOCUMENT_ASSEMBLY);

 // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
 // to modify how that method converts the document to .PDF.
 PdfSaveOptions saveOptions = new PdfSaveOptions();

 // Enable encryption via the "EncryptionDetails" property.
 saveOptions.setEncryptionDetails(encryptionDetails);

 // When we open this document, we will need to provide the password before accessing its contents.
 doc.save(getArtifactsDir() + "PdfSaveOptions.EncryptionPermissions.pdf", saveOptions);
 
 

Parameters:

value - The corresponding int value. The value must be a bitwise combination of PdfPermissions constants.