Package org.apache.poi.poifs.crypt.dsig.facets

Interface SignatureFacet

All Known Implementing Classes:

EnvelopedSignatureFacet, KeyInfoSignatureFacet, Office2010SignatureFacet, OOXMLSignatureFacet, XAdESSignatureFacet, XAdESXLSignatureFacet

@Internal
public interface SignatureFacet

JSR105 Signature Facet base class.

Field Summary

Fields

Modifier and Type	Field	Description
static String	MS_DIGSIG_NS
static String	OO_DIGSIG_NS
static String	XADES_132_NS
static String	XADES_141_NS
static String	XML_DIGSIG_NS
static String	XML_NS

Method Summary

Modifier and Type	Method	Description
default void	postSign(SignatureInfo signatureInfo, Document document)	This method is being invoked by the XML signature service engine during the post-sign phase.
default void	preSign(SignatureInfo signatureInfo, Document document, List<Reference> references, List<XMLObject> objects)	This method is being invoked by the XML signature service engine during pre-sign phase.

Field Detail

XML_NS

static final String XML_NS

See Also:

Constant Field Values

XML_DIGSIG_NS

static final String XML_DIGSIG_NS

See Also:

Constant Field Values

OO_DIGSIG_NS

static final String OO_DIGSIG_NS

See Also:

Constant Field Values

MS_DIGSIG_NS

static final String MS_DIGSIG_NS

See Also:

Constant Field Values

XADES_132_NS

static final String XADES_132_NS

See Also:

Constant Field Values

XADES_141_NS

static final String XADES_141_NS

See Also:

Constant Field Values

Method Detail

preSign

default void preSign(SignatureInfo signatureInfo,
                     Document document,
                     List<Reference> references,
                     List<XMLObject> objects)
              throws XMLSignatureException

This method is being invoked by the XML signature service engine during pre-sign phase. Via this method a signature facet implementation can add signature facets to an XML signature.

Parameters:

signatureInfo - the signature info object holding the OPCPackage and other document related data

document - the signature document to be used for imports

references - list of reference definitions

objects - objects to be signed/included in the signature document

Throws:

XMLSignatureException

postSign

default void postSign(SignatureInfo signatureInfo,
                      Document document)
               throws MarshalException

This method is being invoked by the XML signature service engine during the post-sign phase. Via this method a signature facet can extend the XML signatures with for example key information.

Parameters:

signatureInfo - the signature info object holding the OPCPackage and other document related data

document - the signature document to be modified

Throws:

MarshalException