XMLCryptoContext
DOMSignContext
, DOMValidateContext
public class DOMCryptoContext extends Object implements XMLCryptoContext
XMLCryptoContext
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.Modifier | Constructor | Description |
---|---|---|
protected |
Default constructor. |
Modifier and Type | Method | Description |
---|---|---|
Object |
get |
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 |
Returns the Element with the specified ID attribute value. |
KeySelector |
getKeySelector() |
Returns the key selector for finding a key. |
String |
getNamespacePrefix |
This implementation uses an internal HashMap to get the prefix that the specified URI maps to. |
Object |
getProperty |
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 dereference URIReference s. |
Iterator |
iterator() |
Returns a read-only iterator over the set of Id/Element mappings of this DOMCryptoContext . |
Object |
put |
This implementation uses an internal HashMap to map the key to the specified object. |
String |
putNamespacePrefix |
This implementation uses an internal HashMap to map the URI to the specified prefix. |
void |
setBaseURI |
Sets the base URI. |
void |
setDefaultNamespacePrefix |
Sets the default namespace prefix. |
void |
setIdAttributeNS |
Registers the element's attribute specified by the namespace URI and local name to be of type ID. |
void |
setKeySelector |
Sets the key selector for finding a key. |
Object |
setProperty |
This implementation uses an internal HashMap to map the name to the specified object. |
void |
setURIDereferencer |
Sets a URIDereferencer that is used to dereference URIReference s. |
protected DOMCryptoContext()
public String getNamespacePrefix(String namespaceURI, String defaultPrefix)
HashMap
to get the prefix that the specified URI maps to. It returns the defaultPrefix
if it maps to null
.getNamespacePrefix
in interface XMLCryptoContext
namespaceURI
- a namespace URIdefaultPrefix
- the prefix to be returned in the event that the the specified namespace URI has not been bound to a prefix.defaultPrefix
if the URI is not registered. If the namespace URI is registered but has no prefix, an empty string (""
) is returned.NullPointerException
- if namespaceURI
is null
public String putNamespacePrefix(String namespaceURI, String prefix)
HashMap
to map the URI to the specified prefix.putNamespacePrefix
in interface XMLCryptoContext
namespaceURI
- a namespace URIprefix
- a namespace prefix (or null
to remove any existing mapping). Specifying the empty string (""
) binds no prefix to the namespace URI.null
if there was noneNullPointerException
- if namespaceURI
is null
public String getDefaultNamespacePrefix()
XMLCryptoContext
putNamespacePrefix
method.getDefaultNamespacePrefix
in interface XMLCryptoContext
null
if none has been set.public void setDefaultNamespacePrefix(String defaultPrefix)
XMLCryptoContext
putNamespacePrefix
method.setDefaultNamespacePrefix
in interface XMLCryptoContext
defaultPrefix
- the default namespace prefix, or null
to remove the current setting. Specify the empty string (""
) to bind no prefix.public String getBaseURI()
XMLCryptoContext
getBaseURI
in interface XMLCryptoContext
null
if not specifiedpublic void setBaseURI(String baseURI)
XMLCryptoContext
setBaseURI
in interface XMLCryptoContext
baseURI
- the base URI, or null
to remove current valueIllegalArgumentException
- if baseURI
is not RFC 2396 compliantpublic URIDereferencer getURIDereferencer()
XMLCryptoContext
URIDereferencer
that is used to dereference URIReference
s.getURIDereferencer
in interface XMLCryptoContext
URIDereferencer
, or null
if not specifiedpublic void setURIDereferencer(URIDereferencer dereferencer)
XMLCryptoContext
URIDereferencer
that is used to dereference URIReference
s. The specified URIDereferencer
is used in place of an implementation's default URIDereferencer
.setURIDereferencer
in interface XMLCryptoContext
dereferencer
- the URIDereferencer
, or null
to remove any current settingpublic Object getProperty(String name)
HashMap
to get the object that the specified name maps to.getProperty
in interface XMLCryptoContext
name
- the name of the propertynull
if it does not have a valueNullPointerException
- if name
is null
public Object setProperty(String name, Object value)
HashMap
to map the name to the specified object.setProperty
in interface XMLCryptoContext
name
- the name of the propertyvalue
- the value of the property to be setnull
if it did not have a valueNullPointerException
- if name
is null
public KeySelector getKeySelector()
XMLCryptoContext
getKeySelector
in interface XMLCryptoContext
null
if not specifiedpublic void setKeySelector(KeySelector ks)
XMLCryptoContext
setKeySelector
in interface XMLCryptoContext
ks
- the key selector, or null
to remove the current settingpublic Element getElementById(String idValue)
Element
with the specified ID attribute value. This implementation uses an internal HashMap
to get the element that the specified attribute value maps to.
idValue
- the value of the IDElement
with the specified ID attribute value, or null
if none.NullPointerException
- if idValue
is null
public void setIdAttributeNS(Element element, String namespaceURI, String localName)
This implementation uses an internal HashMap
to map the attribute's value to the specified element.
element
- the elementnamespaceURI
- the namespace URI of the attribute (specify null
if not applicable)localName
- the local name of the attributeIllegalArgumentException
- if localName
is not an attribute of the specified element or it does not contain a specific valueNullPointerException
- if element
or localName
is null
public Iterator<Map.Entry<String,Element>> iterator()
DOMCryptoContext
. Attempts to modify the set via the Iterator.remove()
method throw an UnsupportedOperationException
. The mappings are returned in no particular order. Each element in the iteration is represented as a Map.Entry
. If the DOMCryptoContext
is modified while an iteration is in progress, the results of the iteration are undefined.public Object get(Object key)
HashMap
to get the object that the specified key maps to.get
in interface XMLCryptoContext
key
- the key whose associated value is to be returnednull
if there is no mapping for the keypublic Object put(Object key, Object value)
HashMap
to map the key to the specified object.put
in interface XMLCryptoContext
key
- key with which the specified value is to be associated withvalue
- value to be associated with the specified keynull
if there was no mapping for the keyIllegalArgumentException
- if some aspect of this key or value prevents it from being stored in this context
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml.crypto/javax/xml/crypto/dom/DOMCryptoContext.html