Package org.apache.xml.security.signature

Class XMLSignatureInput

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class XMLSignatureInput
extends java.lang.Object
implements java.lang.Cloneable
    Class XMLSignatureInput
    Author:
    Christian Geuer-Pollmann $todo$ check whether an XMLSignatureInput can be _both_, octet stream _and_ node set?

    • Constructor Detail

      • XMLSignatureInput

        public XMLSignatureInput​(byte[] inputOctets)
        Construct a XMLSignatureInput from an octet array.

        This is a comfort method, which internally converts the byte[] array into an InputStream

        NOTE: no defensive copy

        Parameters:
        inputOctets - an octet array which including XML document or node

      • XMLSignatureInput

        public XMLSignatureInput​(java.io.InputStream inputOctetStream)
        Constructs a XMLSignatureInput from an octet stream. The stream is directly read.
        Parameters:
        inputOctetStream -

      • XMLSignatureInput

        public XMLSignatureInput​(java.lang.String inputStr)
        Deprecated.
        Construct a XMLSignatureInput from a String.

        This is a comfort method, which internally converts the String into a byte[] array using the String.getBytes() method.

        Parameters:
        inputStr - the input String which including XML document or node

      • XMLSignatureInput

        public XMLSignatureInput​(java.lang.String inputStr,
                         java.lang.String encoding)
                  throws java.io.UnsupportedEncodingException
        Deprecated.
        Construct a XMLSignatureInput from a String with a given encoding.

        This is a comfort method, which internally converts the String into a byte[] array using the String.getBytes() method.

        Parameters:
        inputStr - the input String with encoding encoding
        encoding - the encoding of inputStr
        Throws:
        java.io.UnsupportedEncodingException

      • XMLSignatureInput

        public XMLSignatureInput​(org.w3c.dom.Node rootNode)
        Construct a XMLSignatureInput from a subtree rooted by rootNode. This method included the node and all his descendants in the output.
        Parameters:
        rootNode -

      • XMLSignatureInput

        public XMLSignatureInput​(java.util.Set inputNodeSet)
        Constructor XMLSignatureInput
        Parameters:
        inputNodeSet -
        usedXPathAPI -

    • Method Detail

      • isNeedsToBeExpanded

        public boolean isNeedsToBeExpanded()
        Check if the structured is needed to be circumbented.
        Returns:
        true if so.

      • setNeedsToBeExpanded

        public void setNeedsToBeExpanded​(boolean needsToBeExpanded)
        Set if the structured is needed to be circumbented.
        Parameters:
        needsToBeExpanded - true if so.

      • getNodeSet

        public java.util.Set getNodeSet()
                         throws CanonicalizationException,
                                javax.xml.parsers.ParserConfigurationException,
                                java.io.IOException,
                                org.xml.sax.SAXException
        Returns the node set from input which was specified as the parameter of XMLSignatureInput constructor
        Returns:
        the node set
        Throws:
        org.xml.sax.SAXException
        java.io.IOException
        javax.xml.parsers.ParserConfigurationException
        CanonicalizationException
        CanonicalizationException
        java.io.IOException
        javax.xml.parsers.ParserConfigurationException
        org.xml.sax.SAXException

      • getNodeSet

        public java.util.Set getNodeSet​(boolean circunvent)
                         throws javax.xml.parsers.ParserConfigurationException,
                                java.io.IOException,
                                org.xml.sax.SAXException,
                                CanonicalizationException
        Returns the node set from input which was specified as the parameter of XMLSignatureInput constructor
        Parameters:
        circunvent -
        Returns:
        the node set
        Throws:
        org.xml.sax.SAXException
        java.io.IOException
        javax.xml.parsers.ParserConfigurationException
        CanonicalizationException
        CanonicalizationException
        java.io.IOException
        javax.xml.parsers.ParserConfigurationException
        org.xml.sax.SAXException

      • getOctetStream

        public java.io.InputStream getOctetStream()
                                   throws java.io.IOException
        Returns the Octect stream(byte Stream) from input which was specified as the parameter of XMLSignatureInput constructor
        Returns:
        the Octect stream(byte Stream) from input which was specified as the parameter of XMLSignatureInput constructor
        Throws:
        java.io.IOException

      • getOctetStreamReal

        public java.io.InputStream getOctetStreamReal()
        Returns:
        real octect stream

      • isNodeSet

        public boolean isNodeSet()
        Determines if the object has been set up with a Node set
        Returns:
        true is the object has been set up with a Node set

      • isElement

        public boolean isElement()
        Determines if the object has been set up with an Element
        Returns:
        true is the object has been set up with a Node set

      • isOctetStream

        public boolean isOctetStream()
        Determines if the object has been set up with an octet stream
        Returns:
        true is the object has been set up with an octet stream

      • isByteArray

        public boolean isByteArray()
        Determines if the object has been set up with a ByteArray
        Returns:
        true is the object has been set up with an octet stream

      • isInitialized

        public boolean isInitialized()
        Is the object correctly set up?
        Returns:
        true if the object has been set up correctly

      • getMIMEType

        public java.lang.String getMIMEType()
        Returns MIMEType
        Returns:
        MIMEType

      • setMIMEType

        public void setMIMEType​(java.lang.String MIMEType)
        Sets MIMEType
        Parameters:
        MIMEType -

      • getSourceURI

        public java.lang.String getSourceURI()
        Return SourceURI
        Returns:
        SourceURI

      • setSourceURI

        public void setSourceURI​(java.lang.String SourceURI)
        Sets SourceURI
        Parameters:
        SourceURI -

      • toString

        public java.lang.String toString()
        Method toString
        Overrides:
        toString in class java.lang.Object

      • getHTMLRepresentation

        public java.lang.String getHTMLRepresentation()
                                       throws XMLSignatureException
        Method getHTMLRepresentation
        Returns:
        The HTML representation for this XMLSignature
        Throws:
        XMLSignatureException

      • getHTMLRepresentation

        public java.lang.String getHTMLRepresentation​(java.util.Set inclusiveNamespaces)
                                       throws XMLSignatureException
        Method getHTMLRepresentation
        Parameters:
        inclusiveNamespaces -
        Returns:
        The HTML representation for this XMLSignature
        Throws:
        XMLSignatureException

      • getExcludeNode

        public org.w3c.dom.Node getExcludeNode()
        Gets the exclude node of this XMLSignatureInput
        Returns:
        Returns the excludeNode.

      • setExcludeNode

        public void setExcludeNode​(org.w3c.dom.Node excludeNode)
        Sets the exclude node of this XMLSignatureInput
        Parameters:
        excludeNode - The excludeNode to set.

      • getSubNode

        public org.w3c.dom.Node getSubNode()
        Gets the node of this XMLSignatureInput
        Returns:
        The excludeNode set.

      • isExcludeComments

        public boolean isExcludeComments()
        Returns:
        Returns the excludeComments.

      • setExcludeComments

        public void setExcludeComments​(boolean excludeComments)
        Parameters:
        excludeComments - The excludeComments to set.

      • setOutputStream

        public void setOutputStream​(java.io.OutputStream os)
        Parameters:
        os -

      • getResetableInputStream

        protected java.io.InputStream getResetableInputStream()
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • addNodeFilter

        public void addNodeFilter​(NodeFilter filter)
        Parameters:
        filter -

      • getNodeFilters

        public java.util.List getNodeFilters()
        Returns:
        the node filters

      • setNodeSet

        public void setNodeSet​(boolean b)
        Parameters:
        b -