java.lang.Object
- net.webpdf.wsclient.openapi.MetadataPassword

```
public class MetadataPassword
extends Object
```
An element of this type shall contain information concerning the used encryption and the used encryption key.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class MetadataPassword.KeyAlgorithmEnum
The algorithm used for encryption

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_HAS_ASYMMETRIC_ENCRYPTION`
`static String`	`JSON_PROPERTY_HAS_OPEN_PASSWORD`
`static String`	`JSON_PROPERTY_HAS_PERMISSION_PASSWORD`
`static String`	`JSON_PROPERTY_KEY_ALGORITHM`
`static String`	`JSON_PROPERTY_KEY_LENGTH`

Constructor Summary

Constructors
Constructor Description

MetadataPassword()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`@Nullable Boolean`	`getHasAsymmetricEncryption()`	If this is set to \"true\", the document is asymmetrically encrypted and a matching private key is required to decrypt it.
`@Nullable Boolean`	`getHasOpenPassword()`	If this is set to \"true\", the document is encrypted and requires a password to be opened.
`@Nullable Boolean`	`getHasPermissionPassword()`	If this is set to \"true\", the document has a change protection and a password is required to claim ownership and modify the document.
`@Nullable MetadataPassword.KeyAlgorithmEnum`	`getKeyAlgorithm()`	The algorithm used for encryption
`@Nullable Integer`	`getKeyLength()`	The Bit length of the key used for encryption.
`MetadataPassword`	`hasAsymmetricEncryption(Boolean hasAsymmetricEncryption)`
`int`	`hashCode()`
`MetadataPassword`	`hasOpenPassword(Boolean hasOpenPassword)`
`MetadataPassword`	`hasPermissionPassword(Boolean hasPermissionPassword)`
`MetadataPassword`	`keyAlgorithm(MetadataPassword.KeyAlgorithmEnum keyAlgorithm)`
`MetadataPassword`	`keyLength(Integer keyLength)`
`void`	`setHasAsymmetricEncryption(Boolean hasAsymmetricEncryption)`
`void`	`setHasOpenPassword(Boolean hasOpenPassword)`
`void`	`setHasPermissionPassword(Boolean hasPermissionPassword)`
`void`	`setKeyAlgorithm(MetadataPassword.KeyAlgorithmEnum keyAlgorithm)`
`void`	`setKeyLength(Integer keyLength)`
`String`	`toString()`

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

- Field Detail
  - JSON_PROPERTY_HAS_ASYMMETRIC_ENCRYPTION
```
public static final String JSON_PROPERTY_HAS_ASYMMETRIC_ENCRYPTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HAS_OPEN_PASSWORD
```
public static final String JSON_PROPERTY_HAS_OPEN_PASSWORD
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HAS_PERMISSION_PASSWORD
```
public static final String JSON_PROPERTY_HAS_PERMISSION_PASSWORD
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_KEY_ALGORITHM
```
public static final String JSON_PROPERTY_KEY_ALGORITHM
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_KEY_LENGTH
```
public static final String JSON_PROPERTY_KEY_LENGTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MetadataPassword
```
public MetadataPassword()
```
- Method Detail
  - hasAsymmetricEncryption
```
public MetadataPassword hasAsymmetricEncryption(Boolean hasAsymmetricEncryption)
```
  - getHasAsymmetricEncryption
```
@Nullable
public @Nullable Boolean getHasAsymmetricEncryption()
```
    If this is set to \"true\", the document is asymmetrically encrypted and a matching private key is required to decrypt it. Otherwise the document is symetrically encrypted and requires a password.
    
    Returns:
    
    hasAsymmetricEncryption
  - setHasAsymmetricEncryption
```
public void setHasAsymmetricEncryption(Boolean hasAsymmetricEncryption)
```
  - hasOpenPassword
```
public MetadataPassword hasOpenPassword(Boolean hasOpenPassword)
```
  - getHasOpenPassword
```
@Nullable
public @Nullable Boolean getHasOpenPassword()
```
    If this is set to \"true\", the document is encrypted and requires a password to be opened.
    
    Returns:
    
    hasOpenPassword
  - setHasOpenPassword
```
public void setHasOpenPassword(Boolean hasOpenPassword)
```
  - hasPermissionPassword
```
public MetadataPassword hasPermissionPassword(Boolean hasPermissionPassword)
```
  - getHasPermissionPassword
```
@Nullable
public @Nullable Boolean getHasPermissionPassword()
```
    If this is set to \"true\", the document has a change protection and a password is required to claim ownership and modify the document.
    
    Returns:
    
    hasPermissionPassword
  - setHasPermissionPassword
```
public void setHasPermissionPassword(Boolean hasPermissionPassword)
```
  - keyAlgorithm
```
public MetadataPassword keyAlgorithm(MetadataPassword.KeyAlgorithmEnum keyAlgorithm)
```
  - getKeyAlgorithm
```
@Nullable
public @Nullable MetadataPassword.KeyAlgorithmEnum getKeyAlgorithm()
```
    The algorithm used for encryption. * none = The document is not encrypted. * aes = The document has been encrypted using the Advanced Encryption Standard. * rc4 = The document has been encrypted using the RC4 cipher.
    
    Returns:
    
    keyAlgorithm
  - setKeyAlgorithm
```
public void setKeyAlgorithm(MetadataPassword.KeyAlgorithmEnum keyAlgorithm)
```
  - keyLength
```
public MetadataPassword keyLength(Integer keyLength)
```
  - getKeyLength
```
@Nullable
public @Nullable Integer getKeyLength()
```
    The Bit length of the key used for encryption. minimum: 0
    
    Returns:
    
    keyLength
  - setKeyLength
```
public void setKeyLength(Integer keyLength)
```
  - 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

Class MetadataPassword

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_HAS_ASYMMETRIC_ENCRYPTION

JSON_PROPERTY_HAS_OPEN_PASSWORD

JSON_PROPERTY_HAS_PERMISSION_PASSWORD

JSON_PROPERTY_KEY_ALGORITHM

JSON_PROPERTY_KEY_LENGTH

Constructor Detail

MetadataPassword

Method Detail

hasAsymmetricEncryption

getHasAsymmetricEncryption

setHasAsymmetricEncryption

hasOpenPassword

getHasOpenPassword

setHasOpenPassword

hasPermissionPassword

getHasPermissionPassword

setHasPermissionPassword

keyAlgorithm

getKeyAlgorithm

setKeyAlgorithm

keyLength

getKeyLength

setKeyLength

equals

hashCode

toString