PdfEncryption (Gnostice PDFOne (for Java) API Docs)

java.lang.Object
- com.gnostice.pdfone.PdfEncryption

```
public class PdfEncryption
extends Object
```
This class is used to specify the encryption settings and access permissions for a document.

Since:

1.0

Example

See example.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AllowAccessibility` User access permission for extracting text and graphics meant for applications such as those providing accessibility to people with disabilities.
`static int`	`AllowAssembly` User access permission for assembling the document, including inserting, rotating, or deleting pages and creating bookmarks or thumbnail images.
`static int`	`AllowCopy` User access permission for copying or extracting of all text and graphics but not including those allowed by `AllowAccessibility`.
`static int`	`AllowFormFill` User access permission for filling in existing form fields (including signature fields).
`static int`	`AllowHighResPrint` User access permission for printing a document in high resolution.
`static int`	`AllowModifyAnnotations` User access permission for adding or modifying text annotations, filling in existing interactive form fields, and (if `AllowModifyContents` is also set) creating new or modifying existing interactive form fields including signature fields
`static int`	`AllowModifyContents` User access permission for modifying the document in ways not including those allowed by `AllowModifyAnnotations`, `AllowFormFill`, and `AllowAssembly`.
`static int`	`AllowPrinting` User access permission for printing the document.
`static int`	`LEVEL_128_BIT` Encryption key length of 128 bits.
`static int`	`LEVEL_40_BIT` Encryption key length of 40 bits.
`static int`	`LEVEL_AES_128BIT`
`static int`	`LEVEL_RC4_128BIT`
`static int`	`LEVEL_RC4_40BIT`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getLevel()`
`String`	`getOwnerPwd()` Returns owner password specified for this `PdfEncryption` object.
`int`	`getPermissions()` Returns user access permissions specified for this `PdfEncryption` object.
`String`	`getUserPwd()` Returns user password specified for this `PdfEncryption` object.
`void`	`setLevel(int level)` Specifies encryption key length for this `PdfEncryption` object.
`void`	`setOwnerPwd(String ownerPwd)` Specifies owner password for this `PdfEncryption` object.
`void`	`setPermissions(int permissions)` Specifies user access permissions for this `PdfEncryption` object.
`void`	`setUserPwd(String userPwd)` Specifies user password for this `PdfEncryption` object.

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

- Field Detail
  - LEVEL_40_BIT
```
public static final int LEVEL_40_BIT
```
    Encryption key length of 40 bits.
    
    See Also:
    
    Constant Field Values
  - LEVEL_128_BIT
```
public static final int LEVEL_128_BIT
```
    Encryption key length of 128 bits.
    
    See Also:
    
    Constant Field Values
  - LEVEL_RC4_40BIT
```
public static final int LEVEL_RC4_40BIT
```
    See Also:
    
    Constant Field Values
  - LEVEL_RC4_128BIT
```
public static final int LEVEL_RC4_128BIT
```
    See Also:
    
    Constant Field Values
  - LEVEL_AES_128BIT
```
public static final int LEVEL_AES_128BIT
```
    See Also:
    
    Constant Field Values
  - AllowPrinting
```
public static final int AllowPrinting
```
    User access permission for printing the document. If AllowHighResPrint is not set, then printing may be at a low resolution or quality.
    
    See Also:
    
    Constant Field Values
  - AllowModifyContents
```
public static final int AllowModifyContents
```
    User access permission for modifying the document in ways not including those allowed by AllowModifyAnnotations, AllowFormFill, and AllowAssembly.
    
    See Also:
    
    Constant Field Values
  - AllowCopy
```
public static final int AllowCopy
```
    User access permission for copying or extracting of all text and graphics but not including those allowed by AllowAccessibility.
    
    See Also:
    
    Constant Field Values
  - AllowModifyAnnotations
```
public static final int AllowModifyAnnotations
```
    User access permission for
    1. adding or modifying text annotations,
    2. filling in existing interactive form fields, and
    3. (if AllowModifyContents is also set) creating new or modifying existing interactive form fields including signature fields
    See Also:
    
    Constant Field Values
  - AllowFormFill
```
public static final int AllowFormFill
```
    User access permission for filling in existing form fields (including signature fields). This permission does not require that AllowModifyAnnotations also need to be permitted.
    
    See Also:
    
    Constant Field Values
  - AllowAccessibility
```
public static final int AllowAccessibility
```
    User access permission for extracting text and graphics meant for applications such as those providing accessibility to people with disabilities.
    
    See Also:
    
    Constant Field Values
  - AllowAssembly
```
public static final int AllowAssembly
```
    User access permission for assembling the document, including inserting, rotating, or deleting pages and creating bookmarks or thumbnail images. This permission does not require that AllowModifyContents also be permitted.
    
    See Also:
    
    Constant Field Values
  - AllowHighResPrint
```
public static final int AllowHighResPrint
```
    User access permission for printing a document in high resolution. If not set, the document is likely to be printed with a lesser quality of appearance.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getLevel
```
public int getLevel()
```
  - setLevel
```
public void setLevel(int level)
```
    Specifies encryption key length for this PdfEncryption object.
    
    Parameters:
    
    level - constant specifying the encryption key length for this PdfEncryption object
    
    Since:
    
    1.0
    
    Example
    
    See example.
  - getOwnerPwd
```
public String getOwnerPwd()
```
    Returns owner password specified for this PdfEncryption object.
    
    Returns:
    
    owner password specified for the PdfEncryption object
    
    Since:
    
    1.0
  - setOwnerPwd
```
public void setOwnerPwd(String ownerPwd)
```
    Specifies owner password for this PdfEncryption object.
    
    Parameters:
    
    ownerPwd - owner password for the PdfEncryption object
    
    Since:
    
    1.0
    
    Example
    
    See example.
  - getPermissions
```
public int getPermissions()
```
    Returns user access permissions specified for this PdfEncryption object.
    
    Returns:
    
    constant or combined value of constants representing user access permissions specified for the PdfEncryption object
    
    Since:
    
    1.0
  - setPermissions
```
public void setPermissions(int permissions)
```
    Specifies user access permissions for this PdfEncryption object.
    
    Parameters:
    
    permissions - constants or combined value of constant specifying user access permissions for this PdfEncryption object
    
    Since:
    
    1.0
    
    Example
    
    See example.
  - getUserPwd
```
public String getUserPwd()
```
    Returns user password specified for this PdfEncryption object.
    
    Returns:
    
    user password specified for the PdfEncryption object
    
    Since:
    
    1.0
  - setUserPwd
```
public void setUserPwd(String userPwd)
```
    Specifies user password for this PdfEncryption object.
    
    Parameters:
    
    userPwd - user password for the PdfEncryption object
    
    Since:
    
    1.0
    
    Example
    
    See example.

Class PdfEncryption

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LEVEL_40_BIT

LEVEL_128_BIT

LEVEL_RC4_40BIT

LEVEL_RC4_128BIT

LEVEL_AES_128BIT

AllowPrinting

AllowModifyContents

AllowCopy

AllowModifyAnnotations

AllowFormFill

AllowAccessibility

AllowAssembly

AllowHighResPrint

Method Detail

getLevel

setLevel

getOwnerPwd

setOwnerPwd

getPermissions

setPermissions

getUserPwd

setUserPwd