org.nuxeo.ecm.platform.signature.core.sign

Class SignatureServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.signature.core.sign.SignatureServiceImpl

All Implemented Interfaces:

SignatureService, Adaptable, Component, Extensible, TimestampedService

public class SignatureServiceImpl
extends DefaultComponent
implements SignatureService

Base implementation for the signature service (also a Nuxeo component).

The main document is signed. If it's not already a PDF, then a PDF conversion is done.

Once signed, it can replace the main document or be stored as the first attachment. If replacing the main document, an archive of the original can be kept.

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.platform.signature.api.sign.SignatureService

SignatureService.SigningDisposition, SignatureService.StatusWithBlob

Constructor Summary

Constructors

Constructor and Description
SignatureServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
List<X509Certificate>	getCertificates(DocumentModel doc) Returns a list of certificates associated with a given document.
SignatureService.StatusWithBlob	getSigningStatus(DocumentModel doc, DocumentModel user) Finds the signing status for the document.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
Blob	signDocument(DocumentModel doc, DocumentModel user, String keyPassword, String reason, boolean pdfa, SignatureService.SigningDisposition disposition, String archiveFilename) Signs a document with a user certificate (converts it into a PDF first if needed).
Blob	signPDF(Blob pdfBlob, DocumentModel user, String keyPassword, String reason) Signs a PDF document with a user certificate.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterExtension

Methods inherited from class java.lang.Object

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

Constructor Detail

SignatureServiceImpl

public SignatureServiceImpl()

Method Detail

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
                          String extensionPoint,
                          ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

getSigningStatus

public SignatureService.StatusWithBlob getSigningStatus(DocumentModel doc,
                                               DocumentModel user)
                                                 throws ClientException

Description copied from interface: SignatureService

Finds the signing status for the document.

A signature user is determined according to its email.

Specified by:

getSigningStatus in interface SignatureService

Parameters:

doc - the document

Returns:

the signing status

Throws:

ClientException

signDocument

public Blob signDocument(DocumentModel doc,
                DocumentModel user,
                String keyPassword,
                String reason,
                boolean pdfa,
                SignatureService.SigningDisposition disposition,
                String archiveFilename)
                  throws ClientException

Description copied from interface: SignatureService

Signs a document with a user certificate (converts it into a PDF first if needed).

Requires a password to retrieve the certificate from the user keystore.

Does not save the modified document.

Specified by:

signDocument in interface SignatureService

Parameters:

doc - the document to sign

user - the signing user

keyPassword - the password for the user's signing certificate

reason - the signing reason

pdfa - true if the generated PDF should be a PDF/A-1b

disposition - the signing disposition

archiveFilename - the archive filename when using an archive

Returns:

a blob containing the signed PDF

Throws:

SignException

ConversionException

ClientException

signPDF

public Blob signPDF(Blob pdfBlob,
           DocumentModel user,
           String keyPassword,
           String reason)
             throws SignException,
                    ClientException

Description copied from interface: SignatureService

Signs a PDF document with a user certificate. Requires a password to retrieve the certificate from the user keystore.

Specified by:

signPDF in interface SignatureService

Parameters:

pdfBlob - the blob containing the PDF to sign

user - the signing user

keyPassword - the password for the user's signing certificate

reason - the signing reason

Returns:

a blob containing the signed PDF

Throws:

SignException

ClientException

getCertificates

public List<X509Certificate> getCertificates(DocumentModel doc)
                                      throws ClientException

Description copied from interface: SignatureService

Returns a list of certificates associated with a given document.

Specified by:

getCertificates in interface SignatureService

Parameters:

doc - the document

Returns:

the list of certificates (may be empty)

Throws:

ClientException