SigningInformation (Qoppa jPDFFields API)

java.lang.Object
- com.qoppa.pdf.SigningInformation

```
public class SigningInformation
extends Object
```
Object that holds information necessary to digitally sign a PDF file. This object is normally used by the host application to set the information that the library needs to sign a PDF file.

Author:

Qoppa Software

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FORMAT_DOCUMENT_TIMESTAMP` Signature format for Document Timestamp
`static int`	`FORMAT_PADES` Signature format for PAdES.
`static int`	`FORMAT_PKCS7` Signature format for PKCS7.
`static int`	`PERM_FORMFILL_SIGNATURE` Certifying signature permission to allow form fill and signing.
`static int`	`PERM_FORMFILL_SIGNATURE_COMMENTS` Certifying signature permission to allow form fill, signing, and comments.
`static int`	`PERM_NOCHANGES` Certifying signature permission to indicate the document is intended to be final.

Constructor Summary

Constructors
Constructor and Description
`SigningInformation(org.bouncycastle.operator.ContentSigner signer, Certificate signerCert, Certificate[] certChain)` Constructs a SigningInformation object that will use an external content signer.
`SigningInformation(KeyStore ks, String entryAlias, String aliasPWD)` Constructs a SigningInformation object and gets the digital ID from a Java KeyStore object.
`SigningInformation(PrivateKey pk, Certificate signerCert, Certificate[] certChain, String provider)` Constructs a SigningInformation object given a private key, signer certificate and certificate chain.
`SigningInformation(String pkcs12File, String ksPWD, String entryAlias, String aliasPWD)` Constructs a SigningInformation object and gets the digital ID from a named PKCS#12 file.
`SigningInformation(TimestampServer timestampServer)` Constructs a SigningInformation object with only a TimestampServer.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Certificate[]`	`getCertificateChain()` Returns the certificate chain for the issuers of the certificate in the key store.
`String`	`getContactInformation()` Returns the contact information used in the signature.
`org.bouncycastle.operator.ContentSigner`	`getContentSigner()` Deprecated. Use `getContentSigner(String)`
`org.bouncycastle.operator.ContentSigner`	`getContentSigner(String pdfVersion)` Get the content signer based on the PDF file version.
`Map<String,String>`	`getCustomProperties()` Returns the custom properties table.
`String`	`getCustomProperty(String key)` This method can be used to retrieve the values of custom properties
`String`	`getJCEProvider()` Deprecated.
`String`	`getLocation()` Gets the location to be used in the signature.
`int`	`getPermissions()` Returns the level of permissions for a certifying signature.
`PrivateKey`	`getPrivateKey()` Deprecated.
`String`	`getReason()` Gets the reason for signing to be used in the signature.
`SignatureAppearance`	`getSignatureAppearance()` Returns the `SignatureAppearance` to use when creating the signature appearance stream.
`int`	`getSignatureFormat()` Returns the format of the signature.
`Certificate`	`getSignerCertificate()` Returns the certificate for the digital id retrieved from the KeyStore or the PKCS#12 file.
`TimestampServer`	`getTimestampServer()` Returns the Timestamp Server information
`boolean`	`isCertifyingSignature()` Returns true if this is a certifying signature.
`boolean`	`isLock()` Returns true if fields will be locked when the signature is applied.
`void`	`setCertifyingSignature(boolean certifyingSignature)` To create a certifying signature, set this property to true.
`void`	`setContactInformation(String contactInformation)` Sets the contact information to be used in the signature.
`void`	`setCustomProperty(String key, String value)` This method can be used to add additional custom properties to the signature dictionary.
`void`	`setLocation(String location)` Sets the location to be used in the signature.
`void`	`setLock(boolean lock)` Set the lock to true to lock fields when the signature is applied.
`void`	`setPermissions(int permissions)` This property is meaningful only if this is a certifying signature.
`void`	`setReason(String reason)` Sets the reason for signing to be used in the signature.
`void`	`setSignatureAppearance(SignatureAppearance signAppearance)` Sets the `SignatureAppearance` to use when creating the signature appearance stream.
`void`	`setSignatureFormat(int signatureFormat)` Set the signature format.
`void`	`setTimestampServer(TimestampServer server)` Set the Timestamp server information

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PERM_NOCHANGES
```
public static int PERM_NOCHANGES
```
    Certifying signature permission to indicate the document is intended to be final.
  - PERM_FORMFILL_SIGNATURE
```
public static int PERM_FORMFILL_SIGNATURE
```
    Certifying signature permission to allow form fill and signing.
  - PERM_FORMFILL_SIGNATURE_COMMENTS
```
public static int PERM_FORMFILL_SIGNATURE_COMMENTS
```
    Certifying signature permission to allow form fill, signing, and comments.
  - FORMAT_PKCS7
```
public static int FORMAT_PKCS7
```
    Signature format for PKCS7.
  - FORMAT_PADES
```
public static int FORMAT_PADES
```
    Signature format for PAdES.
  - FORMAT_DOCUMENT_TIMESTAMP
```
public static int FORMAT_DOCUMENT_TIMESTAMP
```
    Signature format for Document Timestamp
- Constructor Detail
  - SigningInformation
```
public SigningInformation(String pkcs12File,
                          String ksPWD,
                          String entryAlias,
                          String aliasPWD)
                   throws GeneralSecurityException,
                          IOException,
                          PDFException
```
    Constructs a SigningInformation object and gets the digital ID from a named PKCS#12 file. The method reads the file and gets the digital ID for use in signing.
    
    Parameters:
    
    pkcs12File - The name of the PKCS#12 key store file
    
    ksPWD - The key store password
    
    entryAlias - The alias of the entry to be used in signing.
    
    aliasPWD - The password to the alias entry.
    
    Throws:
    
    GeneralSecurityException
    
    IOException
    
    PDFException
  - SigningInformation
```
public SigningInformation(KeyStore ks,
                          String entryAlias,
                          String aliasPWD)
                   throws GeneralSecurityException,
                          PDFException
```
    Constructs a SigningInformation object and gets the digital ID from a Java KeyStore object.
    
    Parameters:
    
    ks - The KeyStore object that contains the digital ID.
    
    entryAlias - The alias of the entry to be used in signing.
    
    aliasPWD - The password to the alias entry.
    
    Throws:
    
    GeneralSecurityException
    
    PDFException
  - SigningInformation
```
public SigningInformation(PrivateKey pk,
                          Certificate signerCert,
                          Certificate[] certChain,
                          String provider)
                   throws PDFException
```
    Constructs a SigningInformation object given a private key, signer certificate and certificate chain.
    
    Parameters:
    
    pk - The private key to use in signing.
    
    signerCert - The singer's certificate.
    
    certChain - The signer's certificate chain
    
    provider - The JCE provider to use when accessing the private key. If left null, we will use the default Java JCE provider.
    
    Throws:
    
    PDFException - When the key usage is invalid.
  - SigningInformation
```
public SigningInformation(org.bouncycastle.operator.ContentSigner signer,
                          Certificate signerCert,
                          Certificate[] certChain)
```
    Constructs a SigningInformation object that will use an external content signer. The content signer implementation will be fed the bytes from the PDF document to calculate the signature hash and then will be caled to get the signature. the signer certificate and certificate chain passed in will be included in the PKCS#7 object inserted in the PDF document as part of the signature.
    
    Parameters:
    
    signer - The signer.
    
    signerCert - The signer's certificate.
    
    certChain - The signer's certificate chain.
  - SigningInformation
```
public SigningInformation(TimestampServer timestampServer)
```
    Constructs a SigningInformation object with only a TimestampServer. The format will be SigningInformation.FORMAT_DOCUMENT_TIMESTAMP by default. This constructor should be used to add a Document Timestamp Signature.
    
    Parameters:
    
    timestampServer - the timestamp server.
- Method Detail
  - getContentSigner
```
public org.bouncycastle.operator.ContentSigner getContentSigner()
```
    Deprecated. Use getContentSigner(String)
    
    Get the content signer. This can be an external signer.
    
    Returns:
    
    the content signer.
  - getContentSigner
```
public org.bouncycastle.operator.ContentSigner getContentSigner(String pdfVersion)
                                                         throws PDFException
```
    Get the content signer based on the PDF file version. If a content signer was explicitly set during construction, that one will be returned.
    
    Returns:
    
    the content signer.
    
    Throws:
    
    PDFException
  - getContactInformation
```
public String getContactInformation()
```
    Returns the contact information used in the signature.
    
    Returns:
    
    The contact name
  - setContactInformation
```
public void setContactInformation(String contactInformation)
```
    Sets the contact information to be used in the signature.
    
    Parameters:
    
    contactInformation - The new contact information.
  - getLocation
```
public String getLocation()
```
    Gets the location to be used in the signature.
    
    Returns:
    
    The location
  - setLocation
```
public void setLocation(String location)
```
    Sets the location to be used in the signature.
    
    Parameters:
    
    location - The new location.
  - getReason
```
public String getReason()
```
    Gets the reason for signing to be used in the signature.
    
    Returns:
    
    The reason for signing.
  - setReason
```
public void setReason(String reason)
```
    Sets the reason for signing to be used in the signature.
    
    Parameters:
    
    reason - The new reason.
  - getPrivateKey
```
public PrivateKey getPrivateKey()
```
    Deprecated.
    
    Returns the private key retrieved from the KeyStore or PKCS #12 file. This key is used to create the digital signature hash when a document is signed.
    
    Returns:
    
    The private key.
  - getJCEProvider
```
public String getJCEProvider()
```
    Deprecated.
    
    Returns the name of the JCE provider to use when accessing the Private Key. This value can be null, signifying that the default Java JCE provider will be used.
    
    Returns:
    
    The name of the JCE provider.
  - getSignerCertificate
```
public Certificate getSignerCertificate()
```
    Returns the certificate for the digital id retrieved from the KeyStore or the PKCS#12 file.
    
    Returns:
    
    The certificate for the digital id.
  - getCertificateChain
```
public Certificate[] getCertificateChain()
```
    Returns the certificate chain for the issuers of the certificate in the key store.
    
    Returns:
    
    The certificate chain.
  - setSignatureAppearance
```
public void setSignatureAppearance(SignatureAppearance signAppearance)
```
    Sets the SignatureAppearance to use when creating the signature appearance stream.
    
    Parameters:
    
    signAppearance - the signAppearance to use when creating the signature appearance stream
  - getSignatureAppearance
```
public SignatureAppearance getSignatureAppearance()
```
    Returns the SignatureAppearance to use when creating the signature appearance stream.
    
    Returns:
    
    the signAppearance
  - getCustomProperty
```
public String getCustomProperty(String key)
```
    This method can be used to retrieve the values of custom properties
    
    Parameters:
    
    key - The key for the custom property
  - setCustomProperty
```
public void setCustomProperty(String key,
                              String value)
                       throws PDFException
```
    This method can be used to add additional custom properties to the signature dictionary.
    
    Parameters:
    
    key - A unique key for the custom property
    
    value - The vale of the custom property
    
    Throws:
    
    PDFException
  - getCustomProperties
```
public Map<String,String> getCustomProperties()
```
    Returns the custom properties table. Returns null if no custom properties have been set.
  - getTimestampServer
```
public TimestampServer getTimestampServer()
```
    Returns the Timestamp Server information
  - setTimestampServer
```
public void setTimestampServer(TimestampServer server)
```
    Set the Timestamp server information
    
    Parameters:
    
    server -
  - setCertifyingSignature
```
public void setCertifyingSignature(boolean certifyingSignature)
```
    To create a certifying signature, set this property to true. It is false by default.
  - isCertifyingSignature
```
public boolean isCertifyingSignature()
```
    Returns true if this is a certifying signature.
  - setPermissions
```
public void setPermissions(int permissions)
                    throws PDFException
```
    This property is meaningful only if this is a certifying signature. Valid values are 1-3 and the default is 2. There are predefined ints in this class to use for the permission levels, PERM_NOCHANGES, PERM_FORMFILL_SIGNATURE, PERM_FORMFILL_SIGNATURE_COMMENTS.
    A value of 1 (PERM_NOCHANGES) indicates that the document is intended to be final;
    A value of 2 (PERM_FORMFILL_SIGNATURE) allows form filling and signatures;
    A value of 3 (PERM_FORMFILL_SIGNATURE_COMMENTS) permits form filling, signatures, and comments.
    
    Parameters:
    
    permissions -
    
    Throws:
    
    PDFException
  - getPermissions
```
public int getPermissions()
```
    Returns the level of permissions for a certifying signature.
    A value of 1 (PERM_NOCHANGES) indicates that the document is intended to be final;
    A value of 2 (PERM_FORMFILL_SIGNATURE) allows form filling and signatures;
    A value of 3 (PERM_FORMFILL_SIGNATURE_COMMENTS) permits form filling, signatures, and comments.
  - setSignatureFormat
```
public void setSignatureFormat(int signatureFormat)
```
    Set the signature format. Valid values are SigningInformation.FORMAT_PKCS7 (the default), SigningInformation.FORMAT_PADES, and SigningInformation.FORMAT_DOCUMENT_TIMESTAMP.
    
    Parameters:
    
    signatureFormat - the signature format (SigningInformation.FORMAT_PKCS7 or SigningInformation.FORMAT_PADES).
  - getSignatureFormat
```
public int getSignatureFormat()
```
    Returns the format of the signature.
    A value of 0 (FORMAT_PKCS7) indicates that the format is PKCS7. A value of 1 (FORMAT_PADES) indicates that the format is PAdES. A value of 2 (FORMAT_DOCUMENT_TIMESTAMP) indicates that the format id Doucment Timestamp
  - isLock
```
public boolean isLock()
```
    Returns true if fields will be locked when the signature is applied. When set, no changes to the document will be permitted and any changes will invalidate the signature.
    
    Returns:
    
    true if fields will be locked when the signature is applied to the document.
  - setLock
```
public void setLock(boolean lock)
```
    Set the lock to true to lock fields when the signature is applied. When set, no changes to the document will be permitted and any changes will invalidate the signature.
    
    Parameters:
    
    lock - Set to true to lock fields when the signature is applied.

Class SigningInformation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PERM_NOCHANGES

PERM_FORMFILL_SIGNATURE

PERM_FORMFILL_SIGNATURE_COMMENTS

FORMAT_PKCS7

FORMAT_PADES

FORMAT_DOCUMENT_TIMESTAMP

Constructor Detail

SigningInformation

SigningInformation

SigningInformation

SigningInformation

SigningInformation

Method Detail

getContentSigner

getContentSigner

getContactInformation

setContactInformation

getLocation

setLocation

getReason

setReason

getPrivateKey

getJCEProvider

getSignerCertificate

getCertificateChain

setSignatureAppearance

getSignatureAppearance

getCustomProperty

setCustomProperty

getCustomProperties

getTimestampServer

setTimestampServer

setCertifyingSignature

isCertifyingSignature

setPermissions

getPermissions

setSignatureFormat

getSignatureFormat

isLock

setLock