|
JSR 105, v0.13 (Proposed Final Draft) | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.xml.crypto.dsig.dom.DOMValidateContext
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).
XMLSignatureFactory.unmarshalXMLSignature(XMLValidateContext)
Constructor Summary | |
DOMValidateContext(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 | |
Object |
get(Object key)
Returns the value to which this context maps the specified key. |
String |
getBaseURI()
Returns the base URI. |
Element |
getElementById(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. |
Object |
getProperty(String name)
Returns the value of the specified property. |
URIDereferencer |
getURIDereferencer()
Returns a URIDereferencer that is used to dereference
URIReference s. |
Object |
put(Object key,
Object value)
Associates the specified value with the specified key in this context. |
void |
setBaseURI(String baseURI)
Sets the base URI. |
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. |
void |
setKeySelector(KeySelector ks)
Sets the key selector for finding a key. |
void |
setNode(Node node)
Sets the node. |
Object |
setProperty(String name,
Object value)
Sets the specified property. |
void |
setURIDereferencer(URIDereferencer dereferencer)
Sets a URIDereferencer that is used to dereference
URIReference s. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DOMValidateContext(KeySelector ks, Node node)
DOMValidateContext
containing the specified key
selector and node.
ks
- a key selector for finding a validation keynode
- the node
NullPointerException
- if ks
or node
is
null
public DOMValidateContext(Key validatingKey, Node node)
DOMValidateContext
containing the specified key
and node. The validating key is stored in a
singleton KeySelector
that
is returned by the getKeySelector
method.
validatingKey
- the validating keynode
- the node
NullPointerException
- if validatingKey
or
node
is null
public DOMValidateContext(Node node)
DOMValidateContext
containing the specified node.
This constructor is useful if you only want to unmarshal (and not
validate) an XMLSignature
.
node
- the node
NullPointerException
- if node
is null
Method Detail |
public void setNode(Node node)
node
- the node
NullPointerException
- if node
is null
getNode()
public Node getNode()
null
)setNode(Node)
public KeySelector getKeySelector()
XMLCryptoContext
getKeySelector
in interface XMLCryptoContext
null
if not specifiedXMLCryptoContext.setKeySelector(KeySelector)
public void setKeySelector(KeySelector ks)
XMLCryptoContext
setKeySelector
in interface XMLCryptoContext
ks
- the key selector, or null
to remove the current
settingXMLCryptoContext.getKeySelector()
public String getBaseURI()
XMLCryptoContext
getBaseURI
in interface XMLCryptoContext
null
if not specifiedXMLCryptoContext.setBaseURI(String)
public void setBaseURI(String baseURI)
XMLCryptoContext
setBaseURI
in interface XMLCryptoContext
baseURI
- the base URI, or null
to remove current
value
IllegalArgumentException
XMLCryptoContext.getBaseURI()
public URIDereferencer getURIDereferencer()
XMLCryptoContext
URIDereferencer
that is used to dereference
URIReference
s.
getURIDereferencer
in interface XMLCryptoContext
URIDereferencer
, or null
if not
specifiedXMLCryptoContext.setURIDereferencer(URIDereferencer)
public void setURIDereferencer(URIDereferencer dereferencer)
XMLCryptoContext
URIDereferencer
that is used to dereference
URIReference
s. The specified URIDereferencer
is used in place of an implementation's default
URIDereferencer
.
setURIDereferencer
in interface XMLCryptoContext
dereferencer
- the URIDereferencer
, or
null
to remove any current settingXMLCryptoContext.getURIDereferencer()
public Object getProperty(String name)
XMLCryptoContext
getProperty
in interface XMLCryptoContext
name
- the name of the property
null
if it does not have a valueXMLCryptoContext.setProperty(String, Object)
public Object setProperty(String name, Object value)
XMLCryptoContext
setProperty
in interface XMLCryptoContext
name
- the name of the propertyvalue
- the value of the property to be set
null
if it did not have a value
NullPointerException
XMLCryptoContext.getProperty(String)
public Element getElementById(String idValue)
DOMIdMap
Element
with the specified ID attribute value.
getElementById
in interface DOMIdMap
idValue
- the value of the ID
Element
with the specified ID attribute value,
or null
if none.DOMIdMap.setIdAttributeNS(org.w3c.dom.Element, java.lang.String, java.lang.String)
public void setIdAttributeNS(Element element, String namespaceURI, String localName)
DOMIdMap
setIdAttributeNS
in interface DOMIdMap
element
- the elementnamespaceURI
- the namespace URI of the attribute (specify
null
if not applicable)localName
- the local name of the attribute
IllegalArgumentException
- if localName
is not an
attribute of the specified element or it does not contain a specific
value
NullPointerException
- if element
or
localName
is null
DOMIdMap.getElementById(java.lang.String)
public Object get(Object key)
XMLCryptoContext
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.
get
in interface XMLCryptoContext
key
- the key whose associated value is to be returned
null
if there is no mapping for the keyXMLCryptoContext.put(Object, Object)
public Object put(Object key, Object value)
XMLCryptoContext
This method is useful for storing arbitrary information that is specific to the cryptographic operation that this context is used for.
put
in interface XMLCryptoContext
key
- 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
IllegalArgumentException
XMLCryptoContext.get(Object)
|
JSR 105, v0.13 (Proposed Final Draft) | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |