Class Manifest

  • Direct Known Subclasses:
    SignedInfo

    public class Manifest
    extends SignatureElementProxy
    Handles <ds:Manifest> elements.

    This element holds the Reference elements

    • Field Detail

      • MAXIMUM_REFERENCE_COUNT

        public static final int MAXIMUM_REFERENCE_COUNT
        The default maximum number of references per Manifest, if secure validation is enabled.
        See Also:
        Constant Field Values
      • LOG

        private static final org.slf4j.Logger LOG
      • referenceCount

        private static java.lang.Integer referenceCount
      • references

        private java.util.List<Reference> references
        Field references
      • referencesEl

        private org.w3c.dom.Element[] referencesEl
      • verificationResults

        private java.util.List<VerifiedReference> verificationResults
        Field verificationResults[]
      • resolverProperties

        private java.util.Map<java.lang.String,​java.lang.String> resolverProperties
        Field resolverProperties
      • perManifestResolvers

        private java.util.List<ResourceResolver> perManifestResolvers
        Field perManifestResolvers
      • secureValidation

        private boolean secureValidation
    • Constructor Detail

      • Manifest

        public Manifest​(org.w3c.dom.Document doc)
        Constructs Manifest
        Parameters:
        doc - the Document in which XMLsignature is placed
      • Manifest

        public Manifest​(org.w3c.dom.Element element,
                        java.lang.String baseURI,
                        boolean secureValidation)
                 throws XMLSecurityException
        Constructor Manifest
        Parameters:
        element -
        baseURI -
        secureValidation -
        Throws:
        XMLSecurityException
    • Method Detail

      • addDocument

        public void addDocument​(java.lang.String baseURI,
                                java.lang.String referenceURI,
                                Transforms transforms,
                                java.lang.String digestURI,
                                java.lang.String referenceId,
                                java.lang.String referenceType)
                         throws XMLSignatureException
        This addDocument method is used to add a new resource to the signed info. A Reference is built from the supplied values.
        Parameters:
        baseURI - the URI of the resource where the XML instance was stored
        referenceURI - URI attribute in Reference for specifying where data is
        transforms - org.apache.xml.security.signature.Transforms object with an ordered list of transformations to be performed.
        digestURI - The digest algorithm URI to be used.
        referenceId -
        referenceType -
        Throws:
        XMLSignatureException
      • getLength

        public int getLength()
        Return the nonnegative number of added references.
        Returns:
        the number of references
      • setId

        public void setId​(java.lang.String Id)
        Sets the Id attribute
        Parameters:
        Id - the Id attribute in ds:Manifest
      • getId

        public java.lang.String getId()
        Returns the Id attribute
        Returns:
        the Id attribute in ds:Manifest
      • getVerificationResults

        public java.util.List<VerifiedReference> getVerificationResults()
        Get the list of verification result objects
      • addResourceResolver

        public void addResourceResolver​(ResourceResolver resolver)
        Adds Resource Resolver for retrieving resources at specified URI attribute in reference element
        Parameters:
        resolver - ResourceResolver can provide the implementation subclass of ResourceResolverSpi for retrieving resource.
      • addResourceResolver

        public void addResourceResolver​(ResourceResolverSpi resolverSpi)
        Adds Resource Resolver for retrieving resources at specified URI attribute in reference element
        Parameters:
        resolverSpi - the implementation subclass of ResourceResolverSpi for retrieving the resource.
      • getPerManifestResolvers

        public java.util.List<ResourceResolver> getPerManifestResolvers()
        Get the Per-Manifest Resolver List
        Returns:
        the per-manifest Resolver List
      • getResolverProperties

        public java.util.Map<java.lang.String,​java.lang.String> getResolverProperties()
        Get the resolver property map
        Returns:
        the resolver property map
      • setResolverProperty

        public void setResolverProperty​(java.lang.String key,
                                        java.lang.String value)
        Used to pass parameters like proxy servers etc to the ResourceResolver implementation.
        Parameters:
        key - the key
        value - the value
      • getResolverProperty

        public java.lang.String getResolverProperty​(java.lang.String key)
        Returns the value at specified key
        Parameters:
        key - the key
        Returns:
        the value
      • getSignedContentItem

        public byte[] getSignedContentItem​(int i)
                                    throws XMLSignatureException
        Method getSignedContentItem
        Parameters:
        i -
        Returns:
        The signed content of the i reference.
        Throws:
        XMLSignatureException
      • getReferencedContentBeforeTransformsItem

        public XMLSignatureInput getReferencedContentBeforeTransformsItem​(int i)
                                                                   throws XMLSecurityException
        Method getReferencedContentPriorTransformsItem
        Parameters:
        i -
        Returns:
        The contents before transformation of the reference i.
        Throws:
        XMLSecurityException
      • getReferencedContentAfterTransformsItem

        public XMLSignatureInput getReferencedContentAfterTransformsItem​(int i)
                                                                  throws XMLSecurityException
        Method getReferencedContentAfterTransformsItem
        Parameters:
        i -
        Returns:
        The contents after transformation of the reference i.
        Throws:
        XMLSecurityException
      • getSignedContentLength

        public int getSignedContentLength()
        Method getSignedContentLength
        Returns:
        The number of references contained in this reference.
      • getBaseLocalName

        public java.lang.String getBaseLocalName()
        Method getBaseLocalName Returns the localname of the Elements of the sub-class.
        Specified by:
        getBaseLocalName in class ElementProxy
        Returns:
        the localname of the Elements of the sub-class.
      • isSecureValidation

        public boolean isSecureValidation()