javax.xml.crypto.dsig.dom
Class DOMValidateContext

java.lang.Object
  javax.xml.crypto.dsig.dom.DOMValidateContext

All Implemented Interfaces:

DOMIdMap, XMLCryptoContext, XMLValidateContext

public class DOMValidateContext

extends java.lang.Object

implements XMLValidateContext, DOMIdMap

A DOM-specific XMLValidateContext. This class contains additional methods to specify the location in a DOM tree where an XMLSignature is to be unmarshalled and validated from.

Note that the behavior of an unmarshalled XMLSignature is undefined if the contents of the underlying DOM tree are modified by the caller after the XMLSignature is created.

Also, note that DOMValidateContext instances can contain information and state specific to the XML signature structure it is used with. The results are unpredictable if a DOMValidateContext is used with different signature structures (for example, you should not use the same DOMValidateContext instance to validate two different XMLSignature objects).

See Also:

XMLSignatureFactory.unmarshalXMLSignature(XMLValidateContext)

Constructor Summary

DOMValidateContext(java.security.Key validatingKey, Node node)
Creates a DOMValidateContext containing the specified key and node.

DOMValidateContext(KeySelector ks, Node node)
Creates a DOMValidateContext containing the specified key selector and node.

DOMValidateContext(Node node)
Creates a DOMValidateContext containing the specified node.

Method Summary

java.lang.Object	get(java.lang.Object key) Returns the value to which this context maps the specified key.
java.lang.String	getBaseURI() Returns the base URI.
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.
Node	getNode() Returns the node.
java.lang.Object	getProperty(java.lang.String name) Returns the value of the specified property.
URIDereferencer	getURIDereferencer() Returns a URIDereferencer that is used to dereference URIReferences.
java.lang.Object	put(java.lang.Object key, java.lang.Object value) Associates the specified value with the specified key in this context.
void	setBaseURI(java.lang.String baseURI) Sets the base URI.
void	setIdAttributeNS(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.
void	setNode(Node node) Sets the node.
java.lang.Object	setProperty(java.lang.String name, java.lang.Object value) Sets the specified property.
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

DOMValidateContext

public DOMValidateContext(KeySelector ks,
                          Node node)

Creates a DOMValidateContext containing the specified key selector and node.

Parameters:

ks - a key selector for finding a validation key

node - the node

Throws:

java.lang.NullPointerException - if ks or node is null

DOMValidateContext

public DOMValidateContext(java.security.Key validatingKey,
                          Node node)

Creates a DOMValidateContext containing the specified key and node. The validating key is stored in a singleton KeySelector that is returned by the getKeySelector method.

Parameters:

validatingKey - the validating key

node - the node

Throws:

java.lang.NullPointerException - if validatingKey or node is null

DOMValidateContext

public DOMValidateContext(Node node)

Creates a DOMValidateContext containing the specified node. This constructor is useful if you only want to unmarshal (and not validate) an XMLSignature.

Parameters:

node - the node

Throws:

java.lang.NullPointerException - if node is null

Method Detail

setNode

public void setNode(Node node)

Sets the node.

Parameters:

node - the node

Throws:

java.lang.NullPointerException - if node is null

See Also:

getNode()

getNode

public Node getNode()

Returns the node.

Returns:

the node (never null)

See Also:

setNode(Node)

getKeySelector

public KeySelector getKeySelector()

Description copied from interface: XMLCryptoContext

Returns the key selector for finding a key.

Specified by:

getKeySelector in interface XMLCryptoContext

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

Sets the key selector for finding a key.

Specified by:

setKeySelector in interface XMLCryptoContext

Parameters:

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

See Also:

XMLCryptoContext.getKeySelector()

getBaseURI

public java.lang.String getBaseURI()

Description copied from interface: XMLCryptoContext

Returns the base URI.

Specified by:

getBaseURI in interface XMLCryptoContext

Returns:

the base URI, or null if not specified

See Also:

XMLCryptoContext.setBaseURI(String)

setBaseURI

public void setBaseURI(java.lang.String baseURI)

Description copied from interface: XMLCryptoContext

Sets the base URI.

Specified by:

setBaseURI in interface XMLCryptoContext

Parameters:

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

Throws:

java.lang.IllegalArgumentException - if baseURI is not RFC 2396 compliant

See Also:

XMLCryptoContext.getBaseURI()

getURIDereferencer

public URIDereferencer getURIDereferencer()

Description copied from interface: XMLCryptoContext

Returns a URIDereferencer that is used to dereference URIReferences.

Specified by:

getURIDereferencer in interface XMLCryptoContext

Returns:

the URIDereferencer, or null if not specified

See Also:

XMLCryptoContext.setURIDereferencer(URIDereferencer)

setURIDereferencer

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:

setURIDereferencer in interface XMLCryptoContext

Parameters:

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

See Also:

XMLCryptoContext.getURIDereferencer()

getProperty

public java.lang.Object getProperty(java.lang.String name)

Description copied from interface: XMLCryptoContext

Returns the value of the specified property.

Specified by:

getProperty in interface XMLCryptoContext

Parameters:

name - the name of the property

Returns:

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

See Also:

XMLCryptoContext.setProperty(String, Object)

setProperty

public java.lang.Object setProperty(java.lang.String name,
                                    java.lang.Object value)

Description copied from interface: XMLCryptoContext

Sets the specified property.

Specified by:

setProperty in interface XMLCryptoContext

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:

XMLCryptoContext.getProperty(String)

getElementById

public Element getElementById(java.lang.String idValue)

Description copied from interface: DOMIdMap

Returns the Element with the specified ID attribute value.

Specified by:

getElementById in interface DOMIdMap

Parameters:

idValue - the value of the ID

Returns:

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

See Also:

DOMIdMap.setIdAttributeNS(org.w3c.dom.Element, java.lang.String, java.lang.String)

setIdAttributeNS

public void setIdAttributeNS(Element element,
                             java.lang.String namespaceURI,
                             java.lang.String localName)

Description copied from interface: DOMIdMap

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.

Specified by:

setIdAttributeNS in interface DOMIdMap

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:

DOMIdMap.getElementById(java.lang.String)

get

public java.lang.Object get(java.lang.Object key)

Description copied from interface: XMLCryptoContext

Returns the value to which this context maps the specified key.

More formally, if this context contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

This method is useful for retrieving arbitrary information that is specific to the cryptographic operation that this context is used for.

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:

XMLCryptoContext.put(Object, Object)

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

Description copied from interface: XMLCryptoContext

Associates the specified value with the specified key in this context. If the context previously contained a mapping for this key, the old value is replaced by the specified value.

This method is useful for storing arbitrary information that is specific to the cryptographic operation that this context is used for.

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:

XMLCryptoContext.get(Object)