javax.xml.crypto.dom

Class DOMCryptoContext

  1. java.lang.Object
  2. extended byjavax.xml.crypto.dom.DOMCryptoContext
All implemented interfaces:
XMLCryptoContext
Direct known subclasses:
DOMDecryptContext, DOMEncryptContext, DOMSignContext, DOMValidateContext

  1. public class DOMCryptoContext
  2. extends java.lang.Object
  3. 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.

Constructor Summary

Modifier Constructor and Description
  1. protected
DOMCryptoContext()
Default constructor.

Method Summary

Modifier and Type Method and Description
  1. java.lang.Object
get(java.lang.Object key)
This implementation uses an internal HashMap to get the object that the specified key maps to.
  1. java.lang.String
getBaseURI()
  1. java.lang.String
getDefaultNamespacePrefix()
Returns the default namespace prefix.
  1. org.w3c.dom.Element
getElementById(java.lang.String idValue)
Returns the Element with the specified ID attribute value.
  1. KeySelector
getKeySelector()
  1. java.lang.String
getNamespacePrefix(java.lang.String namespaceURI,java.lang.String defaultPrefix)
Returns the namespace prefix that the specified namespace URI is associated with.
  1. java.lang.Object
getProperty(java.lang.String name)
This implementation uses an internal HashMap to get the object that the specified name maps to.
  1. URIDereferencer
getURIDereferencer()
  1. java.util.Iterator
iterator()
Returns a read-only iterator over the set of Id/Element mappings of this DOMCryptoContext.
  1. java.lang.Object
put(java.lang.Object key,java.lang.Object value)
This implementation uses an internal HashMap to map the key to the specified object.
  1. java.lang.String
putNamespacePrefix(java.lang.String namespaceURI,java.lang.String prefix)
Maps the specified namespace URI to the specified prefix.
  1. void
setBaseURI(java.lang.String baseURI)
  1. void
setDefaultNamespacePrefix(java.lang.String defaultPrefix)
Sets the default namespace prefix.
  1. void
setIdAttributeNS(org.w3c.dom.Element element,java.lang.String namespaceURI,java.lang.String localName)
Registers the element's attribute specified by the namespace URI and local name to be of type ID.
  1. void
setKeySelector(KeySelector ks)
  1. java.lang.Object
setProperty(java.lang.String name,java.lang.Object value)
This implementation uses an internal HashMap to map the name to the specified object.
  1. void
setURIDereferencer(URIDereferencer dereferencer)
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DOMCryptoContext

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

Method Detail

getNamespacePrefix

  1. public java.lang.String getNamespacePrefix( java.lang.String namespaceURI,
  2. java.lang.String defaultPrefix)
Returns the namespace prefix that the specified namespace URI is associated with. Returns the specified default prefix if the specified namespace URI has not been bound to a prefix.
Specified by:
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:
java.lang.NullPointerException - if namespaceURI is null
See Also:

putNamespacePrefix

  1. public java.lang.String putNamespacePrefix( java.lang.String namespaceURI,
  2. java.lang.String prefix)
Maps the specified namespace URI to the specified prefix. If there is already a prefix associated with the specified namespace URI, the old prefix is replaced by the specified prefix.
Specified by:
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:
java.lang.NullPointerException - if namespaceURI is null
See Also:

getDefaultNamespacePrefix

  1. public java.lang.String getDefaultNamespacePrefix( )
Returns the default namespace prefix. The default namespace prefix is the prefix for all namespace URIs not explicitly set by the putNamespacePrefix method.
Specified by:
Returns:
the default namespace prefix, or null if none has been set.
See Also:

setDefaultNamespacePrefix

  1. public void setDefaultNamespacePrefix( java.lang.String defaultPrefix)
Sets the default namespace prefix. This sets the namespace prefix for all namespace URIs not explicitly set by the putNamespacePrefix method.
Specified by:
Parameters:
defaultPrefix - the default namespace prefix, or null to remove the current setting. Specify the empty string ("") to bind no prefix.
See Also:

getBaseURI

  1. public java.lang.String getBaseURI( )
Description copied from interface: XMLCryptoContext
Returns the base URI.
Specified by:
Returns:
the base URI, or null if not specified
See Also:

setBaseURI

  1. public void setBaseURI(java.lang.String baseURI)
Description copied from interface: XMLCryptoContext
Sets the base URI.
Specified by:
Parameters:
baseURI - the base URI, or null to remove current value
Throws:
java.lang.IllegalArgumentException - if baseURI is not RFC 2396 compliant
See Also:

getURIDereferencer

  1. public URIDereferencer getURIDereferencer( )
Description copied from interface: XMLCryptoContext
Returns a URIDereferencer that is used to dereference URIReferences.
Specified by:
Returns:
the URIDereferencer, or null if not specified
See Also:

setURIDereferencer

  1. 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.
Specified by:
Parameters:
dereferencer - the URIDereferencer, or null to remove any current setting
See Also:

getProperty

  1. public java.lang.Object getProperty( java.lang.String name)
This implementation uses an internal HashMap to get the object that the specified name maps to.
Specified by:
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:
java.lang.NullPointerException - if name is null
See Also:

setProperty

  1. public java.lang.Object setProperty( java.lang.String name,
  2. java.lang.Object value)
This implementation uses an internal HashMap to map the name to the specified object.
Specified by:
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:
java.lang.NullPointerException - if name is null
See Also:

getKeySelector

  1. public KeySelector getKeySelector( )
Description copied from interface: XMLCryptoContext
Returns the key selector for finding a key.
Specified by:
Returns:
the key selector, or null if not specified
See Also:

setKeySelector

  1. public void setKeySelector(KeySelector ks)
Description copied from interface: XMLCryptoContext
Sets the key selector for finding a key.
Specified by:
Parameters:
ks - the key selector, or null to remove the current setting
See Also:

getElementById

  1. public org.w3c.dom.Element getElementById( java.lang.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.

Parameters:
idValue - the value of the ID
Returns:
the Element with the specified ID attribute value, or null if none.
Throws:
java.lang.NullPointerException - if idValue is null
See Also:

setIdAttributeNS

  1. public void setIdAttributeNS(org.w3c.dom.Element element,
  2. java.lang.String namespaceURI,
  3. java.lang.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.

Parameters:
element - the element
namespaceURI - the namespace URI of the attribute (specify null if not applicable)
localName - the local name of the attribute
Throws:
java.lang.IllegalArgumentException - if localName is not an attribute of the specified element or it does not contain a specific value
java.lang.NullPointerException - if element or localName is null
See Also:

iterator

  1. public java.util.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.
Returns:
a read-only iterator over the set of mappings

get

  1. public java.lang.Object get(java.lang.Object key)
This implementation uses an internal HashMap to get the object that the specified key maps to.
Specified by:
get in interface XMLCryptoContext
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:

put

  1. public java.lang.Object put(java.lang.Object key,
  2. java.lang.Object value)
This implementation uses an internal HashMap to map the key to the specified object.
Specified by:
put in interface XMLCryptoContext
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:
java.lang.IllegalArgumentException - if some aspect of this key or value prevents it from being stored in this context
See Also: