Module org.apache.santuario.xmlsec

Package org.apache.xml.security.signature

Class XMLSignatureStreamInput

java.lang.Object

org.apache.xml.security.signature.XMLSignatureInput

org.apache.xml.security.signature.XMLSignatureStreamInput

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

XMLSignatureFileInput

public class XMLSignatureStreamInput
extends XMLSignatureInput
implements AutoCloseable

The XMLSignature Input as an input stream containing a collection of nodes or a subnode excluding or not comments and excluding or not other nodes. The stream is closed after processing.

NOTE: The stream may be closed in the process, but it is not guaranteed.

Constructor Summary

Constructors

Constructor	Description
XMLSignatureStreamInput(InputStream inputStream)	Construct a XMLSignatureInput from an InputStream.

Method Summary

Modifier and Type	Method	Description
void	close()
protected Node	convertToNode()
InputStream	getUnprocessedInput()
boolean	hasUnprocessedInput()
void	write(OutputStream output, boolean c14n11)	Writes the data to the output stream.

Methods inherited from class org.apache.xml.security.signature.XMLSignatureInput

addNodeFilter, canonicalize, getBytes, getExcludeNode, getInputNodeSet, getMIMEType, getNodeFilters, getNodeSet, getOutputStream, getPreCalculatedDigest, getSourceURI, getSubNode, isElement, isExcludeComments, isNeedsToBeExpanded, isNodeSet, isOutputStreamSet, isSecureValidation, setExcludeComments, setExcludeNode, setMIMEType, setNeedsToBeExpanded, setNodeSet, setOutputStream, setSecureValidation, setSourceURI, toString, write

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLSignatureStreamInput

public XMLSignatureStreamInput(InputStream inputStream)

Construct a XMLSignatureInput from an InputStream.

NOTE: The stream may be closed in the process, but it is not guaranteed.

Parameters:

inputStream - includes XML document or node

Method Detail

hasUnprocessedInput

public boolean hasUnprocessedInput()

Specified by:

hasUnprocessedInput in class XMLSignatureInput

Returns:

true if this instance still can provide the unprocessed input which was specified as the parameter of XMLSignatureInput

getUnprocessedInput

public InputStream getUnprocessedInput()

Specified by:

getUnprocessedInput in class XMLSignatureInput

Returns:

the InputStream from input which was specified as the parameter of XMLSignatureInput constructor

write

public void write(OutputStream output,
                  boolean c14n11)
           throws CanonicalizationException,
                  IOException

Description copied from class: XMLSignatureInput

Writes the data to the output stream.

Specified by:

write in class XMLSignatureInput

Throws:

CanonicalizationException

IOException

See Also:

XmlDSig-Core Reference Generation

convertToNode

protected Node convertToNode()
                      throws org.apache.xml.security.parser.XMLParserException,
                             IOException

Specified by:

convertToNode in class XMLSignatureInput

Returns:

data given in constructor converted to a Node or null if such conversion is not supported by this XMLSignatureInput

Throws:

org.apache.xml.security.parser.XMLParserException

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException