- All Known Subinterfaces:
XMLSignContext,XMLValidateContext
- All Known Implementing Classes:
DOMCryptoContext,DOMSignContext,DOMValidateContext
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).
- Since:
- 1.6
-
Method Summary
Modifier and TypeMethodDescriptionReturns the value to which this context maps the specified key.Returns the base URI.Returns the default namespace prefix.Returns the key selector for finding a key.getNamespacePrefix(String namespaceURI, String defaultPrefix) Returns the namespace prefix that the specified namespace URI is associated with.getProperty(String name) Returns the value of the specified property.Returns aURIDereferencerthat is used to dereferenceURIReferences.Associates the specified value with the specified key in this context.putNamespacePrefix(String namespaceURI, String prefix) Maps the specified namespace URI to the specified prefix.voidsetBaseURI(String baseURI) Sets the base URI.voidsetDefaultNamespacePrefix(String defaultPrefix) Sets the default namespace prefix.voidSets the key selector for finding a key.setProperty(String name, Object value) Sets the specified property.voidsetURIDereferencer(URIDereferencer dereferencer) Sets aURIDereferencerthat is used to dereferenceURIReferences.
-
Method Details
-
getBaseURI
String getBaseURI()Returns the base URI.- Returns:
- the base URI, or
nullif not specified - See Also:
-
setBaseURI
Sets the base URI.- Parameters:
baseURI- the base URI, ornullto remove current value- Throws:
IllegalArgumentException- ifbaseURIis not RFC 2396 compliant- See Also:
-
getKeySelector
KeySelector getKeySelector()Returns the key selector for finding a key.- Returns:
- the key selector, or
nullif not specified - See Also:
-
setKeySelector
Sets the key selector for finding a key.- Parameters:
ks- the key selector, ornullto remove the current setting- See Also:
-
getURIDereferencer
URIDereferencer getURIDereferencer()Returns aURIDereferencerthat is used to dereferenceURIReferences.- Returns:
- the
URIDereferencer, ornullif not specified - See Also:
-
setURIDereferencer
Sets aURIDereferencerthat is used to dereferenceURIReferences. The specifiedURIDereferenceris used in place of an implementation's defaultURIDereferencer.- Parameters:
dereferencer- theURIDereferencer, ornullto remove any current setting- See Also:
-
getNamespacePrefix
Returns the namespace prefix that the specified namespace URI is associated with. Returns the specified default prefix if the specified namespace URI has not been bound to a prefix. To bind a namespace URI to a prefix, call theputNamespacePrefixmethod.- Parameters:
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.- Returns:
- the prefix that is associated with the specified namespace URI,
or
defaultPrefixif the URI is not registered. If the namespace URI is registered but has no prefix, an empty string ("") is returned. - Throws:
NullPointerException- ifnamespaceURIisnull- See Also:
-
putNamespacePrefix
Maps the specified namespace URI to the specified prefix. If there is already a prefix associated with the specified namespace URI, the old prefix is replaced by the specified prefix.- Parameters:
namespaceURI- a namespace URIprefix- a namespace prefix (ornullto remove any existing mapping). Specifying the empty string ("") binds no prefix to the namespace URI.- Returns:
- the previous prefix associated with the specified namespace
URI, or
nullif there was none - Throws:
NullPointerException- ifnamespaceURIisnull- See Also:
-
getDefaultNamespacePrefix
String getDefaultNamespacePrefix()Returns the default namespace prefix. The default namespace prefix is the prefix for all namespace URIs not explicitly set by theputNamespacePrefixmethod.- Returns:
- the default namespace prefix, or
nullif none has been set. - See Also:
-
setDefaultNamespacePrefix
Sets the default namespace prefix. This sets the namespace prefix for all namespace URIs not explicitly set by theputNamespacePrefixmethod.- Parameters:
defaultPrefix- the default namespace prefix, ornullto remove the current setting. Specify the empty string ("") to bind no prefix.- See Also:
-
setProperty
Sets the specified property.- Parameters:
name- the name of the propertyvalue- the value of the property to be set- Returns:
- the previous value of the specified property, or
nullif it did not have a value - Throws:
NullPointerException- ifnameisnull- See Also:
-
getProperty
Returns the value of the specified property.- Parameters:
name- the name of the property- Returns:
- the current value of the specified property, or
nullif it does not have a value - Throws:
NullPointerException- ifnameisnull- See Also:
-
get
Returns the value to which this context maps the specified key.More formally, if this context contains a mapping from a key
kto a valuevsuch that(key==null ? k==null : key.equals(k)), then this method returnsv; otherwise it returnsnull. (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.
- Parameters:
key- the key whose associated value is to be returned- Returns:
- the value to which this context maps the specified key, or
nullif there is no mapping for the key - See Also:
-
put
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.
- Parameters:
key- key with which the specified value is to be associated withvalue- value to be associated with the specified key- Returns:
- the previous value associated with the key, or
nullif there was no mapping for the key - Throws:
IllegalArgumentException- if some aspect of this key or value prevents it from being stored in this context- See Also:
-