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

java.lang.Object
- javax.xml.crypto.dom.DOMCryptoContext
All Implemented Interfaces:
XMLCryptoContext
Direct Known Subclasses:
DOMSignContext, DOMValidateContext

public class DOMCryptoContext
extends Object
implements XMLCryptoContext
This class provides a DOM-specific implementation of theXMLCryptoContext interface. It also includes additional methods that are specific to a DOM-based implementation for registering and retrieving elements that contain attributes of type ID.
Since:
1.6

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DOMCryptoContext()	Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
Object	get(Object key)	This implementation uses an internal HashMap to get the object that the specified key maps to.
String	getBaseURI()	Returns the base URI.
String	getDefaultNamespacePrefix()	Returns the default namespace prefix.
Element	getElementById(String idValue)	Returns the Element with the specified ID attribute value.
KeySelector	getKeySelector()	Returns the key selector for finding a key.
String	getNamespacePrefix(String namespaceURI,String defaultPrefix)	This implementation uses an internal HashMap to get the prefix that the specified URI maps to.
Object	getProperty(String name)	This implementation uses an internal HashMap to get the object that the specified name maps to.
URIDereferencer	getURIDereferencer()	Returns a URIDereferencer that is used to dereferenceURIReferences.
Iterator	iterator()	Returns a read-only iterator over the set of Id/Element mappings of this DOMCryptoContext.
Object	put(Object key,Object value)	This implementation uses an internal HashMap to map the key to the specified object.
String	putNamespacePrefix(String namespaceURI,String prefix)	This implementation uses an internal HashMap to map the URI to the specified prefix.
void	setBaseURI(String baseURI)	Sets the base URI.
void	setDefaultNamespacePrefix(String defaultPrefix)	Sets the default namespace prefix.
void	setIdAttributeNS(Element element,String namespaceURI,String localName)	Registers the element's attribute specified by the namespace URI and local name to be of type ID.
void	setKeySelector(KeySelector ks)	Sets the key selector for finding a key.
Object	setProperty(String name,Object value)	This implementation uses an internal HashMap to map the name to the specified object.
void	setURIDereferencer(URIDereferencer dereferencer)	Sets a URIDereferencer that is used to dereferenceURIReferences.

   * ### 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-)`

Constructor Detail

 * #### DOMCryptoContext  
 protected DOMCryptoContext()  
 Default constructor. (For invocation by subclass constructors).

Method Detail

* #### getNamespacePrefix  
public [String](../../../../java/lang/String.html "class in java.lang") getNamespacePrefix([String](../../../../java/lang/String.html "class in java.lang") namespaceURI,  
                                 [String](../../../../java/lang/String.html "class in java.lang") defaultPrefix)  
This implementation uses an internal [HashMap](../../../../java/util/HashMap.html "class in java.util") to get the prefix that the specified URI maps to. It returns the `defaultPrefix` if it maps to `null`.  
Specified by:  
`[getNamespacePrefix](../../../../javax/xml/crypto/XMLCryptoContext.html#getNamespacePrefix-java.lang.String-java.lang.String-)` in interface `[XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")`  
Parameters:  
`namespaceURI` \- a namespace URI  
`defaultPrefix` \- the prefix to be returned in the event that the the specified namespace URI has not been bound to a prefix.  
Returns:  
the prefix that is associated with the specified namespace URI, or `defaultPrefix` if the URI is not registered. If the namespace URI is registered but has no prefix, an empty string (`""`) is returned.  
Throws:  
`[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")` \- if `namespaceURI` is`null`  
See Also:  
[XMLCryptoContext.putNamespacePrefix(String, String)](../../../../javax/xml/crypto/XMLCryptoContext.html#putNamespacePrefix-java.lang.String-java.lang.String-)  
* #### putNamespacePrefix  
public [String](../../../../java/lang/String.html "class in java.lang") putNamespacePrefix([String](../../../../java/lang/String.html "class in java.lang") namespaceURI,  
                                 [String](../../../../java/lang/String.html "class in java.lang") prefix)  
This implementation uses an internal [HashMap](../../../../java/util/HashMap.html "class in java.util") to map the URI to the specified prefix.  
Specified by:  
`[putNamespacePrefix](../../../../javax/xml/crypto/XMLCryptoContext.html#putNamespacePrefix-java.lang.String-java.lang.String-)` in interface `[XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")`  
Parameters:  
`namespaceURI` \- a namespace URI  
`prefix` \- a namespace prefix (or `null` to remove any existing mapping). Specifying the empty string (`""`) binds no prefix to the namespace URI.  
Returns:  
the previous prefix associated with the specified namespace URI, or `null` if there was none  
Throws:  
`[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")` \- if `namespaceURI` is`null`  
See Also:  
[XMLCryptoContext.getNamespacePrefix(String, String)](../../../../javax/xml/crypto/XMLCryptoContext.html#getNamespacePrefix-java.lang.String-java.lang.String-)  
* #### getDefaultNamespacePrefix  
public [String](../../../../java/lang/String.html "class in java.lang") getDefaultNamespacePrefix()  
Returns the default namespace prefix. The default namespace prefix is the prefix for all namespace URIs not explicitly set by the[putNamespacePrefix](../../../../javax/xml/crypto/XMLCryptoContext.html#putNamespacePrefix-java.lang.String-java.lang.String-) method.  
Specified by:  
`[getDefaultNamespacePrefix](../../../../javax/xml/crypto/XMLCryptoContext.html#getDefaultNamespacePrefix--)` in interface `[XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")`  
Returns:  
the default namespace prefix, or `null` if none has been set.  
See Also:  
[XMLCryptoContext.setDefaultNamespacePrefix(String)](../../../../javax/xml/crypto/XMLCryptoContext.html#setDefaultNamespacePrefix-java.lang.String-)  
* #### setDefaultNamespacePrefix  
public void setDefaultNamespacePrefix([String](../../../../java/lang/String.html "class in java.lang") defaultPrefix)  
Sets the default namespace prefix. This sets the namespace prefix for all namespace URIs not explicitly set by the [putNamespacePrefix](../../../../javax/xml/crypto/XMLCryptoContext.html#putNamespacePrefix-java.lang.String-java.lang.String-) method.  
Specified by:  
`[setDefaultNamespacePrefix](../../../../javax/xml/crypto/XMLCryptoContext.html#setDefaultNamespacePrefix-java.lang.String-)` in interface `[XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")`  
Parameters:  
`defaultPrefix` \- the default namespace prefix, or `null` to remove the current setting. Specify the empty string (`""`) to bind no prefix.  
See Also:  
[XMLCryptoContext.getDefaultNamespacePrefix()](../../../../javax/xml/crypto/XMLCryptoContext.html#getDefaultNamespacePrefix--)  
* #### getBaseURI  
public [String](../../../../java/lang/String.html "class in java.lang") getBaseURI()  
Returns the base URI.  
Specified by:  
`[getBaseURI](../../../../javax/xml/crypto/XMLCryptoContext.html#getBaseURI--)` in interface `[XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")`  
Returns:  
the base URI, or `null` if not specified  
See Also:  
[XMLCryptoContext.setBaseURI(String)](../../../../javax/xml/crypto/XMLCryptoContext.html#setBaseURI-java.lang.String-)  
* #### setBaseURI  
public void setBaseURI([String](../../../../java/lang/String.html "class in java.lang") baseURI)  
Sets the base URI.  
Specified by:  
`[setBaseURI](../../../../javax/xml/crypto/XMLCryptoContext.html#setBaseURI-java.lang.String-)` in interface `[XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")`  
Parameters:  
`baseURI` \- the base URI, or `null` to remove current value  
Throws:  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `baseURI` is not RFC 2396 compliant  
See Also:  
[XMLCryptoContext.getBaseURI()](../../../../javax/xml/crypto/XMLCryptoContext.html#getBaseURI--)  
* #### getURIDereferencer  
public [URIDereferencer](../../../../javax/xml/crypto/URIDereferencer.html "interface in javax.xml.crypto") getURIDereferencer()  
Returns a `URIDereferencer` that is used to dereference[URIReference](../../../../javax/xml/crypto/URIReference.html "interface in javax.xml.crypto")s.  
Specified by:  
`[getURIDereferencer](../../../../javax/xml/crypto/XMLCryptoContext.html#getURIDereferencer--)` in interface `[XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")`  
Returns:  
the `URIDereferencer`, or `null` if not specified  
See Also:  
[XMLCryptoContext.setURIDereferencer(URIDereferencer)](../../../../javax/xml/crypto/XMLCryptoContext.html#setURIDereferencer-javax.xml.crypto.URIDereferencer-)  
* #### setURIDereferencer  
public void setURIDereferencer([URIDereferencer](../../../../javax/xml/crypto/URIDereferencer.html "interface in javax.xml.crypto") dereferencer)  
Sets a `URIDereferencer` that is used to dereference[URIReference](../../../../javax/xml/crypto/URIReference.html "interface in javax.xml.crypto")s. The specified `URIDereferencer` is used in place of an implementation's default`URIDereferencer`.  
Specified by:  
`[setURIDereferencer](../../../../javax/xml/crypto/XMLCryptoContext.html#setURIDereferencer-javax.xml.crypto.URIDereferencer-)` in interface `[XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")`  
Parameters:  
`dereferencer` \- the `URIDereferencer`, or`null` to remove any current setting  
See Also:  
[XMLCryptoContext.getURIDereferencer()](../../../../javax/xml/crypto/XMLCryptoContext.html#getURIDereferencer--)  
* #### getProperty  
public [Object](../../../../java/lang/Object.html "class in java.lang") getProperty([String](../../../../java/lang/String.html "class in java.lang") name)  
This implementation uses an internal [HashMap](../../../../java/util/HashMap.html "class in java.util") to get the object that the specified name maps to.  
Specified by:  
`[getProperty](../../../../javax/xml/crypto/XMLCryptoContext.html#getProperty-java.lang.String-)` in interface `[XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")`  
Parameters:  
`name` \- the name of the property  
Returns:  
the current value of the specified property, or`null` if it does not have a value  
Throws:  
`[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")` \- if `name` is `null`  
See Also:  
[XMLCryptoContext.setProperty(String, Object)](../../../../javax/xml/crypto/XMLCryptoContext.html#setProperty-java.lang.String-java.lang.Object-)  
* #### setProperty  
public [Object](../../../../java/lang/Object.html "class in java.lang") setProperty([String](../../../../java/lang/String.html "class in java.lang") name,  
                          [Object](../../../../java/lang/Object.html "class in java.lang") value)  
This implementation uses an internal [HashMap](../../../../java/util/HashMap.html "class in java.util") to map the name to the specified object.  
Specified by:  
`[setProperty](../../../../javax/xml/crypto/XMLCryptoContext.html#setProperty-java.lang.String-java.lang.Object-)` in interface `[XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")`  
Parameters:  
`name` \- the name of the property  
`value` \- the value of the property to be set  
Returns:  
the previous value of the specified property, or`null` if it did not have a value  
Throws:  
`[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")` \- if `name` is `null`  
See Also:  
[XMLCryptoContext.getProperty(String)](../../../../javax/xml/crypto/XMLCryptoContext.html#getProperty-java.lang.String-)  
* #### getKeySelector  
public [KeySelector](../../../../javax/xml/crypto/KeySelector.html "class in javax.xml.crypto") getKeySelector()  
Returns the key selector for finding a key.  
Specified by:  
`[getKeySelector](../../../../javax/xml/crypto/XMLCryptoContext.html#getKeySelector--)` in interface `[XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")`  
Returns:  
the key selector, or `null` if not specified  
See Also:  
[XMLCryptoContext.setKeySelector(KeySelector)](../../../../javax/xml/crypto/XMLCryptoContext.html#setKeySelector-javax.xml.crypto.KeySelector-)  
* #### setKeySelector  
public void setKeySelector([KeySelector](../../../../javax/xml/crypto/KeySelector.html "class in javax.xml.crypto") ks)  
Sets the key selector for finding a key.  
Specified by:  
`[setKeySelector](../../../../javax/xml/crypto/XMLCryptoContext.html#setKeySelector-javax.xml.crypto.KeySelector-)` in interface `[XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")`  
Parameters:  
`ks` \- the key selector, or `null` to remove the current setting  
See Also:  
[XMLCryptoContext.getKeySelector()](../../../../javax/xml/crypto/XMLCryptoContext.html#getKeySelector--)  
* #### getElementById  
public [Element](../../../../org/w3c/dom/Element.html "interface in org.w3c.dom") getElementById([String](../../../../java/lang/String.html "class in java.lang") idValue)  
Returns the `Element` with the specified ID attribute value.  
This implementation uses an internal [HashMap](../../../../java/util/HashMap.html "class in java.util") to get the element that the specified attribute value maps to.  
Parameters:  
`idValue` \- the value of the ID  
Returns:  
the `Element` with the specified ID attribute value, or `null` if none.  
Throws:  
`[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")` \- if `idValue` is `null`  
See Also:  
[setIdAttributeNS(org.w3c.dom.Element, java.lang.String, java.lang.String)](../../../../javax/xml/crypto/dom/DOMCryptoContext.html#setIdAttributeNS-org.w3c.dom.Element-java.lang.String-java.lang.String-)  
* #### setIdAttributeNS  
public void setIdAttributeNS([Element](../../../../org/w3c/dom/Element.html "interface in org.w3c.dom") element,  
                             [String](../../../../java/lang/String.html "class in java.lang") namespaceURI,  
                             [String](../../../../java/lang/String.html "class in java.lang") localName)  
Registers the element's attribute specified by the namespace URI and local name to be of type ID. The attribute must have a non-empty value.  
This implementation uses an internal [HashMap](../../../../java/util/HashMap.html "class in java.util") to map the attribute's value to the specified element.  
Parameters:  
`element` \- the element  
`namespaceURI` \- the namespace URI of the attribute (specify`null` if not applicable)  
`localName` \- the local name of the attribute  
Throws:  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `localName` is not an attribute of the specified element or it does not contain a specific value  
`[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")` \- if `element` or`localName` is `null`  
See Also:  
[getElementById(java.lang.String)](../../../../javax/xml/crypto/dom/DOMCryptoContext.html#getElementById-java.lang.String-)  
* #### iterator  
public [Iterator](../../../../java/util/Iterator.html "interface in java.util") iterator()  
Returns a read-only iterator over the set of Id/Element mappings of this `DOMCryptoContext`. Attempts to modify the set via the[Iterator.remove()](../../../../java/util/Iterator.html#remove--) method throw an`UnsupportedOperationException`. The mappings are returned in no particular order. Each element in the iteration is represented as a[Map.Entry](../../../../java/util/Map.Entry.html "interface in java.util"). If the `DOMCryptoContext` is modified while an iteration is in progress, the results of the iteration are undefined.  
Returns:  
a read-only iterator over the set of mappings  
* #### get  
public [Object](../../../../java/lang/Object.html "class in java.lang") get([Object](../../../../java/lang/Object.html "class in java.lang") key)  
This implementation uses an internal [HashMap](../../../../java/util/HashMap.html "class in java.util") to get the object that the specified key maps to.  
Specified by:  
`[get](../../../../javax/xml/crypto/XMLCryptoContext.html#get-java.lang.Object-)` in interface `[XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")`  
Parameters:  
`key` \- the key whose associated value is to be returned  
Returns:  
the value to which this context maps the specified key, or`null` if there is no mapping for the key  
See Also:  
[XMLCryptoContext.put(Object, Object)](../../../../javax/xml/crypto/XMLCryptoContext.html#put-java.lang.Object-java.lang.Object-)  
* #### put  
public [Object](../../../../java/lang/Object.html "class in java.lang") put([Object](../../../../java/lang/Object.html "class in java.lang") key,  
                  [Object](../../../../java/lang/Object.html "class in java.lang") value)  
This implementation uses an internal [HashMap](../../../../java/util/HashMap.html "class in java.util") to map the key to the specified object.  
Specified by:  
`[put](../../../../javax/xml/crypto/XMLCryptoContext.html#put-java.lang.Object-java.lang.Object-)` in interface `[XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")`  
Parameters:  
`key` \- key with which the specified value is to be associated with  
`value` \- value to be associated with the specified key  
Returns:  
the previous value associated with the key, or `null` if there was no mapping for the key  
Throws:  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if some aspect of this key or value prevents it from being stored in this context  
See Also:  
[XMLCryptoContext.get(Object)](../../../../javax/xml/crypto/XMLCryptoContext.html#get-java.lang.Object-)

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.

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

Constructor Summary

Method Summary

Constructor Detail

Method Detail