Package net.webpdf.wsclient.openapi

Class OperationPdfPassword

java.lang.Object

net.webpdf.wsclient.openapi.OperationPdfPassword

public class OperationPdfPassword
extends Object

The `password` element can be used to set the user and owner passwords or certificates for the PDF document which are needed if the PDF document is protected. For example, if a protected PDF document is to be edited with the web service, then these settings can be used to provide the password or certificates for access.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
OperationPdfPassword()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@Nullable OperationKeyPair	getKeyPair()	Get keyPair
@Nullable String	getOpen()	A password that is required to open the document.
@Nullable String	getPermission()	A password that allows \"editing access\" to the document.
int	hashCode()
OperationPdfPassword	keyPair(OperationKeyPair keyPair)
OperationPdfPassword	open(String open)
OperationPdfPassword	permission(String permission)
void	setKeyPair(OperationKeyPair keyPair)
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_KEY_PAIR

public static final String JSON_PROPERTY_KEY_PAIR

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

OperationPdfPassword

public OperationPdfPassword()

Method Detail

keyPair

public OperationPdfPassword keyPair(OperationKeyPair keyPair)

getKeyPair

@Nullable
public @Nullable OperationKeyPair getKeyPair()

Get keyPair

Returns:

keyPair

setKeyPair

public void setKeyPair(OperationKeyPair keyPair)

open

public OperationPdfPassword open(String open)

getOpen

@Nullable
public @Nullable String getOpen()

A password that is required to open the document. If the provided PDF document is protected in such a way that a password (user password) is required to read the document, the corresponding password must also be passed. Without this password it is not possible to edit the document with the web service, because it cannot be read.

Returns:

open

setOpen

public void setOpen(String open)

permission

public OperationPdfPassword permission(String permission)

getPermission

@Nullable
public @Nullable String getPermission()

A password that allows \"editing access\" to the document. If the provided PDF document is password protected and the web service operation is to edit the document, then the appropriate password (owner password) must be provided to unlock the document.

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