com.qoppa.android.pdf

Class SigningInformation

java.lang.Object

com.qoppa.android.pdf.SigningInformation

public class SigningInformation
extends java.lang.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

Constructor Summary

Constructors

Constructor and Description
SigningInformation(java.security.KeyStore ks, java.lang.String entryAlias, java.lang.String aliasPWD) Constructs a SigningInformation object and gets the digital ID from a Java KeyStore object.
SigningInformation(java.lang.String pkcs12File, java.lang.String ksPWD, java.lang.String entryAlias, java.lang.String aliasPWD) Constructs a SigningInformation object and gets the digital ID from a named PKCS#12 file.

Method Summary

Modifier and Type	Method and Description
java.security.cert.Certificate[]	getCertificateChain() Returns the certificate chain for the issuers of the certificate in the key store.
java.lang.String	getContactInformation() Returns the contact information used in the signature.
java.util.Hashtable<java.lang.String,java.lang.String>	getCustomProperties() Returns the custom properties table.
java.lang.String	getLocation() Gets the location to be used in the signature.
java.security.PrivateKey	getPrivateKey() Returns the private key retrieved from the KeyStore or PKCS #12 file.
java.lang.String	getProperty(java.lang.String key) This method can be used to retrieve the values of custom properties
java.lang.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.
java.security.cert.Certificate	getSignerCertificate() Returns the certificate for the digital id retrieved from the KeyStore or the PKCS#12 file.
void	setContactInformation(java.lang.String contactInformation) Sets the contact information to be used in the signature.
void	setCustomProperty(java.lang.String key, java.lang.String value) This method can be used to add additional custom properties to the signature dictionary.
void	setLocation(java.lang.String location) Sets the location to be used in the signature.
void	setReason(java.lang.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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SigningInformation

public SigningInformation(java.lang.String pkcs12File,
                          java.lang.String ksPWD,
                          java.lang.String entryAlias,
                          java.lang.String aliasPWD)
                   throws java.security.GeneralSecurityException,
                          java.io.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:

java.security.GeneralSecurityException

java.io.IOException

PDFException

SigningInformation

public SigningInformation(java.security.KeyStore ks,
                          java.lang.String entryAlias,
                          java.lang.String aliasPWD)
                   throws java.security.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:

java.security.GeneralSecurityException

PDFException

Method Detail

getContactInformation

public java.lang.String getContactInformation()

Returns the contact information used in the signature.

Returns:

The contact name

setContactInformation

public void setContactInformation(java.lang.String contactInformation)

Sets the contact information to be used in the signature.

Parameters:

contactInformation - The new contact information.

getLocation

public java.lang.String getLocation()

Gets the location to be used in the signature.

Returns:

The location

setLocation

public void setLocation(java.lang.String location)

Sets the location to be used in the signature.

Parameters:

location - The new location.

getReason

public java.lang.String getReason()

Gets the reason for signing to be used in the signature.

Returns:

The reason for signing.

setReason

public void setReason(java.lang.String reason)

Sets the reason for signing to be used in the signature.

Parameters:

reason - The new reason.

getPrivateKey

public java.security.PrivateKey getPrivateKey()

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.

getSignerCertificate

public java.security.cert.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 java.security.cert.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

getProperty

public java.lang.String getProperty(java.lang.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(java.lang.String key,
                              java.lang.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 java.util.Hashtable<java.lang.String,java.lang.String> getCustomProperties()

Returns the custom properties table. Returns null if no custom properties have been set.