Package net.webpdf.wsclient.openapi
Class OperationEncrypt
- java.lang.Object
-
- net.webpdf.wsclient.openapi.OperationEncrypt
-
public class OperationEncrypt extends Object
These parameters can be used to set encryption for a PDF document.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOperationEncrypt.ContentEncryptionEnumSpecifies whether certain contents should be treated differently than others during encryption
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_CAN_ASSEMBLEstatic StringJSON_PROPERTY_CAN_EXTRACT_CONTENTstatic StringJSON_PROPERTY_CAN_EXTRACT_FOR_ACCESSIBILITYstatic StringJSON_PROPERTY_CAN_FILL_IN_FORMstatic StringJSON_PROPERTY_CAN_MODIFYstatic StringJSON_PROPERTY_CAN_MODIFY_ANNOTATIONSstatic StringJSON_PROPERTY_CAN_PRINTstatic StringJSON_PROPERTY_CAN_PRINT_HIGH_RESstatic StringJSON_PROPERTY_CONTENT_ENCRYPTIONstatic StringJSON_PROPERTY_PASSWORD
-
Constructor Summary
Constructors Constructor Description OperationEncrypt()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationEncryptcanAssemble(Boolean canAssemble)OperationEncryptcanExtractContent(Boolean canExtractContent)OperationEncryptcanExtractForAccessibility(Boolean canExtractForAccessibility)OperationEncryptcanFillInForm(Boolean canFillInForm)OperationEncryptcanModify(Boolean canModify)OperationEncryptcanModifyAnnotations(Boolean canModifyAnnotations)OperationEncryptcanPrint(Boolean canPrint)OperationEncryptcanPrintHighRes(Boolean canPrintHighRes)OperationEncryptcontentEncryption(OperationEncrypt.ContentEncryptionEnum contentEncryption)booleanequals(Object o)@Nullable BooleangetCanAssemble()If \"true,\" the document can be rearranged (e.g., pages can be deleted, inserted, and rotated).@Nullable BooleangetCanExtractContent()If \"true,\" content can be extracted (copied) from the document.@Nullable BooleangetCanExtractForAccessibility()If \"true,\" content can be extracted (copied) for accessibility purposes.@Nullable BooleangetCanFillInForm()If \"true,\" form fields can be filled out and the document can be signed.@Nullable BooleangetCanModify()If \"true,\" changes to the document are permitted.@Nullable BooleangetCanModifyAnnotations()If \"true,\" comments can be added to the document and deleted from the document.@Nullable BooleangetCanPrint()If \"true,\" the document can be printed.@Nullable BooleangetCanPrintHighRes()If \"true,\" the document can be printed at high resolution levels.@Nullable OperationEncrypt.ContentEncryptionEnumgetContentEncryption()Specifies whether certain contents should be treated differently than others during encryption@Nullable OperationPasswordEncryptgetPassword()Get passwordinthashCode()OperationEncryptpassword(OperationPasswordEncrypt password)voidsetCanAssemble(Boolean canAssemble)voidsetCanExtractContent(Boolean canExtractContent)voidsetCanExtractForAccessibility(Boolean canExtractForAccessibility)voidsetCanFillInForm(Boolean canFillInForm)voidsetCanModify(Boolean canModify)voidsetCanModifyAnnotations(Boolean canModifyAnnotations)voidsetCanPrint(Boolean canPrint)voidsetCanPrintHighRes(Boolean canPrintHighRes)voidsetContentEncryption(OperationEncrypt.ContentEncryptionEnum contentEncryption)voidsetPassword(OperationPasswordEncrypt password)StringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_CAN_ASSEMBLE
public static final String JSON_PROPERTY_CAN_ASSEMBLE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CAN_EXTRACT_CONTENT
public static final String JSON_PROPERTY_CAN_EXTRACT_CONTENT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CAN_EXTRACT_FOR_ACCESSIBILITY
public static final String JSON_PROPERTY_CAN_EXTRACT_FOR_ACCESSIBILITY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CAN_FILL_IN_FORM
public static final String JSON_PROPERTY_CAN_FILL_IN_FORM
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CAN_MODIFY
public static final String JSON_PROPERTY_CAN_MODIFY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CAN_MODIFY_ANNOTATIONS
public static final String JSON_PROPERTY_CAN_MODIFY_ANNOTATIONS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CAN_PRINT
public static final String JSON_PROPERTY_CAN_PRINT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CAN_PRINT_HIGH_RES
public static final String JSON_PROPERTY_CAN_PRINT_HIGH_RES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CONTENT_ENCRYPTION
public static final String JSON_PROPERTY_CONTENT_ENCRYPTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PASSWORD
public static final String JSON_PROPERTY_PASSWORD
- See Also:
- Constant Field Values
-
-
Method Detail
-
canAssemble
public OperationEncrypt canAssemble(Boolean canAssemble)
-
getCanAssemble
@Nullable public @Nullable Boolean getCanAssemble()
If \"true,\" the document can be rearranged (e.g., pages can be deleted, inserted, and rotated).- Returns:
- canAssemble
-
setCanAssemble
public void setCanAssemble(Boolean canAssemble)
-
canExtractContent
public OperationEncrypt canExtractContent(Boolean canExtractContent)
-
getCanExtractContent
@Nullable public @Nullable Boolean getCanExtractContent()
If \"true,\" content can be extracted (copied) from the document.- Returns:
- canExtractContent
-
setCanExtractContent
public void setCanExtractContent(Boolean canExtractContent)
-
canExtractForAccessibility
public OperationEncrypt canExtractForAccessibility(Boolean canExtractForAccessibility)
-
getCanExtractForAccessibility
@Nullable public @Nullable Boolean getCanExtractForAccessibility()
If \"true,\" content can be extracted (copied) for accessibility purposes.- Returns:
- canExtractForAccessibility
-
setCanExtractForAccessibility
public void setCanExtractForAccessibility(Boolean canExtractForAccessibility)
-
canFillInForm
public OperationEncrypt canFillInForm(Boolean canFillInForm)
-
getCanFillInForm
@Nullable public @Nullable Boolean getCanFillInForm()
If \"true,\" form fields can be filled out and the document can be signed.- Returns:
- canFillInForm
-
setCanFillInForm
public void setCanFillInForm(Boolean canFillInForm)
-
canModify
public OperationEncrypt canModify(Boolean canModify)
-
getCanModify
@Nullable public @Nullable Boolean getCanModify()
If \"true,\" changes to the document are permitted.- Returns:
- canModify
-
setCanModify
public void setCanModify(Boolean canModify)
-
canModifyAnnotations
public OperationEncrypt canModifyAnnotations(Boolean canModifyAnnotations)
-
getCanModifyAnnotations
@Nullable public @Nullable Boolean getCanModifyAnnotations()
If \"true,\" comments can be added to the document and deleted from the document.- Returns:
- canModifyAnnotations
-
setCanModifyAnnotations
public void setCanModifyAnnotations(Boolean canModifyAnnotations)
-
canPrint
public OperationEncrypt canPrint(Boolean canPrint)
-
getCanPrint
@Nullable public @Nullable Boolean getCanPrint()
If \"true,\" the document can be printed.- Returns:
- canPrint
-
setCanPrint
public void setCanPrint(Boolean canPrint)
-
canPrintHighRes
public OperationEncrypt canPrintHighRes(Boolean canPrintHighRes)
-
getCanPrintHighRes
@Nullable public @Nullable Boolean getCanPrintHighRes()
If \"true,\" the document can be printed at high resolution levels.- Returns:
- canPrintHighRes
-
setCanPrintHighRes
public void setCanPrintHighRes(Boolean canPrintHighRes)
-
contentEncryption
public OperationEncrypt contentEncryption(OperationEncrypt.ContentEncryptionEnum contentEncryption)
-
getContentEncryption
@Nullable public @Nullable OperationEncrypt.ContentEncryptionEnum getContentEncryption()
Specifies whether certain contents should be treated differently than others during encryption. * encryptEverything = All contents of the document are encrypted without distinction (if provided by the standard). * exposeMetadata = The document's metadata is left unencrypted to make it discoverable by processing programs. (Has an effect only for 128 bit and 256 bit AES).- Returns:
- contentEncryption
-
setContentEncryption
public void setContentEncryption(OperationEncrypt.ContentEncryptionEnum contentEncryption)
-
password
public OperationEncrypt password(OperationPasswordEncrypt password)
-
getPassword
@Nullable public @Nullable OperationPasswordEncrypt getPassword()
Get password- Returns:
- password
-
setPassword
public void setPassword(OperationPasswordEncrypt password)
-
-