javax.xml.crypto
Interface XMLCryptoContext
- public interface XMLCryptoContext
This interface contains methods for setting and retrieving properties that affect the processing of XML signatures or XML encrypted structures.
Note that XMLCryptoContext instances can contain information
and state specific to the XML cryptographic structure it is used with.
The results are unpredictable if an XMLCryptoContext is
used with multiple structures (for example, you should not use the same
XMLValidateContext instance to validate two
different XMLSignature objects).
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
get(java.lang.Object key)
Returns the value to which this context maps the specified key.
|
|
getBaseURI()
Returns the base URI.
|
|
getDefaultNamespacePrefix()
Returns the default namespace prefix.
|
getKeySelector()
Returns the key selector for finding a key.
|
|
|
getNamespacePrefix(java.lang.String namespaceURI,java.lang.String defaultPrefix)
Returns the namespace prefix that the specified namespace URI is
associated with.
|
|
getProperty(java.lang.String name)
Returns the value of the specified property.
|
getURIDereferencer()
Returns a
URIDereferencer that is used to dereference URIReferences.
|
|
|
put(java.lang.Object key,java.lang.Object value)
Associates the specified value with the specified key in this context.
|
|
putNamespacePrefix(java.lang.String namespaceURI,java.lang.String prefix)
Maps the specified namespace URI to the specified prefix.
|
|
setBaseURI(java.lang.String baseURI)
Sets the base URI.
|
|
setDefaultNamespacePrefix(java.lang.String defaultPrefix)
Sets the default namespace prefix.
|
|
setKeySelector(KeySelector ks)
Sets the key selector for finding a key.
|
|
setProperty(java.lang.String name,java.lang.Object value)
Sets the specified property.
|
|
setURIDereferencer(URIDereferencer dereferencer)
Sets a
URIDereferencer that is used to dereference URIReferences.
|
Method Detail
getBaseURI
- java.lang.String getBaseURI()
setBaseURI
- void setBaseURI(java.lang.String baseURI)
baseURI - the base URI, or null to remove current
value java.lang.IllegalArgumentException - if baseURI is not RFC
2396 compliant getKeySelector
- KeySelector getKeySelector()
setKeySelector
- void setKeySelector(KeySelector ks)
getURIDereferencer
- URIDereferencer getURIDereferencer( )
URIDereferencer that is used to dereference
URIReferences.
URIDereferencer, or null if not
specified setURIDereferencer
- void setURIDereferencer(URIDereferencer dereferencer)
URIDereferencer that is used to dereference
URIReferences. The specified URIDereferencer
is used in place of an implementation's default
URIDereferencer.
dereferencer - the URIDereferencer, or
null to remove any current setting getNamespacePrefix
- java.lang.String getNamespacePrefix( java.lang.String namespaceURI,
- java.lang.String defaultPrefix)
putNamespacePrefix
method.
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. 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
null putNamespacePrefix
- java.lang.String putNamespacePrefix( java.lang.String namespaceURI,
- java.lang.String prefix)
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. null if there was none java.lang.NullPointerException - if namespaceURI is
null getDefaultNamespacePrefix
- java.lang.String getDefaultNamespacePrefix( )
putNamespacePrefix method.
null if none has
been set. setDefaultNamespacePrefix
- void setDefaultNamespacePrefix( java.lang.String defaultPrefix)
putNamespacePrefix method.
defaultPrefix - the default namespace prefix, or null
to remove the current setting. Specify the empty string
("") to bind no prefix. setProperty
- java.lang.Object setProperty(java.lang.String name,
- java.lang.Object value)
name - the name of the property value - the value of the property to be set null if it did not have a value java.lang.NullPointerException - if name is null getProperty
- java.lang.Object getProperty(java.lang.String name)
name - the name of the property null if it does not have a value java.lang.NullPointerException - if name is null get
- java.lang.Object get(java.lang.Object 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.
key - the key whose associated value is to be returned null if there is no mapping for the key put
- java.lang.Object put(java.lang.Object key,
- java.lang.Object value)
This method is useful for storing arbitrary information that is specific to the cryptographic operation that this context is used for.
key - key with which the specified value is to be associated with value - 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 context