com.adobe.livecycle.signatures.client.types
Class PDFSignature

java.lang.Object
  com.adobe.livecycle.signatures.client.types.PDFSignature

All Implemented Interfaces:

java.io.Serializable

public class PDFSignature
extends java.lang.Object
implements java.io.Serializable

The PDFSignature class contains information about the filter and subfilters that are used for validating the signature embedded in a signed or certified PDF document.

See Also:

Serialized Form

Constructor Summary

PDFSignature()
A constructor that creates a PDFSignature object.

Method Summary

byte[][]	getCertificates() Returns the certificates that are embedded in the PDF document at the time of signing.
byte[]	getContents() Returns the actual signature value as DER encoded PKCS#1 or PKCS#7.
byte[][]	getCRLs() Returns a byte array, where each element is a byte array that represents certificate revocation list (CRL) information.
java.lang.String	getFilter() Returns the name of the preferred signature handler which is used while validating the signature.
byte[][]	getOCSPResponses() Returns a byte array, where each element is a byte array that represents information returned from the OCSP server.
java.lang.String	getSubFilter() Returns the subFilter of the handler used to sign the signature field.
byte[]	getTimestamp() Returns a byte array, where each element contains information returned from the time stamp server.
void	setCertificates(byte[][] certs) Sets certificates that are embedded in the PDF document.
void	setContents(byte[] contents) Sets the signature value as DER encoded PKCS#1 or PKCS#7.
void	setCRLs(byte[][] crls) Sets a byte array, where each element is a byte array that represents certificate revocation list (CRL) information.
void	setFilter(java.lang.String filter) Sets the name of the preferred signature handler to use while validating the signature.
void	setOCSPResponses(byte[][] ocspResponses) Sets a byte array, where each element is a byte array that represents information returned from the OCSP server.
void	setSubFilter(java.lang.String subFilter) Sets the subFilter of the handler used to sign the signature field.
void	setTimestamp(byte[] timestamp) Sets a byte array, where each element contains information returned from the time stamp server.

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFSignature

public PDFSignature()

A constructor that creates a PDFSignature object.

Method Detail

getCRLs

public byte[][] getCRLs()

Returns a byte array, where each element is a byte array that represents certificate revocation list (CRL) information.

Returns:

A byte array where each element is byte array containing certificate revocation list (CRL) information.

setCRLs

public void setCRLs(byte[][] crls)

Sets a byte array, where each element is a byte array that represents certificate revocation list (CRL) information.

Parameters:

crls - A byte array where each element is byte array containing certificate revocation list (CRL) information.

getOCSPResponses

public byte[][] getOCSPResponses()

Returns a byte array, where each element is a byte array that represents information returned from the OCSP server.

Returns:

A byte array where each element is byte array containing information returned from the OCSP server.

setOCSPResponses

public void setOCSPResponses(byte[][] ocspResponses)

Sets a byte array, where each element is a byte array that represents information returned from the OCSP server.

Parameters:

ocspResponses - A byte array where each element is byte array containing information returned from the OCSP server.

getTimestamp

public byte[] getTimestamp()

Returns a byte array, where each element contains information returned from the time stamp server.

Returns:

A byte array, where each element contains information returned from the time stamp server.

setTimestamp

public void setTimestamp(byte[] timestamp)

Sets a byte array, where each element contains information returned from the time stamp server.

Parameters:

timestamp - A byte array, where each element contains information returned from the time stamp server.

getCertificates

public byte[][] getCertificates()

Returns the certificates that are embedded in the PDF document at the time of signing. If the subfilter of the document is set to adbe.pkcs7.detached or adbe.pkcs7.sha1 then this method returns null and the certificates are included in the PKCS#7 envelope of the content.

Returns:

The certificates that are embedded in the PDF document as an array of byte streams.

setCertificates

public void setCertificates(byte[][] certs)

Sets certificates that are embedded in the PDF document.

Parameters:

certs - An array of bytes streams that represent the certificates to set.

getContents

public byte[] getContents()

Returns the actual signature value as DER encoded PKCS#1 or PKCS#7. If the subfilter is set as adbe.pkcs7.detached or adbe.pkcs7.sha1 then the PKCS#7 packet contains the embedded certificates.

Returns:

A byte stream that represents the signature value as DER encoded PKCS#1 or PKCS#7.

setContents

public void setContents(byte[] contents)

Sets the signature value as DER encoded PKCS#1 or PKCS#7.

Parameters:

contents - A byte stream that represents the signature value.

getFilter

public java.lang.String getFilter()

Returns the name of the preferred signature handler which is used while validating the signature. Example signature handlers are Adobe.PPKLite, Entrust.PPKEF, CICI.SignIt, and VeriSign.PPKVS.

Returns:

The name of the preferred signature handler which is used while validating the signature.

setFilter

public void setFilter(java.lang.String filter)

Sets the name of the preferred signature handler to use while validating the signature.

Parameters:

filter - The name of the preferred signature handler.

getSubFilter

public java.lang.String getSubFilter()

Returns the subFilter of the handler used to sign the signature field.

Returns:

The subFilter of the handler used to sign the signature field.

setSubFilter

public void setSubFilter(java.lang.String subFilter)

Sets the subFilter of the handler used to sign the signature field.

Parameters:

subFilter - The subFilter of the handler used to sign the signature field.