|
XML Digital Signature and Encryption, 1.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectjavax.xml.crypto.dom.DOMCryptoContext
public class DOMCryptoContext
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 | |
|---|---|
protected |
DOMCryptoContext()
Default constructor. |
| Method Summary | |
|---|---|
java.lang.Object |
get(java.lang.Object key)
This implementation uses an internal HashMap to get the object
that the specified key maps to. |
java.lang.String |
getBaseURI()
Returns the base URI. |
java.lang.String |
getDefaultNamespacePrefix()
Returns the default namespace prefix. |
org.w3c.dom.Element |
getElementById(java.lang.String idValue)
Returns the Element with the specified ID attribute value. |
KeySelector |
getKeySelector()
Returns the key selector for finding a key. |
java.lang.String |
getNamespacePrefix(java.lang.String namespaceURI,
java.lang.String defaultPrefix)
Returns the namespace prefix that the specified namespace URI is associated with. |
java.lang.Object |
getProperty(java.lang.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. |
java.util.Iterator |
iterator()
Returns a read-only iterator over the set of Id/Element mappings of this DOMCryptoContext. |
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. |
java.lang.String |
putNamespacePrefix(java.lang.String namespaceURI,
java.lang.String prefix)
Maps the specified namespace URI to the specified prefix. |
void |
setBaseURI(java.lang.String baseURI)
Sets the base URI. |
void |
setDefaultNamespacePrefix(java.lang.String defaultPrefix)
Sets the default namespace prefix. |
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. |
void |
setKeySelector(KeySelector ks)
Sets the key selector for finding a key. |
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. |
void |
setURIDereferencer(URIDereferencer dereferencer)
Sets a URIDereferencer that is used to dereference
URIReferences. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected DOMCryptoContext()
| Method Detail |
|---|
public java.lang.String getNamespacePrefix(java.lang.String namespaceURI,
java.lang.String defaultPrefix)
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.
java.lang.NullPointerException - if namespaceURI is
nullputNamespacePrefix(String, String)
public java.lang.String putNamespacePrefix(java.lang.String namespaceURI,
java.lang.String 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 none
java.lang.NullPointerException - if namespaceURI is
nullgetNamespacePrefix(String, String)public java.lang.String getDefaultNamespacePrefix()
putNamespacePrefix method.
getDefaultNamespacePrefix in interface XMLCryptoContextnull if none has
been set.setDefaultNamespacePrefix(String)public void setDefaultNamespacePrefix(java.lang.String defaultPrefix)
putNamespacePrefix method.
setDefaultNamespacePrefix in interface XMLCryptoContextdefaultPrefix - the default namespace prefix, or null
to remove the current setting. Specify the empty string
("") to bind no prefix.getDefaultNamespacePrefix()public java.lang.String getBaseURI()
XMLCryptoContext
getBaseURI in interface XMLCryptoContextnull if not specifiedXMLCryptoContext.setBaseURI(String)public void setBaseURI(java.lang.String baseURI)
XMLCryptoContext
setBaseURI in interface XMLCryptoContextbaseURI - the base URI, or null to remove current
value
java.lang.IllegalArgumentException - 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 java.lang.Object getProperty(java.lang.String name)
HashMap to get the object
that the specified name maps to.
getProperty in interface XMLCryptoContextname - the name of the property
null if it does not have a value
java.lang.NullPointerException - if name is nullXMLCryptoContext.setProperty(String, Object)
public java.lang.Object setProperty(java.lang.String name,
java.lang.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 set
null if it did not have a value
java.lang.NullPointerException - if name is nullXMLCryptoContext.getProperty(String)public KeySelector getKeySelector()
XMLCryptoContext
getKeySelector in interface XMLCryptoContextnull if not specifiedXMLCryptoContext.setKeySelector(KeySelector)public void setKeySelector(KeySelector ks)
XMLCryptoContext
setKeySelector in interface XMLCryptoContextks - the key selector, or null to remove the current
settingXMLCryptoContext.getKeySelector()public org.w3c.dom.Element getElementById(java.lang.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 ID
Element with the specified ID attribute value,
or null if none.
java.lang.NullPointerException - if idValue is nullsetIdAttributeNS(org.w3c.dom.Element, java.lang.String, java.lang.String)
public void setIdAttributeNS(org.w3c.dom.Element element,
java.lang.String namespaceURI,
java.lang.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 attribute
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 nullgetElementById(java.lang.String)public java.util.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 java.lang.Object get(java.lang.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 returned
null if there is no mapping for the keyXMLCryptoContext.put(Object, Object)
public java.lang.Object put(java.lang.Object key,
java.lang.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 key
null
if there was no mapping for the key
java.lang.IllegalArgumentException - if some aspect of this key or value
prevents it from being stored in this contextXMLCryptoContext.get(Object)
|
XML Digital Signature and Encryption, 1.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||