DOMSignContext (Java Platform SE 8 ) (original) (raw)

• 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

  Constructors

  Constructor	Description
  DOMSignContext(Key signingKey,Node parent)	Creates a DOMSignContext with the specified signing key and parent node.
  DOMSignContext(Key signingKey,Node parent,Node nextSibling)	Creates a DOMSignContext with the specified signing key, parent and next sibling nodes.
  DOMSignContext(KeySelector ks,Node parent)	Creates a DOMSignContext with the specified key selector and parent node.
  DOMSignContext(KeySelector ks,Node parent,Node nextSibling)	Creates a DOMSignContext with the specified key selector, parent and next sibling nodes.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  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](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html "class in javax.xml.crypto.dom")  
     `[get](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#get-java.lang.Object-), [getBaseURI](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#getBaseURI--), [getDefaultNamespacePrefix](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#getDefaultNamespacePrefix--), [getElementById](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#getElementById-java.lang.String-), [getKeySelector](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#getKeySelector--), [getNamespacePrefix](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#getNamespacePrefix-java.lang.String-java.lang.String-), [getProperty](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#getProperty-java.lang.String-), [getURIDereferencer](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#getURIDereferencer--), [iterator](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#iterator--), [put](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#put-java.lang.Object-java.lang.Object-), [putNamespacePrefix](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#putNamespacePrefix-java.lang.String-java.lang.String-), [setBaseURI](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#setBaseURI-java.lang.String-), [setDefaultNamespacePrefix](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#setDefaultNamespacePrefix-java.lang.String-), [setIdAttributeNS](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#setIdAttributeNS-org.w3c.dom.Element-java.lang.String-java.lang.String-), [setKeySelector](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#setKeySelector-javax.xml.crypto.KeySelector-), [setProperty](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#setProperty-java.lang.String-java.lang.Object-), [setURIDereferencer](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#setURIDereferencer-javax.xml.crypto.URIDereferencer-)`  
     * ### Methods inherited from class java.lang.[Object](../../../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../../../java/lang/Object.html#clone--), [equals](../../../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../../../java/lang/Object.html#finalize--), [getClass](../../../../../java/lang/Object.html#getClass--), [hashCode](../../../../../java/lang/Object.html#hashCode--), [notify](../../../../../java/lang/Object.html#notify--), [notifyAll](../../../../../java/lang/Object.html#notifyAll--), [toString](../../../../../java/lang/Object.html#toString--), [wait](../../../../../java/lang/Object.html#wait--), [wait](../../../../../java/lang/Object.html#wait-long-), [wait](../../../../../java/lang/Object.html#wait-long-int-)`  
     * ### Methods inherited from interface javax.xml.crypto.[XMLCryptoContext](../../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")  
     `[get](../../../../../javax/xml/crypto/XMLCryptoContext.html#get-java.lang.Object-), [getBaseURI](../../../../../javax/xml/crypto/XMLCryptoContext.html#getBaseURI--), [getDefaultNamespacePrefix](../../../../../javax/xml/crypto/XMLCryptoContext.html#getDefaultNamespacePrefix--), [getKeySelector](../../../../../javax/xml/crypto/XMLCryptoContext.html#getKeySelector--), [getNamespacePrefix](../../../../../javax/xml/crypto/XMLCryptoContext.html#getNamespacePrefix-java.lang.String-java.lang.String-), [getProperty](../../../../../javax/xml/crypto/XMLCryptoContext.html#getProperty-java.lang.String-), [getURIDereferencer](../../../../../javax/xml/crypto/XMLCryptoContext.html#getURIDereferencer--), [put](../../../../../javax/xml/crypto/XMLCryptoContext.html#put-java.lang.Object-java.lang.Object-), [putNamespacePrefix](../../../../../javax/xml/crypto/XMLCryptoContext.html#putNamespacePrefix-java.lang.String-java.lang.String-), [setBaseURI](../../../../../javax/xml/crypto/XMLCryptoContext.html#setBaseURI-java.lang.String-), [setDefaultNamespacePrefix](../../../../../javax/xml/crypto/XMLCryptoContext.html#setDefaultNamespacePrefix-java.lang.String-), [setKeySelector](../../../../../javax/xml/crypto/XMLCryptoContext.html#setKeySelector-javax.xml.crypto.KeySelector-), [setProperty](../../../../../javax/xml/crypto/XMLCryptoContext.html#setProperty-java.lang.String-java.lang.Object-), [setURIDereferencer](../../../../../javax/xml/crypto/XMLCryptoContext.html#setURIDereferencer-javax.xml.crypto.URIDereferencer-)`

• • Constructor Detail

     * #### DOMSignContext  
     public DOMSignContext([Key](../../../../../java/security/Key.html "interface in java.security") signingKey,  
                           [Node](../../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") parent)  
     Creates a `DOMSignContext` with the specified signing key and parent node. The signing key is stored in a[singleton KeySelector](../../../../../javax/xml/crypto/KeySelector.html#singletonKeySelector-java.security.Key-) that is returned by the [getKeySelector](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#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](../../../../../javax/xml/crypto/dsig/dom/DOMSignContext.html#setNextSibling-org.w3c.dom.Node-) 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](../../../../../java/security/Key.html "interface in java.security") signingKey,  
                           [Node](../../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") parent,  
                           [Node](../../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") nextSibling)  
     Creates a `DOMSignContext` with the specified signing key, parent and next sibling nodes. The signing key is stored in a[singleton KeySelector](../../../../../javax/xml/crypto/KeySelector.html#singletonKeySelector-java.security.Key-) that is returned by the [getKeySelector](../../../../../javax/xml/crypto/dom/DOMCryptoContext.html#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](../../../../../javax/xml/crypto/KeySelector.html "class in javax.xml.crypto") ks,  
                           [Node](../../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") 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](../../../../../javax/xml/crypto/dsig/dom/DOMSignContext.html#setNextSibling-org.w3c.dom.Node-) 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](../../../../../javax/xml/crypto/KeySelector.html "class in javax.xml.crypto") ks,  
                           [Node](../../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") parent,  
                           [Node](../../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") 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](../../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") 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:  
    [getParent()](../../../../../javax/xml/crypto/dsig/dom/DOMSignContext.html#getParent--)  
    * #### setNextSibling  
    public void setNextSibling([Node](../../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") 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:  
    [getNextSibling()](../../../../../javax/xml/crypto/dsig/dom/DOMSignContext.html#getNextSibling--)  
    * #### getParent  
    public [Node](../../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") getParent()  
    Returns the parent node.  
    Returns:  
    the parent node (never `null`)  
    See Also:  
    [setParent(Node)](../../../../../javax/xml/crypto/dsig/dom/DOMSignContext.html#setParent-org.w3c.dom.Node-)  
    * #### getNextSibling  
    public [Node](../../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") getNextSibling()  
    Returns the nextSibling node.  
    Returns:  
    the nextSibling node, or `null` if not specified.  
    See Also:  
    [setNextSibling(Node)](../../../../../javax/xml/crypto/dsig/dom/DOMSignContext.html#setNextSibling-org.w3c.dom.Node-)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.