compact3
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-specificXMLSignContext. This class contains additional methods to specify the location in a DOM tree where anXMLSignatureobject is to be marshalled when generating the signature.Note that
DOMSignContextinstances can contain information and state specific to the XML signature structure it is used with. The results are unpredictable if aDOMSignContextis used with different signature structures (for example, you should not use the sameDOMSignContextinstance to sign two differentXMLSignatureobjects).- Since:
- 1.6
-
-
Constructor Summary
Constructors Constructor and Description DOMSignContext(Key signingKey, Node parent)Creates aDOMSignContextwith the specified signing key and parent node.DOMSignContext(Key signingKey, Node parent, Node nextSibling)Creates aDOMSignContextwith the specified signing key, parent and next sibling nodes.DOMSignContext(KeySelector ks, Node parent)Creates aDOMSignContextwith the specified key selector and parent node.DOMSignContext(KeySelector ks, Node parent, Node nextSibling)Creates aDOMSignContextwith the specified key selector, parent and next sibling nodes.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description NodegetNextSibling()Returns the nextSibling node.NodegetParent()Returns the parent node.voidsetNextSibling(Node nextSibling)Sets the next sibling node.voidsetParent(Node parent)Sets the parent node.-
Methods inherited from class javax.xml.crypto.dom.DOMCryptoContext
get, getBaseURI, getDefaultNamespacePrefix, getElementById, getKeySelector, getNamespacePrefix, getProperty, getURIDereferencer, iterator, put, putNamespacePrefix, setBaseURI, setDefaultNamespacePrefix, setIdAttributeNS, setKeySelector, setProperty, setURIDereferencer
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface javax.xml.crypto.XMLCryptoContext
get, getBaseURI, getDefaultNamespacePrefix, getKeySelector, getNamespacePrefix, getProperty, getURIDereferencer, put, putNamespacePrefix, setBaseURI, setDefaultNamespacePrefix, setKeySelector, setProperty, setURIDereferencer
-
-
-
-
Constructor Detail
DOMSignContext
public DOMSignContext(Key signingKey, Node parent)
Creates aDOMSignContextwith the specified signing key and parent node. The signing key is stored in asingleton KeySelectorthat is returned by thegetKeySelectormethod. The marshalledXMLSignaturewill be added as the last child element of the specified parent node unless a next sibling node is specified by invoking thesetNextSiblingmethod.- Parameters:
-
signingKey- the signing key -
parent- the parent node - Throws:
-
NullPointerException- ifsigningKeyorparentisnull
DOMSignContext
public DOMSignContext(Key signingKey, Node parent, Node nextSibling)
Creates aDOMSignContextwith the specified signing key, parent and next sibling nodes. The signing key is stored in asingleton KeySelectorthat is returned by thegetKeySelectormethod. The marshalledXMLSignaturewill 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- ifsigningKey,parentornextSiblingisnull
DOMSignContext
public DOMSignContext(KeySelector ks, Node parent)
Creates aDOMSignContextwith the specified key selector and parent node. The marshalledXMLSignaturewill be added as the last child element of the specified parent node unless a next sibling node is specified by invoking thesetNextSiblingmethod.- Parameters:
-
ks- the key selector -
parent- the parent node - Throws:
-
NullPointerException- ifksorparentisnull
DOMSignContext
public DOMSignContext(KeySelector ks, Node parent, Node nextSibling)
Creates aDOMSignContextwith the specified key selector, parent and next sibling nodes. The marshalledXMLSignaturewill 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- ifks,parentornextSiblingisnull
-
Method Detail
setParent
public void setParent(Node parent)
Sets the parent node.- Parameters:
-
parent- the parent node. The marshalledXMLSignaturewill be added as a child element of this node. - Throws:
-
NullPointerException- ifparentisnull - See Also:
-
getParent()
setNextSibling
public void setNextSibling(Node nextSibling)
Sets the next sibling node.- Parameters:
-
nextSibling- the next sibling node. The marshalledXMLSignaturewill be inserted immediately before this node. Specifynullto remove the current setting. - See Also:
-
getNextSibling()
getParent
public Node getParent()
Returns the parent node.- Returns:
-
the parent node (never
null) - See Also:
-
setParent(Node)
getNextSibling
public Node getNextSibling()
Returns the nextSibling node.- Returns:
-
the nextSibling node, or
nullif not specified. - See Also:
-
setNextSibling(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, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
