org.apache.pdfbox.pdmodel.encryption: public class: StandardProtectionPolicy

org.apache.pdfbox.pdmodel.encryption
public class: StandardProtectionPolicy [javadoc | source]

java.lang.Object
   org.apache.pdfbox.pdmodel.encryption.ProtectionPolicy
      org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy

This class represents the protection policy to add to a document for password-based protection. The following example shows how to protect a PDF document with password. In this example, the document will be protected so that someone opening the document with the user password user_pwd will not be able to modify the document.

AccessPermission ap = new AccessPermission();
ap.setCanModify(false);
StandardProtectionPolicy policy = new StandardProtectionPolicy(owner_pwd, user_pwd, ap);
doc.protect(policy);

author: Benoit - Guillon (benoit.guillon@snv.jussieu.fr)

version: $ - Revision: 1.3 $

Constructor:

Constructor:
public StandardProtectionPolicy(String ownerPass, String userPass, AccessPermission perms) { this.permissions = perms; this.userPassword = userPass; this.ownerPassword = ownerPass; } Creates an new instance of the standard protection policy in order to protect a PDF document with passwords. Parameters: `ownerPass` - The owner's password. `userPass` - The users's password. `perms` - The access permissions given to the user.

 public StandardProtectionPolicy(String ownerPass,
    String userPass,
    AccessPermission perms) {
        this.permissions = perms;
        this.userPassword = userPass;
        this.ownerPassword = ownerPass;
}

Creates an new instance of the standard protection policy in order to protect a PDF document with passwords.

Parameters:

ownerPass - The owner's password.

userPass - The users's password.

perms - The access permissions given to the user.

Method from org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy Summary:
getOwnerPassword, getPermissions, getUserPassword, setOwnerPassword, setPermissions, setUserPassword

Methods from org.apache.pdfbox.pdmodel.encryption.ProtectionPolicy:
getEncryptionKeyLength, setEncryptionKeyLength

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

Method from org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy Detail:
public String getOwnerPassword() { return ownerPassword; } Getter of the property `ownerPassword`.
public AccessPermission getPermissions() { return permissions; } Getter of the property `permissions`.
public String getUserPassword() { return userPassword; } Getter of the property `userPassword`.
public void setOwnerPassword(String ownerPass) { this.ownerPassword = ownerPass; } Setter of the property `ownerPassword`.
public void setPermissions(AccessPermission perms) { this.permissions = perms; } Setter of the property `permissions`.
public void setUserPassword(String userPass) { this.userPassword = userPass; } Setter of the property `userPassword`.

Method from org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy Detail:

 public String getOwnerPassword() {
        return ownerPassword;
}

ownerPassword

 public AccessPermission getPermissions() {
        return permissions;
}

permissions

 public String getUserPassword() {
        return userPassword;
}

userPassword

 public  void setOwnerPassword(String ownerPass) {
        this.ownerPassword = ownerPass;
}

ownerPassword

 public  void setPermissions(AccessPermission perms) {
        this.permissions = perms;
}

permissions

 public  void setUserPassword(String userPass) {
        this.userPassword = userPass;
}

userPassword