DOMSignContext (Java Platform SE 6) (original) (raw)
javax.xml.crypto.dsig.dom
Class DOMSignContext
java.lang.Object
javax.xml.crypto.dom.DOMCryptoContext
javax.xml.crypto.dsig.dom.DOMSignContext
All Implemented Interfaces:
XMLSignContext, XMLCryptoContext
public class DOMSignContext
extends DOMCryptoContext
implements XMLSignContext
A DOM-specific XMLSignContext. This class contains additional methods to specify the location in a DOM tree where an XMLSignature object is to be marshalled when generating the signature.
Note that DOMSignContext instances can contain information and state specific to the XML signature structure it is used with. The results are unpredictable if aDOMSignContext is used with different signature structures (for example, you should not use the same DOMSignContext instance to sign two different XMLSignature objects).
Since:
1.6
| Constructor Summary |
|---|
| [DOMSignContext](../../../../../javax/xml/crypto/dsig/dom/DOMSignContext.html#DOMSignContext%28java.security.Key, org.w3c.dom.Node%29)(Key signingKey,Node parent) Creates a DOMSignContext with the specified signing key and parent node. |
| [DOMSignContext](../../../../../javax/xml/crypto/dsig/dom/DOMSignContext.html#DOMSignContext%28java.security.Key, org.w3c.dom.Node, org.w3c.dom.Node%29)(Key signingKey,Node parent,Node nextSibling) Creates a DOMSignContext with the specified signing key, parent and next sibling nodes. |
| [DOMSignContext](../../../../../javax/xml/crypto/dsig/dom/DOMSignContext.html#DOMSignContext%28javax.xml.crypto.KeySelector, org.w3c.dom.Node%29)(KeySelector ks,Node parent) Creates a DOMSignContext with the specified key selector and parent node. |
| [DOMSignContext](../../../../../javax/xml/crypto/dsig/dom/DOMSignContext.html#DOMSignContext%28javax.xml.crypto.KeySelector, org.w3c.dom.Node, org.w3c.dom.Node%29)(KeySelector ks,Node parent,Node nextSibling) Creates a DOMSignContext with the specified key selector, parent and next sibling nodes. |
| Method Summary | |
|---|---|
| Node | getNextSibling() Returns the nextSibling node. |
| Node | getParent() Returns the parent node. |
| void | setNextSibling(Node nextSibling) Sets the next sibling node. |
| void | setParent(Node parent) Sets the parent node. |
| Methods inherited from class javax.xml.crypto.dom.DOMCryptoContext |
|---|
| get, getBaseURI, getDefaultNamespacePrefix, getElementById, getKeySelector, [getNamespacePrefix](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#getNamespacePrefix%28java.lang.String, java.lang.String%29), getProperty, getURIDereferencer, iterator, [put](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#put%28java.lang.Object, java.lang.Object%29), [putNamespacePrefix](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#putNamespacePrefix%28java.lang.String, java.lang.String%29), setBaseURI, setDefaultNamespacePrefix, [setIdAttributeNS](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#setIdAttributeNS%28org.w3c.dom.Element, java.lang.String, java.lang.String%29), setKeySelector, [setProperty](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#setProperty%28java.lang.String, java.lang.Object%29), setURIDereferencer |
| Methods inherited from class java.lang.Object |
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../../../java/lang/Object.html#wait%28long, int%29) |
| Methods inherited from interface javax.xml.crypto.XMLCryptoContext |
|---|
| get, getBaseURI, getDefaultNamespacePrefix, getKeySelector, [getNamespacePrefix](../../../../../javax/xml/crypto/XMLCryptoContext.html#getNamespacePrefix%28java.lang.String, java.lang.String%29), getProperty, getURIDereferencer, [put](../../../../../javax/xml/crypto/XMLCryptoContext.html#put%28java.lang.Object, java.lang.Object%29), [putNamespacePrefix](../../../../../javax/xml/crypto/XMLCryptoContext.html#putNamespacePrefix%28java.lang.String, java.lang.String%29), setBaseURI, setDefaultNamespacePrefix, setKeySelector, [setProperty](../../../../../javax/xml/crypto/XMLCryptoContext.html#setProperty%28java.lang.String, java.lang.Object%29), setURIDereferencer |
| Constructor Detail |
|---|
DOMSignContext
public DOMSignContext(Key signingKey, Node parent)
Creates a DOMSignContext with the specified signing key and parent node. The signing key is stored in asingleton KeySelector that is returned by the getKeySelector method. The marshalled XMLSignature will be added as the last child element of the specified parent node unless a next sibling node is specified by invoking the setNextSibling method.
Parameters:
signingKey - the signing key
parent - the parent node
Throws:
[NullPointerException](../../../../../java/lang/NullPointerException.html "class in java.lang") - if signingKey or parent is null
DOMSignContext
public DOMSignContext(Key signingKey, Node parent, Node nextSibling)
Creates a DOMSignContext with the specified signing key, parent and next sibling nodes. The signing key is stored in asingleton KeySelector that is returned by the getKeySelector method. The marshalled XMLSignature will be inserted as a child element of the specified parent node and immediately before the specified next sibling node.
Parameters:
signingKey - the signing key
parent - the parent node
nextSibling - the next sibling node
Throws:
[NullPointerException](../../../../../java/lang/NullPointerException.html "class in java.lang") - if signingKey, parent or nextSibling is null
DOMSignContext
public DOMSignContext(KeySelector ks, Node parent)
Creates a DOMSignContext with the specified key selector and parent node. The marshalled XMLSignature will be added as the last child element of the specified parent node unless a next sibling node is specified by invoking the setNextSibling method.
Parameters:
ks - the key selector
parent - the parent node
Throws:
[NullPointerException](../../../../../java/lang/NullPointerException.html "class in java.lang") - if ks or parent is null
DOMSignContext
public DOMSignContext(KeySelector ks, Node parent, Node nextSibling)
Creates a DOMSignContext with the specified key selector, parent and next sibling nodes. The marshalled XMLSignature will be inserted as a child element of the specified parent node and immediately before the specified next sibling node.
Parameters:
ks - the key selector
parent - the parent node
nextSibling - the next sibling node
Throws:
[NullPointerException](../../../../../java/lang/NullPointerException.html "class in java.lang") - if ks, parent or nextSibling is null
| Method Detail |
|---|
setParent
public void setParent(Node parent)
Sets the parent node.
Parameters:
parent - the parent node. The marshalled XMLSignature will be added as a child element of this node.
Throws:
[NullPointerException](../../../../../java/lang/NullPointerException.html "class in java.lang") - if parent is null
See Also:
setNextSibling
public void setNextSibling(Node nextSibling)
Sets the next sibling node.
Parameters:
nextSibling - the next sibling node. The marshalled XMLSignature will be inserted immediately before this node. Specify null to remove the current setting.
See Also:
getParent
public Node getParent()
Returns the parent node.
Returns:
the parent node (never null)
See Also:
getNextSibling
public Node getNextSibling()
Returns the nextSibling node.
Returns:
the nextSibling node, or null if not specified.
See Also:
Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.