XMLSignatureInput (Apache XML Security for Java 2.2.0 API)

java.lang.Object
- org.apache.xml.security.signature.XMLSignatureInput

```
public class XMLSignatureInput
extends Object
```
Class XMLSignatureInput $todo$ check whether an XMLSignatureInput can be _both_, octet stream _and_ node set?

Constructor Summary

Constructors
Constructor and Description
`XMLSignatureInput(byte[] inputOctets)` Construct a XMLSignatureInput from an octet array.
`XMLSignatureInput(InputStream inputOctetStream)` Constructs a `XMLSignatureInput` from an octet stream.
`XMLSignatureInput(Node rootNode)` Construct a XMLSignatureInput from a subtree rooted by rootNode.
`XMLSignatureInput(Set<Node> inputNodeSet)` Constructor XMLSignatureInput
`XMLSignatureInput(String preCalculatedDigest)` Construct a `XMLSignatureInput` from a known digest value in Base64.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addNodeFilter(NodeFilter filter)`
`byte[]`	`getBytes()` Returns the byte array from input which was specified as the parameter of `XMLSignatureInput` constructor
`Node`	`getExcludeNode()` Gets the exclude node of this XMLSignatureInput
`String`	`getHTMLRepresentation()` Method getHTMLRepresentation
`String`	`getHTMLRepresentation(Set<String> inclusiveNamespaces)` Method getHTMLRepresentation
`Set<Node>`	`getInputNodeSet()` Get the Input NodeSet.
`String`	`getMIMEType()` Returns mimeType
`List<NodeFilter>`	`getNodeFilters()`
`Set<Node>`	`getNodeSet()` Returns the node set from input which was specified as the parameter of `XMLSignatureInput` constructor
`Set<Node>`	`getNodeSet(boolean circumvent)` Returns the node set from input which was specified as the parameter of `XMLSignatureInput` constructor
`InputStream`	`getOctetStream()` Returns the Octet stream(byte Stream) from input which was specified as the parameter of `XMLSignatureInput` constructor
`InputStream`	`getOctetStreamReal()`
`String`	`getPreCalculatedDigest()`
`String`	`getSourceURI()` Return SourceURI
`Node`	`getSubNode()` Gets the node of this XMLSignatureInput
`boolean`	`isByteArray()` Determines if the object has been set up with a ByteArray
`boolean`	`isElement()` Determines if the object has been set up with an Element
`boolean`	`isExcludeComments()`
`boolean`	`isInitialized()` Is the object correctly set up?
`boolean`	`isNeedsToBeExpanded()` Check if the structure needs to be expanded.
`boolean`	`isNodeSet()` Determines if the object has been set up with a Node set
`boolean`	`isOctetStream()` Determines if the object has been set up with an octet stream
`boolean`	`isOutputStreamSet()` Determines if `setOutputStream(java.io.OutputStream)` has been called with a non-null OutputStream.
`boolean`	`isPreCalculatedDigest()` Determines if the object has been set up with a pre-calculated digest.
`boolean`	`isSecureValidation()`
`void`	`setExcludeComments(boolean excludeComments)`
`void`	`setExcludeNode(Node excludeNode)` Sets the exclude node of this XMLSignatureInput
`void`	`setMIMEType(String mimeType)` Sets mimeType
`void`	`setNeedsToBeExpanded(boolean needsToBeExpanded)` Set if the structure needs to be expanded.
`void`	`setNodeSet(boolean b)`
`void`	`setOutputStream(OutputStream os)`
`void`	`setSecureValidation(boolean secureValidation)`
`void`	`setSourceURI(String sourceURI)` Sets SourceURI
`String`	`toString()` Method toString
`void`	`updateOutputStream(OutputStream diOs)`
`void`	`updateOutputStream(OutputStream diOs, boolean c14n11)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 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(InputStream inputOctetStream)
```
    Constructs a XMLSignatureInput from an octet stream. The stream is directly read.
    
    Parameters:
    
    inputOctetStream -
  - XMLSignatureInput
```
public XMLSignatureInput(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(Set<Node> inputNodeSet)
```
    Constructor XMLSignatureInput
    
    Parameters:
    
    inputNodeSet -
  - XMLSignatureInput
```
public XMLSignatureInput(String preCalculatedDigest)
```
    Construct a XMLSignatureInput from a known digest value in Base64. This makes it possible to compare the element digest with the provided digest value.
    
    Parameters:
    
    preCalculatedDigest - digest value in base64.
- Method Detail
  - isNeedsToBeExpanded
```
public boolean isNeedsToBeExpanded()
```
    Check if the structure needs to be expanded.
    
    Returns:
    
    true if so.
  - setNeedsToBeExpanded
```
public void setNeedsToBeExpanded(boolean needsToBeExpanded)
```
    Set if the structure needs to be expanded.
    
    Parameters:
    
    needsToBeExpanded - true if so.
  - getNodeSet
```
public Set<Node> getNodeSet()
                     throws XMLParserException,
                            IOException
```
    Returns the node set from input which was specified as the parameter of XMLSignatureInput constructor
    
    Returns:
    
    the node set
    
    Throws:
    
    XMLParserException
    
    IOException
  - getInputNodeSet
```
public Set<Node> getInputNodeSet()
```
    Get the Input NodeSet.
    
    Returns:
    
    the Input NodeSet.
  - getNodeSet
```
public Set<Node> getNodeSet(boolean circumvent)
                     throws XMLParserException,
                            IOException
```
    Returns the node set from input which was specified as the parameter of XMLSignatureInput constructor
    
    Parameters:
    
    circumvent -
    
    Returns:
    
    the node set
    
    Throws:
    
    XMLParserException
    
    IOException
  - getOctetStream
```
public InputStream getOctetStream()
                           throws IOException
```
    Returns the Octet stream(byte Stream) from input which was specified as the parameter of XMLSignatureInput constructor
    
    Returns:
    
    the Octet stream(byte Stream) from input which was specified as the parameter of XMLSignatureInput constructor
    
    Throws:
    
    IOException
  - getOctetStreamReal
```
public InputStream getOctetStreamReal()
```
    Returns:
    
    real octet stream
  - getBytes
```
public byte[] getBytes()
                throws IOException,
                       CanonicalizationException
```
    Returns the byte array from input which was specified as the parameter of XMLSignatureInput constructor
    
    Returns:
    
    the byte[] from input which was specified as the parameter of XMLSignatureInput constructor
    
    Throws:
    
    CanonicalizationException
    
    IOException
  - isNodeSet
```
public boolean isNodeSet()
```
    Determines if the object has been set up with a Node set
    
    Returns:
    
    true if 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 if the object has been set up with an Element
  - isOctetStream
```
public boolean isOctetStream()
```
    Determines if the object has been set up with an octet stream
    
    Returns:
    
    true if the object has been set up with an octet stream
  - isOutputStreamSet
```
public boolean isOutputStreamSet()
```
    Determines if setOutputStream(java.io.OutputStream) has been called with a non-null OutputStream.
    
    Returns:
    
    true if setOutputStream(java.io.OutputStream) has been called with a non-null OutputStream
  - isByteArray
```
public boolean isByteArray()
```
    Determines if the object has been set up with a ByteArray
    
    Returns:
    
    true if the object has been set up with an octet stream
  - isPreCalculatedDigest
```
public boolean isPreCalculatedDigest()
```
    Determines if the object has been set up with a pre-calculated digest.
    
    Returns:
    
    true if the object has been set up with a pre-calculated digest.
  - isInitialized
```
public boolean isInitialized()
```
    Is the object correctly set up?
    
    Returns:
    
    true if the object has been set up correctly
  - getMIMEType
```
public String getMIMEType()
```
    Returns mimeType
    
    Returns:
    
    mimeType
  - setMIMEType
```
public void setMIMEType(String mimeType)
```
    Sets mimeType
    
    Parameters:
    
    mimeType -
  - getSourceURI
```
public String getSourceURI()
```
    Return SourceURI
    
    Returns:
    
    SourceURI
  - setSourceURI
```
public void setSourceURI(String sourceURI)
```
    Sets SourceURI
    
    Parameters:
    
    sourceURI -
  - toString
```
public String toString()
```
    Method toString
    
    Overrides:
    
    toString in class Object
  - getHTMLRepresentation
```
public String getHTMLRepresentation()
                             throws XMLSignatureException
```
    Method getHTMLRepresentation
    
    Returns:
    
    The HTML representation for this XMLSignature
    
    Throws:
    
    XMLSignatureException
  - getHTMLRepresentation
```
public String getHTMLRepresentation(Set<String> inclusiveNamespaces)
                             throws XMLSignatureException
```
    Method getHTMLRepresentation
    
    Parameters:
    
    inclusiveNamespaces -
    
    Returns:
    
    The HTML representation for this XMLSignature
    
    Throws:
    
    XMLSignatureException
  - getExcludeNode
```
public Node getExcludeNode()
```
    Gets the exclude node of this XMLSignatureInput
    
    Returns:
    
    Returns the excludeNode.
  - setExcludeNode
```
public void setExcludeNode(Node excludeNode)
```
    Sets the exclude node of this XMLSignatureInput
    
    Parameters:
    
    excludeNode - The excludeNode to set.
  - getSubNode
```
public 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.
  - updateOutputStream
```
public void updateOutputStream(OutputStream diOs)
                        throws CanonicalizationException,
                               IOException
```
    Parameters:
    
    diOs -
    
    Throws:
    
    IOException
    
    CanonicalizationException
  - updateOutputStream
```
public void updateOutputStream(OutputStream diOs,
                               boolean c14n11)
                        throws CanonicalizationException,
                               IOException
```
    Throws:
    
    CanonicalizationException
    
    IOException
  - setOutputStream
```
public void setOutputStream(OutputStream os)
```
    Parameters:
    
    os -
  - addNodeFilter
```
public void addNodeFilter(NodeFilter filter)
```
    Parameters:
    
    filter -
  - getNodeFilters
```
public List<NodeFilter> getNodeFilters()
```
    Returns:
    
    the node filters
  - setNodeSet
```
public void setNodeSet(boolean b)
```
    Parameters:
    
    b -
  - isSecureValidation
```
public boolean isSecureValidation()
```
  - setSecureValidation
```
public void setSecureValidation(boolean secureValidation)
```
  - getPreCalculatedDigest
```
public String getPreCalculatedDigest()
```

Class XMLSignatureInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XMLSignatureInput

XMLSignatureInput

XMLSignatureInput

XMLSignatureInput

XMLSignatureInput

Method Detail

isNeedsToBeExpanded

setNeedsToBeExpanded

getNodeSet

getInputNodeSet

getNodeSet

getOctetStream

getOctetStreamReal

getBytes

isNodeSet

isElement

isOctetStream

isOutputStreamSet

isByteArray

isPreCalculatedDigest

isInitialized

getMIMEType

setMIMEType

getSourceURI

setSourceURI

toString

getHTMLRepresentation

getHTMLRepresentation

getExcludeNode

setExcludeNode

getSubNode

isExcludeComments

setExcludeComments

updateOutputStream

updateOutputStream

setOutputStream

addNodeFilter

getNodeFilters

setNodeSet

isSecureValidation

setSecureValidation

getPreCalculatedDigest