Class DOMCryptoContext
java.lang.Object
javax.xml.crypto.dom.DOMCryptoContext
- All Implemented Interfaces:
XMLCryptoContext
- Direct Known Subclasses:
DOMSignContext,DOMValidateContext
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.- Since:
- 1.6
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThis implementation uses an internalHashMapto get the object that the specified key maps to.Returns the base URI.Returns the default namespace prefix.getElementById(String idValue) Returns theElementwith the specified ID attribute value.Returns the key selector for finding a key.getNamespacePrefix(String namespaceURI, String defaultPrefix) This implementation uses an internalHashMapto get the prefix that the specified URI maps to.getProperty(String name) This implementation uses an internalHashMapto get the object that the specified name maps to.Returns aURIDereferencerthat is used to dereferenceURIReferences.iterator()Returns a read-only iterator over the set of Id/Element mappings of thisDOMCryptoContext.This implementation uses an internalHashMapto map the key to the specified object.putNamespacePrefix(String namespaceURI, String prefix) This implementation uses an internalHashMapto map the URI to the specified prefix.voidsetBaseURI(String baseURI) Sets the base URI.voidsetDefaultNamespacePrefix(String defaultPrefix) Sets the default namespace prefix.voidsetIdAttributeNS(Element element, String namespaceURI, String localName) Registers the element's attribute specified by the namespace URI and local name to be of type ID.voidSets the key selector for finding a key.setProperty(String name, Object value) This implementation uses an internalHashMapto map the name to the specified object.voidsetURIDereferencer(URIDereferencer dereferencer) Sets aURIDereferencerthat is used to dereferenceURIReferences.
-
Constructor Details
-
DOMCryptoContext
protected DOMCryptoContext()Default constructor. (For invocation by subclass constructors).
-
-
Method Details
-
getNamespacePrefix
This implementation uses an internalHashMapto get the prefix that the specified URI maps to. It returns thedefaultPrefixif it maps tonull.- Specified by:
getNamespacePrefixin interfaceXMLCryptoContext- Parameters:
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.- Returns:
- the prefix that is associated with the specified namespace URI,
or
defaultPrefixif the URI is not registered. If the namespace URI is registered but has no prefix, an empty string ("") is returned. - Throws:
NullPointerException- ifnamespaceURIisnull- See Also:
-
putNamespacePrefix
This implementation uses an internalHashMapto map the URI to the specified prefix.- Specified by:
putNamespacePrefixin interfaceXMLCryptoContext- Parameters:
namespaceURI- a namespace URIprefix- a namespace prefix (ornullto 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
nullif there was none - Throws:
NullPointerException- ifnamespaceURIisnull- See Also:
-
getDefaultNamespacePrefix
Description copied from interface:XMLCryptoContextReturns the default namespace prefix. The default namespace prefix is the prefix for all namespace URIs not explicitly set by theputNamespacePrefixmethod.- Specified by:
getDefaultNamespacePrefixin interfaceXMLCryptoContext- Returns:
- the default namespace prefix, or
nullif none has been set. - See Also:
-
setDefaultNamespacePrefix
Description copied from interface:XMLCryptoContextSets the default namespace prefix. This sets the namespace prefix for all namespace URIs not explicitly set by theputNamespacePrefixmethod.- Specified by:
setDefaultNamespacePrefixin interfaceXMLCryptoContext- Parameters:
defaultPrefix- the default namespace prefix, ornullto remove the current setting. Specify the empty string ("") to bind no prefix.- See Also:
-
getBaseURI
Description copied from interface:XMLCryptoContextReturns the base URI.- Specified by:
getBaseURIin interfaceXMLCryptoContext- Returns:
- the base URI, or
nullif not specified - See Also:
-
setBaseURI
Description copied from interface:XMLCryptoContextSets the base URI.- Specified by:
setBaseURIin interfaceXMLCryptoContext- Parameters:
baseURI- the base URI, ornullto remove current value- Throws:
IllegalArgumentException- ifbaseURIis not RFC 2396 compliant- See Also:
-
getURIDereferencer
Description copied from interface:XMLCryptoContextReturns aURIDereferencerthat is used to dereferenceURIReferences.- Specified by:
getURIDereferencerin interfaceXMLCryptoContext- Returns:
- the
URIDereferencer, ornullif not specified - See Also:
-
setURIDereferencer
Description copied from interface:XMLCryptoContextSets aURIDereferencerthat is used to dereferenceURIReferences. The specifiedURIDereferenceris used in place of an implementation's defaultURIDereferencer.- Specified by:
setURIDereferencerin interfaceXMLCryptoContext- Parameters:
dereferencer- theURIDereferencer, ornullto remove any current setting- See Also:
-
getProperty
This implementation uses an internalHashMapto get the object that the specified name maps to.- Specified by:
getPropertyin interfaceXMLCryptoContext- Parameters:
name- the name of the property- Returns:
- the current value of the specified property, or
nullif it does not have a value - Throws:
NullPointerException- ifnameisnull- See Also:
-
setProperty
This implementation uses an internalHashMapto map the name to the specified object.- Specified by:
setPropertyin interfaceXMLCryptoContext- Parameters:
name- the name of the propertyvalue- the value of the property to be set- Returns:
- the previous value of the specified property, or
nullif it did not have a value - Throws:
NullPointerException- ifnameisnull- See Also:
-
getKeySelector
Description copied from interface:XMLCryptoContextReturns the key selector for finding a key.- Specified by:
getKeySelectorin interfaceXMLCryptoContext- Returns:
- the key selector, or
nullif not specified - See Also:
-
setKeySelector
Description copied from interface:XMLCryptoContextSets the key selector for finding a key.- Specified by:
setKeySelectorin interfaceXMLCryptoContext- Parameters:
ks- the key selector, ornullto remove the current setting- See Also:
-
getElementById
Returns theElementwith the specified ID attribute value.This implementation uses an internal
HashMapto get the element that the specified attribute value maps to.- Parameters:
idValue- the value of the ID- Returns:
- the
Elementwith the specified ID attribute value, ornullif none. - Throws:
NullPointerException- ifidValueisnull- See Also:
-
setIdAttributeNS
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
HashMapto map the attribute's value to the specified element.- Parameters:
element- the elementnamespaceURI- the namespace URI of the attribute (specifynullif not applicable)localName- the local name of the attribute- Throws:
IllegalArgumentException- iflocalNameis not an attribute of the specified element or it does not contain a specific valueNullPointerException- ifelementorlocalNameisnull- See Also:
-
iterator
Returns a read-only iterator over the set of Id/Element mappings of thisDOMCryptoContext. Attempts to modify the set via theIterator.remove()method throw anUnsupportedOperationException. The mappings are returned in no particular order. Each element in the iteration is represented as aMap.Entry. If theDOMCryptoContextis 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
This implementation uses an internalHashMapto get the object that the specified key maps to.- Specified by:
getin interfaceXMLCryptoContext- Parameters:
key- the key whose associated value is to be returned- Returns:
- the value to which this context maps the specified key, or
nullif there is no mapping for the key - See Also:
-
put
This implementation uses an internalHashMapto map the key to the specified object.- Specified by:
putin interfaceXMLCryptoContext- Parameters:
key- key with which the specified value is to be associated withvalue- value to be associated with the specified key- Returns:
- the previous value associated with the key, or
nullif there was no mapping for the key - Throws:
IllegalArgumentException- if some aspect of this key or value prevents it from being stored in this context- See Also:
-