public class DOMCryptoContext extends Object implements XMLCryptoContext
This class provides a DOM-specific implementation of the 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.
protected DOMCryptoContext()
Default constructor. (For invocation by subclass constructors).
public String getNamespacePrefix(String namespaceURI,
String defaultPrefix) This implementation uses an internal 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
XMLCryptoContext.putNamespacePrefix(String, String)public String putNamespacePrefix(String namespaceURI,
String prefix) This implementation uses an internal 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
XMLCryptoContext.getNamespacePrefix(String, String)public String getDefaultNamespacePrefix()
Description copied from interface: XMLCryptoContext
Returns the default namespace prefix. The default namespace prefix is the prefix for all namespace URIs not explicitly set by the putNamespacePrefix method.
getDefaultNamespacePrefix in interface XMLCryptoContext
null if none has been set.XMLCryptoContext.setDefaultNamespacePrefix(String)public void setDefaultNamespacePrefix(String defaultPrefix)
Description copied from interface: XMLCryptoContext
Sets the default namespace prefix. This sets the namespace prefix for all namespace URIs not explicitly set by the 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.XMLCryptoContext.getDefaultNamespacePrefix()public String getBaseURI()
Description copied from interface: XMLCryptoContext
Returns the base URI.
getBaseURI in interface XMLCryptoContext
null if not specifiedXMLCryptoContext.setBaseURI(String)public void setBaseURI(String baseURI)
Description copied from interface: XMLCryptoContext
Sets the base URI.
setBaseURI in interface XMLCryptoContext
baseURI - the base URI, or null to remove current valueIllegalArgumentException - if baseURI is not RFC 2396 compliantXMLCryptoContext.getBaseURI()public URIDereferencer getURIDereferencer()
Description copied from interface: XMLCryptoContext
Returns a URIDereferencer that is used to dereference URIReferences.
getURIDereferencer in interface XMLCryptoContext
URIDereferencer, or null if not specifiedXMLCryptoContext.setURIDereferencer(URIDereferencer)public void setURIDereferencer(URIDereferencer dereferencer)
Description copied from interface: XMLCryptoContext
Sets a URIDereferencer that is used to dereference URIReferences. 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 settingXMLCryptoContext.getURIDereferencer()public Object getProperty(String name)
This implementation uses an internal 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
XMLCryptoContext.setProperty(String, Object)public Object setProperty(String name,
Object value) This implementation uses an internal 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
XMLCryptoContext.getProperty(String)public KeySelector getKeySelector()
Description copied from interface: XMLCryptoContext
Returns the key selector for finding a key.
getKeySelector in interface XMLCryptoContext
null if not specifiedXMLCryptoContext.setKeySelector(KeySelector)public void setKeySelector(KeySelector ks)
Description copied from interface: XMLCryptoContext
Sets the key selector for finding a key.
setKeySelector in interface XMLCryptoContext
ks - the key selector, or null to remove the current settingXMLCryptoContext.getKeySelector()public Element getElementById(String idValue)
Returns the 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
setIdAttributeNS(org.w3c.dom.Element, java.lang.String, java.lang.String)public 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. The attribute must have a non-empty value.
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
getElementById(java.lang.String)public Iterator 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() 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)
This implementation uses an internal 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 keyXMLCryptoContext.put(Object, Object)public Object put(Object key,
Object value) This implementation uses an internal 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 contextXMLCryptoContext.get(Object)
© 1993–2017, 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.