XMLSignContext
, XMLValidateContext
DOMCryptoContext
, DOMSignContext
, DOMValidateContext
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).
Modifier and Type | Method | Description |
---|---|---|
Object |
get |
Returns the value to which this context maps the specified key. |
String |
getBaseURI() |
Returns the base URI. |
String |
getDefaultNamespacePrefix() |
Returns the default namespace prefix. |
KeySelector |
getKeySelector() |
Returns the key selector for finding a key. |
String |
getNamespacePrefix |
Returns the namespace prefix that the specified namespace URI is associated with. |
Object |
getProperty |
Returns the value of the specified property. |
URIDereferencer |
getURIDereferencer() |
Returns a URIDereferencer that is used to dereference URIReference s. |
Object |
put |
Associates the specified value with the specified key in this context. |
String |
putNamespacePrefix |
Maps the specified namespace URI to the specified prefix. |
void |
setBaseURI |
Sets the base URI. |
void |
setDefaultNamespacePrefix |
Sets the default namespace prefix. |
void |
setKeySelector |
Sets the key selector for finding a key. |
Object |
setProperty |
Sets the specified property. |
void |
setURIDereferencer |
Sets a URIDereferencer that is used to dereference URIReference s. |
String getBaseURI()
null
if not specifiedvoid setBaseURI(String baseURI)
baseURI
- the base URI, or null
to remove current valueIllegalArgumentException
- if baseURI
is not RFC 2396 compliantKeySelector getKeySelector()
null
if not specifiedvoid setKeySelector(KeySelector ks)
ks
- the key selector, or null
to remove the current settingURIDereferencer getURIDereferencer()
URIDereferencer
that is used to dereference URIReference
s.URIDereferencer
, or null
if not specifiedvoid setURIDereferencer(URIDereferencer dereferencer)
URIDereferencer
that is used to dereference URIReference
s. The specified URIDereferencer
is used in place of an implementation's default URIDereferencer
.dereferencer
- the URIDereferencer
, or null
to remove any current settingString 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
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 noneNullPointerException
- if namespaceURI
is null
String getDefaultNamespacePrefix()
putNamespacePrefix
method.null
if none has been set.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.Object setProperty(String name, Object value)
name
- the name of the propertyvalue
- the value of the property to be setnull
if it did not have a valueNullPointerException
- if name
is null
Object getProperty(String name)
name
- the name of the propertynull
if it does not have a valueNullPointerException
- if name
is null
Object get(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 returnednull
if there is no mapping for the keyObject put(Object key, 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 withvalue
- value to be associated with the specified keynull
if there was no mapping for the keyIllegalArgumentException
- if some aspect of this key or value prevents it from being stored in this context
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml.crypto/javax/xml/crypto/XMLCryptoContext.html