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

## Class EnvelopedSignatureFacet

- java.lang.Object
- - org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet
  - - org.apache.poi.poifs.crypt.dsig.facets.EnvelopedSignatureFacet

- All Implemented Interfaces:
    SignatureConfig.SignatureConfigurable

      public class EnvelopedSignatureFacet
      extends SignatureFacet

  Signature Facet implementation to create enveloped signatures.
  Author:
    Frank Cornelis

- - ### Field Summary

    - ### Fields inherited from class org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet

      `MS_DIGSIG_NS, OO_DIGSIG_NS, signatureConfig, XADES_132_NS, XADES_141_NS, XML_DIGSIG_NS, XML_NS`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `EnvelopedSignatureFacet()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `preSign(org.w3c.dom.Document document, java.util.List<javax.xml.crypto.dsig.Reference> references, java.util.List<javax.xml.crypto.dsig.XMLObject> objects)` This method is being invoked by the XML signature service engine during pre-sign phase.

    - ### Methods inherited from class org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet

      `getSignatureFactory, newReference, newReference, newTransform, newTransform, postSign, setSignatureConfig`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### EnvelopedSignatureFacet

          public EnvelopedSignatureFacet()

  - ### Method Detail

    - #### preSign

          public void preSign(org.w3c.dom.Document document,
                              java.util.List<javax.xml.crypto.dsig.Reference> references,
                              java.util.List<javax.xml.crypto.dsig.XMLObject> objects)
                       throws javax.xml.crypto.dsig.XMLSignatureException

      Description copied from class: `SignatureFacet`
      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.
      Overrides:
        `preSign` in class `SignatureFacet`
      Parameters:
        `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:
        `javax.xml.crypto.dsig.XMLSignatureException`

Copyright 2020 The Apache Software Foundation or its licensors, as applicable.