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 and Description |
|---|---|
protected |
DOMCryptoContext()
Default constructor.
|
| Modifier and Type | Method and 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 dereference
URIReferences. |
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 dereference
URIReferences. |
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 XMLCryptoContextnamespaceURI - 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
nullXMLCryptoContext.putNamespacePrefix(String, String)public String putNamespacePrefix(String namespaceURI, String prefix)
HashMap to map the URI
to the specified prefix.putNamespacePrefix in interface XMLCryptoContextnamespaceURI - 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
nullXMLCryptoContext.getNamespacePrefix(String, String)public String getDefaultNamespacePrefix()
XMLCryptoContextputNamespacePrefix method.getDefaultNamespacePrefix in interface XMLCryptoContextnull if none has
been set.XMLCryptoContext.setDefaultNamespacePrefix(String)public void setDefaultNamespacePrefix(String defaultPrefix)
XMLCryptoContextputNamespacePrefix method.setDefaultNamespacePrefix in interface XMLCryptoContextdefaultPrefix - the default namespace prefix, or null
to remove the current setting. Specify the empty string
("") to bind no prefix.XMLCryptoContext.getDefaultNamespacePrefix()public String getBaseURI()
XMLCryptoContextgetBaseURI in interface XMLCryptoContextnull if not specifiedXMLCryptoContext.setBaseURI(String)public void setBaseURI(String baseURI)
XMLCryptoContextsetBaseURI in interface XMLCryptoContextbaseURI - the base URI, or null to remove current
valueIllegalArgumentException - if baseURI is not RFC
2396 compliantXMLCryptoContext.getBaseURI()public URIDereferencer getURIDereferencer()
XMLCryptoContextURIDereferencer that is used to dereference
URIReferences.getURIDereferencer in interface XMLCryptoContextURIDereferencer, or null if not
specifiedXMLCryptoContext.setURIDereferencer(URIDereferencer)public void setURIDereferencer(URIDereferencer dereferencer)
XMLCryptoContextURIDereferencer that is used to dereference
URIReferences. The specified URIDereferencer
is used in place of an implementation's default
URIDereferencer.setURIDereferencer in interface XMLCryptoContextdereferencer - the URIDereferencer, or
null to remove any current settingXMLCryptoContext.getURIDereferencer()public Object getProperty(String name)
HashMap to get the object
that the specified name maps to.getProperty in interface XMLCryptoContextname - the name of the propertynull if it does not have a valueNullPointerException - if name is nullXMLCryptoContext.setProperty(String, Object)public Object setProperty(String name, Object value)
HashMap to map the name
to the specified object.setProperty in interface XMLCryptoContextname - the name of the propertyvalue - the value of the property to be setnull if it did not have a valueNullPointerException - if name is nullXMLCryptoContext.getProperty(String)public KeySelector getKeySelector()
XMLCryptoContextgetKeySelector in interface XMLCryptoContextnull if not specifiedXMLCryptoContext.setKeySelector(KeySelector)public void setKeySelector(KeySelector ks)
XMLCryptoContextsetKeySelector in interface XMLCryptoContextks - the key selector, or null to remove the current
settingXMLCryptoContext.getKeySelector()public 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 nullsetIdAttributeNS(org.w3c.dom.Element, java.lang.String, java.lang.String)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 nullgetElementById(java.lang.String)public Iterator 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 XMLCryptoContextkey - 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)
HashMap to map the key
to the specified object.put in interface XMLCryptoContextkey - 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) 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, 2017, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.