StandardProtectionPolicy (PDFBox reactor 2.0.8 API)

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

```
public final class StandardProtectionPolicy
extends ProtectionPolicy
```
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

Constructor Summary

Constructors
Constructor and Description
`StandardProtectionPolicy(String ownerPassword, String userPassword, AccessPermission permissions)` Creates an new instance of the standard protection policy in order to protect a PDF document with passwords.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getOwnerPassword()` Returns the owner password.
`AccessPermission`	`getPermissions()` Returns the access permissions
`String`	`getUserPassword()` Returns the user password.
`boolean`	`isPreferAES()` Tell whether AES encryption is preferred when several encryption methods are available for the chosen key length.
`void`	`setOwnerPassword(String ownerPassword)` Sets the owner password
`void`	`setPermissions(AccessPermission permissions)` Sets the access permissions
`void`	`setPreferAES(boolean preferAES)` Set whether AES encryption is preferred when several encryption methods are available for the chosen key length.
`void`	`setUserPassword(String userPassword)` Sets the user password.

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

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

- Constructor Detail
  - StandardProtectionPolicy
```
public StandardProtectionPolicy(String ownerPassword,
                        String userPassword,
                        AccessPermission permissions)
```
    Creates an new instance of the standard protection policy in order to protect a PDF document with passwords.
    
    Parameters:
    ownerPassword - The owner's password.
    userPassword - The users's password.
    permissions - The access permissions given to the user.
- Method Detail
  - getPermissions
```
public AccessPermission getPermissions()
```
    Returns the access permissions
    
    Returns:
    the access permissions
  - setPermissions
```
public void setPermissions(AccessPermission permissions)
```
    Sets the access permissions
    
    Parameters:
    permissions - the new access permissions
  - getOwnerPassword
```
public String getOwnerPassword()
```
    Returns the owner password.
    
    Returns:
    the owner password
  - setOwnerPassword
```
public void setOwnerPassword(String ownerPassword)
```
    Sets the owner password
    
    Parameters:
    ownerPassword - the new owner password
  - getUserPassword
```
public String getUserPassword()
```
    Returns the user password.
    
    Returns:
    the user password
  - setUserPassword
```
public void setUserPassword(String userPassword)
```
    Sets the user password.
    
    Parameters:
    userPassword - the new user password
  - isPreferAES
```
public boolean isPreferAES()
```
    Tell whether AES encryption is preferred when several encryption methods are available for the chosen key length. The default is false. This setting is only relevant if the key length is 128 bits.
    
    Returns:
    true if AES encryption is preferred
  - setPreferAES
```
public void setPreferAES(boolean preferAES)
```
    Set whether AES encryption is preferred when several encryption methods are available for the chosen key length. The default is false. This setting is only relevant if the key length is 128 bits.
    
    Parameters:
    preferAES -

Class StandardProtectionPolicy

Constructor Summary

Method Summary

Methods inherited from class org.apache.pdfbox.pdmodel.encryption.ProtectionPolicy

Methods inherited from class java.lang.Object

Constructor Detail

StandardProtectionPolicy

Method Detail

getPermissions

setPermissions

getOwnerPassword

setOwnerPassword

getUserPassword

setUserPassword

isPreferAES

setPreferAES