Class XMLSignatureInput
java.lang.Object
org.apache.xml.security.signature.XMLSignatureInput
Class XMLSignatureInput
$todo$ check whether an XMLSignatureInput can be _both_, octet stream _and_ node set?
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate byte[]
A cached bytesprivate boolean
private Node
Exclude Node *for enveloped transformations*The original NodeSet for this XMLSignatureInputprivate InputStream
Some InputStreams do not support theInputStream.reset()
method, so we read it in completely and work on our Proxy.private boolean
private String
Some Transforms may require explicit MIME type, charset (IANA registered "character set"), or other such information concerning the data they are receiving from an earlier Transform or the source data, although no Transform algorithm specified in this document needs such explicit information.private boolean
private List
<NodeFilter> Node Filter list.private OutputStream
private String
Pre-calculated digest value of the object in base64.private boolean
private String
Field sourceURIprivate Node
The original Element -
Constructor Summary
ConstructorsConstructorDescriptionXMLSignatureInput
(byte[] inputOctets) Construct a XMLSignatureInput from an octet array.XMLSignatureInput
(InputStream inputOctetStream) Constructs aXMLSignatureInput
from an octet stream.XMLSignatureInput
(String preCalculatedDigest) Construct aXMLSignatureInput
from a known digest value in Base64.XMLSignatureInput
(Set<Node> inputNodeSet) Constructor XMLSignatureInputXMLSignatureInput
(Node rootNode) Construct a XMLSignatureInput from a subtree rooted by rootNode. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addNodeFilter
(NodeFilter filter) (package private) void
byte[]
getBytes()
Returns the byte array from input which was specified as the parameter ofXMLSignatureInput
constructorprivate byte[]
Gets the exclude node of this XMLSignatureInputMethod getHTMLRepresentationgetHTMLRepresentation
(Set<String> inclusiveNamespaces) Method getHTMLRepresentationGet the Input NodeSet.Returns mimeTypeReturns the node set from input which was specified as the parameter ofXMLSignatureInput
constructorgetNodeSet
(boolean circumvent) Returns the node set from input which was specified as the parameter ofXMLSignatureInput
constructorReturns the Octet stream(byte Stream) from input which was specified as the parameter ofXMLSignatureInput
constructorReturn SourceURIGets the node of this XMLSignatureInputboolean
Determines if the object has been set up with a ByteArrayboolean
Determines if the object has been set up with an Elementboolean
boolean
Is the object correctly set up?boolean
Check if the structure needs to be expanded.boolean
Determines if the object has been set up with a Node setboolean
Determines if the object has been set up with an octet streamboolean
Determines ifsetOutputStream(java.io.OutputStream)
has been called with a non-null OutputStream.boolean
Determines if the object has been set up with a pre-calculated digest.boolean
void
setExcludeComments
(boolean excludeComments) void
setExcludeNode
(Node excludeNode) Sets the exclude node of this XMLSignatureInputvoid
setMIMEType
(String mimeType) Sets mimeTypevoid
setNeedsToBeExpanded
(boolean needsToBeExpanded) Set if the structure needs to be expanded.void
setNodeSet
(boolean b) void
void
setSecureValidation
(boolean secureValidation) void
setSourceURI
(String sourceURI) Sets SourceURItoString()
Method toStringvoid
void
updateOutputStream
(OutputStream diOs, boolean c14n11)
-
Field Details
-
inputOctetStreamProxy
Some InputStreams do not support theInputStream.reset()
method, so we read it in completely and work on our Proxy. -
inputNodeSet
The original NodeSet for this XMLSignatureInput -
subNode
The original Element -
excludeNode
Exclude Node *for enveloped transformations* -
excludeComments
private boolean excludeComments -
isNodeSet
private boolean isNodeSet -
bytes
private byte[] bytesA cached bytes -
secureValidation
private boolean secureValidation -
mimeType
Some Transforms may require explicit MIME type, charset (IANA registered "character set"), or other such information concerning the data they are receiving from an earlier Transform or the source data, although no Transform algorithm specified in this document needs such explicit information. Such data characteristics are provided as parameters to the Transform algorithm and should be described in the specification for the algorithm. -
sourceURI
Field sourceURI -
nodeFilters
Node Filter list. -
needsToBeExpanded
private boolean needsToBeExpanded -
outputStream
-
preCalculatedDigest
Pre-calculated digest value of the object in base64.
-
-
Constructor Details
-
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
Constructs aXMLSignatureInput
from an octet stream. The stream is directly read.- Parameters:
inputOctetStream
-
-
XMLSignatureInput
Construct a XMLSignatureInput from a subtree rooted by rootNode. This method included the node and all his descendants in the output.- Parameters:
rootNode
-
-
XMLSignatureInput
Constructor XMLSignatureInput- Parameters:
inputNodeSet
-
-
XMLSignatureInput
Construct aXMLSignatureInput
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 Details
-
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 CanonicalizationException, ParserConfigurationException, IOException, SAXExceptionReturns the node set from input which was specified as the parameter ofXMLSignatureInput
constructor- Returns:
- the node set
- Throws:
SAXException
IOException
ParserConfigurationException
CanonicalizationException
-
getInputNodeSet
Get the Input NodeSet.- Returns:
- the Input NodeSet.
-
getNodeSet
public Set<Node> getNodeSet(boolean circumvent) throws ParserConfigurationException, IOException, SAXException, CanonicalizationException Returns the node set from input which was specified as the parameter ofXMLSignatureInput
constructor- Parameters:
circumvent
-- Returns:
- the node set
- Throws:
SAXException
IOException
ParserConfigurationException
CanonicalizationException
-
getOctetStream
Returns the Octet stream(byte Stream) from input which was specified as the parameter ofXMLSignatureInput
constructor- Returns:
- the Octet stream(byte Stream) from input which was specified as
the parameter of
XMLSignatureInput
constructor - Throws:
IOException
-
getOctetStreamReal
- Returns:
- real octet stream
-
getBytes
Returns the byte array from input which was specified as the parameter ofXMLSignatureInput
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 ifsetOutputStream(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 is 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:
-
isInitialized
public boolean isInitialized()Is the object correctly set up?- Returns:
- true if the object has been set up correctly
-
getMIMEType
Returns mimeType- Returns:
- mimeType
-
setMIMEType
Sets mimeType- Parameters:
mimeType
-
-
getSourceURI
Return SourceURI- Returns:
- SourceURI
-
setSourceURI
Sets SourceURI- Parameters:
sourceURI
-
-
toString
Method toString -
getHTMLRepresentation
Method getHTMLRepresentation- Returns:
- The HTML representation for this XMLSignature
- Throws:
XMLSignatureException
-
getHTMLRepresentation
Method getHTMLRepresentation- Parameters:
inclusiveNamespaces
-- Returns:
- The HTML representation for this XMLSignature
- Throws:
XMLSignatureException
-
getExcludeNode
Gets the exclude node of this XMLSignatureInput- Returns:
- Returns the excludeNode.
-
setExcludeNode
Sets the exclude node of this XMLSignatureInput- Parameters:
excludeNode
- The excludeNode to set.
-
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
- Parameters:
diOs
-- Throws:
IOException
CanonicalizationException
-
updateOutputStream
public void updateOutputStream(OutputStream diOs, boolean c14n11) throws CanonicalizationException, IOException - Throws:
CanonicalizationException
IOException
-
setOutputStream
- Parameters:
os
-
-
getBytesFromInputStream
- Throws:
IOException
-
addNodeFilter
- Parameters:
filter
-
-
getNodeFilters
- Returns:
- the node filters
-
setNodeSet
public void setNodeSet(boolean b) - Parameters:
b
-
-
convertToNodes
void convertToNodes() throws CanonicalizationException, ParserConfigurationException, IOException, SAXException -
isSecureValidation
public boolean isSecureValidation() -
setSecureValidation
public void setSecureValidation(boolean secureValidation) -
getPreCalculatedDigest
-