|
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.DOMSignContext
A DOM-specific XMLSignContext
. This class contains additional methods
to specify the location in a DOM tree where an XMLSignature
object is to be marshalled before generating the signature.
Note that DOMSignContext
instances can contain
information and state specific to the XML signature structure it is
used with. The results are unpredictable if a
DOMSignContext
is used with different signature structures
(for example, you should not use the same DOMSignContext
instance to sign two different XMLSignature
objects).
Constructor Summary | |
DOMSignContext(Key signingKey,
Node parent)
Creates a DOMSignContext with the specified signing key
and parent node. |
|
DOMSignContext(Key signingKey,
Node parent,
Node nextSibling)
Creates a DOMSignContext with the specified signing key,
parent and next sibling nodes. |
|
DOMSignContext(KeySelector ks,
Node parent)
Creates a DOMSignContext with the specified key selector
and parent node. |
|
DOMSignContext(KeySelector ks,
Node parent,
Node nextSibling)
Creates a DOMSignContext with the specified key selector,
parent and next sibling nodes. |
Method Summary | |
Object |
get(Object key)
Returns the value to which this context maps the specified key. |
String |
getBaseURI()
Returns the base URI. |
String |
getDefaultNamespacePrefix()
Returns the default namespace prefix. |
Element |
getElementById(String idValue)
Returns the Element with the specified ID attribute value. |
KeySelector |
getKeySelector()
Returns the key selector for finding a key. |
String |
getNamespacePrefix(String namespaceURI,
String defaultPrefix)
Returns the namespace prefix that the specified namespace URI is associated with. |
Node |
getNextSibling()
Returns the nextSibling node. |
Node |
getParent()
Returns the parent 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. |
String |
putNamespacePrefix(String namespaceURI,
String prefix)
Maps the specified namespace URI to the specified prefix. |
void |
setBaseURI(String baseURI)
Sets the base URI. |
void |
setDefaultNamespacePrefix(String defaultPrefix)
Sets the default namespace prefix. |
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 |
setNextSibling(Node nextSibling)
Sets the next sibling node. |
void |
setParent(Node parent)
Sets the parent 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 DOMSignContext(Key signingKey, Node parent)
DOMSignContext
with the specified signing key
and parent node. The signing key is stored in a
singleton KeySelector
that is
returned by the getKeySelector
method.
The marshalled XMLSignature
will be added as the last
child element of the specified parent node unless a next sibling node is
specified by invoking the setNextSibling
method.
signingKey
- the signing keyparent
- the parent node
NullPointerException
- if signingKey
or
parent
is null
public DOMSignContext(Key signingKey, Node parent, Node nextSibling)
DOMSignContext
with the specified signing key,
parent and next sibling nodes. The signing key is stored in a
singleton KeySelector
that is
returned by the getKeySelector
method.
The marshalled XMLSignature
will be inserted as a child
element of the specified parent node and immediately before the
specified next sibling node.
signingKey
- the signing keyparent
- the parent nodenextSibling
- the next sibling node
NullPointerException
- if signingKey
,
parent
or nextSibling
is null
public DOMSignContext(KeySelector ks, Node parent)
DOMSignContext
with the specified key selector
and parent node. The marshalled XMLSignature
will be added
as the last child element of the specified parent node unless a next
sibling node is specified by invoking the
setNextSibling
method.
ks
- the key selectorparent
- the parent node
NullPointerException
- if ks
or parent
is null
public DOMSignContext(KeySelector ks, Node parent, Node nextSibling)
DOMSignContext
with the specified key selector,
parent and next sibling nodes. The marshalled XMLSignature
will be inserted as a child element of the specified parent node and
immediately before the specified next sibling node.
ks
- the key selectorparent
- the parent nodenextSibling
- the next sibling node
NullPointerException
- if ks
, parent
or
nextSibling
is null
Method Detail |
public void setParent(Node parent)
parent
- the parent node. The marshalled XMLSignature
will be added as a child element of this node.
NullPointerException
- if parent
is null
getParent()
public void setNextSibling(Node nextSibling)
nextSibling
- the next sibling node. The marshalled
XMLSignature
will be inserted immediately before this
node. Specify null
to remove the current setting.getNextSibling()
public Node getParent()
null
)setParent(Node)
public Node getNextSibling()
null
if not specified.setNextSibling(Node)
public String getNamespacePrefix(String namespaceURI, String defaultPrefix)
putNamespacePrefix
method.
namespaceURI
- 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.
NullPointerException
- if namespaceURI
is
null
putNamespacePrefix(String, String)
public String putNamespacePrefix(String namespaceURI, String prefix)
namespaceURI
- 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
NullPointerException
- if namespaceURI
is
null
getNamespacePrefix(String, String)
public String getDefaultNamespacePrefix()
putNamespacePrefix
method.
null
if none has
been set.setDefaultNamespacePrefix(String)
public void setDefaultNamespacePrefix(String defaultPrefix)
putNamespacePrefix
method.
defaultPrefix
- the default namespace prefix, or null
to remove the current setting. Specify the empty string
(""
) to bind no prefix.getDefaultNamespacePrefix()
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 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 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 |