Package net.webpdf.wsclient.openapi

Class OperationPasswordEncrypt

java.lang.Object

net.webpdf.wsclient.openapi.OperationPasswordEncrypt

public class OperationPasswordEncrypt
extends Object

Used to set the password for encryption and the encryption key length.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationPasswordEncrypt.EncryptionKeyEnum	Sets the encryption level for the document

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_ENCRYPTION_KEY
static String	JSON_PROPERTY_OPEN
static String	JSON_PROPERTY_PERMISSION

Constructor Summary

Constructors

Constructor	Description
OperationPasswordEncrypt()

Method Summary

Modifier and Type	Method	Description
OperationPasswordEncrypt	encryptionKey(OperationPasswordEncrypt.EncryptionKeyEnum encryptionKey)
boolean	equals(Object o)
@Nullable OperationPasswordEncrypt.EncryptionKeyEnum	getEncryptionKey()	Sets the encryption level for the document
@Nullable String	getOpen()	Used to set the password that will be requested if the PDF document is opened for reading.
@Nullable String	getPermission()	Used to set the password that will be requested if the file is opened for editing (e.g., when removing pages).
int	hashCode()
OperationPasswordEncrypt	open(String open)
OperationPasswordEncrypt	permission(String permission)
void	setEncryptionKey(OperationPasswordEncrypt.EncryptionKeyEnum encryptionKey)
void	setOpen(String open)
void	setPermission(String permission)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_ENCRYPTION_KEY

public static final String JSON_PROPERTY_ENCRYPTION_KEY

See Also:

Constant Field Values

JSON_PROPERTY_OPEN

public static final String JSON_PROPERTY_OPEN

See Also:

Constant Field Values

JSON_PROPERTY_PERMISSION

public static final String JSON_PROPERTY_PERMISSION

See Also:

Constant Field Values

Constructor Detail

OperationPasswordEncrypt

public OperationPasswordEncrypt()

Method Detail

encryptionKey

public OperationPasswordEncrypt encryptionKey(OperationPasswordEncrypt.EncryptionKeyEnum encryptionKey)

getEncryptionKey

@Nullable
public @Nullable OperationPasswordEncrypt.EncryptionKeyEnum getEncryptionKey()

Sets the encryption level for the document. * RC4\\_40 = 40-bit RC4 * RC4\\_128 = 128-bit RC4 * AES\\_128 = 128-bit AES * AES\\_256 = 256-bit AES **Important:** Please note that the option \"256-bit AES\" only works if the \"Java Cryptography Extension (JCE)\" has been enabled with \"Unlimited Strength\" in the JVM. You can obtain the modified \"Policy Files\" (along with instructions for installation) from the Oracle website: Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files 7 Download: http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html

Returns:

encryptionKey

setEncryptionKey

public void setEncryptionKey(OperationPasswordEncrypt.EncryptionKeyEnum encryptionKey)

open

public OperationPasswordEncrypt open(String open)

getOpen

@Nullable
public @Nullable String getOpen()

Used to set the password that will be requested if the PDF document is opened for reading.

Returns:

open

setOpen

public void setOpen(String open)

permission

public OperationPasswordEncrypt permission(String permission)

getPermission

@Nullable
public @Nullable String getPermission()

Used to set the password that will be requested if the file is opened for editing (e.g., when removing pages). The password is required to enable the individual access permissions and must not be blank if the access permissions are to be used. **Important:** Please note that the password and the associated access permissions will only provide protection if an appropriate display program for PDF documents takes these settings into account.

Returns:

permission

setPermission

public void setPermission(String permission)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object