DOMCryptoContext (Java Platform SE 6) (original) (raw)

javax.xml.crypto.dom

Class DOMCryptoContext

java.lang.Object javax.xml.crypto.dom.DOMCryptoContext

All Implemented Interfaces:

XMLCryptoContext

Direct Known Subclasses:

DOMSignContext, DOMValidateContext

public class DOMCryptoContext

extends Object

implements XMLCryptoContext

This class provides a DOM-specific implementation of theXMLCryptoContext 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

DOMCryptoContext

protected DOMCryptoContext()

Default constructor. (For invocation by subclass constructors).

getNamespacePrefix

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.

Specified by:

[getNamespacePrefix](../../../../javax/xml/crypto/XMLCryptoContext.html#getNamespacePrefix%28java.lang.String, java.lang.String%29) in interface [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")

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:

[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang") - if namespaceURI isnull

See Also:

[XMLCryptoContext.putNamespacePrefix(String, String)](../../../../javax/xml/crypto/XMLCryptoContext.html#putNamespacePrefix%28java.lang.String, java.lang.String%29)

putNamespacePrefix

public String putNamespacePrefix(String namespaceURI, String prefix)

This implementation uses an internal HashMap to map the URI to the specified prefix.

Specified by:

[putNamespacePrefix](../../../../javax/xml/crypto/XMLCryptoContext.html#putNamespacePrefix%28java.lang.String, java.lang.String%29) in interface [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")

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:

[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang") - if namespaceURI isnull

See Also:

[XMLCryptoContext.getNamespacePrefix(String, String)](../../../../javax/xml/crypto/XMLCryptoContext.html#getNamespacePrefix%28java.lang.String, java.lang.String%29)

getDefaultNamespacePrefix

public String getDefaultNamespacePrefix()

Description copied from interface: [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html#getDefaultNamespacePrefix%28%29)

Returns the default namespace prefix. The default namespace prefix is the prefix for all namespace URIs not explicitly set by the[putNamespacePrefix](../../../../javax/xml/crypto/XMLCryptoContext.html#putNamespacePrefix%28java.lang.String, java.lang.String%29) method.

Specified by:

[getDefaultNamespacePrefix](../../../../javax/xml/crypto/XMLCryptoContext.html#getDefaultNamespacePrefix%28%29) in interface [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")

Returns:

the default namespace prefix, or null if none has been set.

See Also:

XMLCryptoContext.setDefaultNamespacePrefix(String)

setDefaultNamespacePrefix

public void setDefaultNamespacePrefix(String defaultPrefix)

Description copied from interface: [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html#setDefaultNamespacePrefix%28java.lang.String%29)

Sets the default namespace prefix. This sets the namespace prefix for all namespace URIs not explicitly set by the [putNamespacePrefix](../../../../javax/xml/crypto/XMLCryptoContext.html#putNamespacePrefix%28java.lang.String, java.lang.String%29) method.

Specified by:

[setDefaultNamespacePrefix](../../../../javax/xml/crypto/XMLCryptoContext.html#setDefaultNamespacePrefix%28java.lang.String%29) in interface [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")

Parameters:

defaultPrefix - the default namespace prefix, or null to remove the current setting. Specify the empty string ("") to bind no prefix.

See Also:

XMLCryptoContext.getDefaultNamespacePrefix()

getBaseURI

public String getBaseURI()

Description copied from interface: [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html#getBaseURI%28%29)

Returns the base URI.

Specified by:

[getBaseURI](../../../../javax/xml/crypto/XMLCryptoContext.html#getBaseURI%28%29) in interface [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")

Returns:

the base URI, or null if not specified

See Also:

XMLCryptoContext.setBaseURI(String)

setBaseURI

public void setBaseURI(String baseURI)

Description copied from interface: [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html#setBaseURI%28java.lang.String%29)

Sets the base URI.

Specified by:

[setBaseURI](../../../../javax/xml/crypto/XMLCryptoContext.html#setBaseURI%28java.lang.String%29) in interface [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")

Parameters:

baseURI - the base URI, or null to remove current value

Throws:

[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang") - if baseURI is not RFC 2396 compliant

See Also:

XMLCryptoContext.getBaseURI()

getURIDereferencer

public URIDereferencer getURIDereferencer()

Description copied from interface: [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html#getURIDereferencer%28%29)

Returns a URIDereferencer that is used to dereferenceURIReferences.

Specified by:

[getURIDereferencer](../../../../javax/xml/crypto/XMLCryptoContext.html#getURIDereferencer%28%29) in interface [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")

Returns:

the URIDereferencer, or null if not specified

See Also:

XMLCryptoContext.setURIDereferencer(URIDereferencer)

setURIDereferencer

public void setURIDereferencer(URIDereferencer dereferencer)

Description copied from interface: [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html#setURIDereferencer%28javax.xml.crypto.URIDereferencer%29)

Sets a URIDereferencer that is used to dereferenceURIReferences. The specified URIDereferencer is used in place of an implementation's default URIDereferencer.

Specified by:

[setURIDereferencer](../../../../javax/xml/crypto/XMLCryptoContext.html#setURIDereferencer%28javax.xml.crypto.URIDereferencer%29) in interface [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")

Parameters:

dereferencer - the URIDereferencer, or null to remove any current setting

See Also:

XMLCryptoContext.getURIDereferencer()

getProperty

public Object getProperty(String name)

This implementation uses an internal HashMap to get the object that the specified name maps to.

Specified by:

[getProperty](../../../../javax/xml/crypto/XMLCryptoContext.html#getProperty%28java.lang.String%29) in interface [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")

Parameters:

name - the name of the property

Returns:

the current value of the specified property, ornull if it does not have a value

Throws:

[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang") - if name is null

See Also:

[XMLCryptoContext.setProperty(String, Object)](../../../../javax/xml/crypto/XMLCryptoContext.html#setProperty%28java.lang.String, java.lang.Object%29)

setProperty

public Object setProperty(String name, Object value)

This implementation uses an internal HashMap to map the name to the specified object.

Specified by:

[setProperty](../../../../javax/xml/crypto/XMLCryptoContext.html#setProperty%28java.lang.String, java.lang.Object%29) in interface [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")

Parameters:

name - the name of the property

value - the value of the property to be set

Returns:

the previous value of the specified property, ornull if it did not have a value

Throws:

[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang") - if name is null

See Also:

XMLCryptoContext.getProperty(String)

getKeySelector

public KeySelector getKeySelector()

Description copied from interface: [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html#getKeySelector%28%29)

Returns the key selector for finding a key.

Specified by:

[getKeySelector](../../../../javax/xml/crypto/XMLCryptoContext.html#getKeySelector%28%29) in interface [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")

Returns:

the key selector, or null if not specified

See Also:

XMLCryptoContext.setKeySelector(KeySelector)

setKeySelector

public void setKeySelector(KeySelector ks)

Description copied from interface: [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html#setKeySelector%28javax.xml.crypto.KeySelector%29)

Sets the key selector for finding a key.

Specified by:

[setKeySelector](../../../../javax/xml/crypto/XMLCryptoContext.html#setKeySelector%28javax.xml.crypto.KeySelector%29) in interface [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")

Parameters:

ks - the key selector, or null to remove the current setting

See Also:

XMLCryptoContext.getKeySelector()

getElementById

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.

Parameters:

idValue - the value of the ID

Returns:

the Element with the specified ID attribute value, or null if none.

Throws:

[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang") - if idValue is null

See Also:

[setIdAttributeNS(org.w3c.dom.Element, java.lang.String, java.lang.String)](../../../../javax/xml/crypto/dom/DOMCryptoContext.html#setIdAttributeNS%28org.w3c.dom.Element, java.lang.String, java.lang.String%29)

setIdAttributeNS

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.

Parameters:

element - the element

namespaceURI - the namespace URI of the attribute (specifynull if not applicable)

localName - the local name of the attribute

Throws:

[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang") - if localName is not an attribute of the specified element or it does not contain a specific value

[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang") - if element orlocalName is null

See Also:

getElementById(java.lang.String)

iterator

public Iterator iterator()

Returns a read-only iterator over the set of Id/Element mappings of this DOMCryptoContext. 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 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

public Object get(Object key)

This implementation uses an internal HashMap to get the object that the specified key maps to.

Specified by:

[get](../../../../javax/xml/crypto/XMLCryptoContext.html#get%28java.lang.Object%29) in interface [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")

Parameters:

key - the key whose associated value is to be returned

Returns:

the value to which this context maps the specified key, ornull if there is no mapping for the key

See Also:

[XMLCryptoContext.put(Object, Object)](../../../../javax/xml/crypto/XMLCryptoContext.html#put%28java.lang.Object, java.lang.Object%29)

put

public Object put(Object key, Object value)

This implementation uses an internal HashMap to map the key to the specified object.

Specified by:

[put](../../../../javax/xml/crypto/XMLCryptoContext.html#put%28java.lang.Object, java.lang.Object%29) in interface [XMLCryptoContext](../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto")

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:

[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang") - if some aspect of this key or value prevents it from being stored in this context

See Also:

XMLCryptoContext.get(Object)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.