Package net.webpdf.wsclient.openapi

Class OperationAddSignature

  • public class OperationAddSignature
extends Object
    Used to add a new signature to the PDF document.

    • Constructor Detail

      • OperationAddSignature

        public OperationAddSignature()

    • Method Detail

      • getAppearance

        @Nullable
public @Nullable OperationAppearanceAdd getAppearance()
        Get appearance
        Returns:
        appearance

      • getAppendSignature

        @Nullable
public @Nullable Boolean getAppendSignature()
        **Deprecated:** Usage of this parameter is discouraged, as it is no longer in use.
        Returns:
        appendSignature

      • setAppendSignature

        public void setAppendSignature​(Boolean appendSignature)

      • getCertificationLevel

        @Nullable
public @Nullable OperationAddSignature.CertificationLevelEnum getCertificationLevel()
        This parameter defines the level of the signature. * none = Sign, but do not certify, the document, i.e., additional signatures and changes will be allowed. * noChanges = Certify the document and do not allow any additional changes anymore. * formFillingAndSignatures = Certify the document, but allow for fields to be filled out. * formFillingAndSignaturesAndAnnotations = Certify the document, but allow for fields to be filled out and annotations to be added.
        Returns:
        certificationLevel

      • getContact

        @Nullable
public @Nullable String getContact()
        Specifies the name of the person signing the document.
        Returns:
        contact

      • setContact

        public void setContact​(String contact)

      • getFieldName

        @Nullable
public @Nullable String getFieldName()
        Defines the name of the field (in the document) in which the signature will be saved. If a field name that is not unique is declared, then a unique name will be automatically created.
        Returns:
        fieldName

      • setFieldName

        public void setFieldName​(String fieldName)

      • getKeyName

        @Nullable
public @Nullable String getKeyName()
        Defines the name of the key (alias) that is to be used to sign the document. This option overwrites the server's configuration setting. Additional information can be found in the \"Keystore\" chapter.
        Returns:
        keyName

      • setKeyName

        public void setKeyName​(String keyName)

      • getKeyPassword

        @Nullable
public @Nullable String getKeyPassword()
        Used to define the password required in order to access the private key with \"keyName.\" This option overwrites the server's configuration setting. Additional information can be found in the \"Keystore\" chapter.
        Returns:
        keyPassword

      • setKeyPassword

        public void setKeyPassword​(String keyPassword)

      • getLocation

        @Nullable
public @Nullable String getLocation()
        Specifies the location of the signature.
        Returns:
        location

      • setLocation

        public void setLocation​(String location)

      • getReason

        @Nullable
public @Nullable String getReason()
        Specifies the reason why the document is being signed.
        Returns:
        reason

      • setReason

        public void setReason​(String reason)

      • getSigner

        @Nullable
public @Nullable OperationSignerAdd getSigner()
        Get signer
        Returns:
        signer

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object