Package net.webpdf.wsclient.openapi
Class OperationRecipient
- java.lang.Object
-
- net.webpdf.wsclient.openapi.OperationRecipient
-
public class OperationRecipient extends Object
Defines a rights recipient (Recipient) for the document to be encrypted. Recipients are defined on the basis of their rights and a certificate and are identified and distinguished on the basis of the certificate. Only with the associated \"PrivateKey\" and a certificate listed here can a user subsequently decrypt and open the document again. Exactly one certificate is expected for encryption for each rights recipient. However, it is possible to define multiple rights recipients * each with their own certificate.
-
-
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_CERTIFICATE
-
Constructor Summary
Constructors Constructor Description OperationRecipient()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationRecipientcanAssemble(Boolean canAssemble)OperationRecipientcanExtractContent(Boolean canExtractContent)OperationRecipientcanExtractForAccessibility(Boolean canExtractForAccessibility)OperationRecipientcanFillInForm(Boolean canFillInForm)OperationRecipientcanModify(Boolean canModify)OperationRecipientcanModifyAnnotations(Boolean canModifyAnnotations)OperationRecipientcanPrint(Boolean canPrint)OperationRecipientcanPrintHighRes(Boolean canPrintHighRes)OperationRecipientcertificate(OperationCertificateFileData certificate)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.@NotNull OperationCertificateFileDatagetCertificate()Get certificateinthashCode()voidsetCanAssemble(Boolean canAssemble)voidsetCanExtractContent(Boolean canExtractContent)voidsetCanExtractForAccessibility(Boolean canExtractForAccessibility)voidsetCanFillInForm(Boolean canFillInForm)voidsetCanModify(Boolean canModify)voidsetCanModifyAnnotations(Boolean canModifyAnnotations)voidsetCanPrint(Boolean canPrint)voidsetCanPrintHighRes(Boolean canPrintHighRes)voidsetCertificate(OperationCertificateFileData certificate)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_CERTIFICATE
public static final String JSON_PROPERTY_CERTIFICATE
- See Also:
- Constant Field Values
-
-
Method Detail
-
canAssemble
public OperationRecipient 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 OperationRecipient 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 OperationRecipient 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 OperationRecipient 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 OperationRecipient 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 OperationRecipient 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 OperationRecipient 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 OperationRecipient 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)
-
certificate
public OperationRecipient certificate(OperationCertificateFileData certificate)
-
getCertificate
@NotNull public @NotNull OperationCertificateFileData getCertificate()
Get certificate- Returns:
- certificate
-
setCertificate
public void setCertificate(OperationCertificateFileData certificate)
-
-