public interface XMLCryptoContext
Contains common context information for XML cryptographic operations.
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).
String getBaseURI()
Returns the base URI.
null if not specifiedsetBaseURI(String)void setBaseURI(String baseURI)
Sets the base URI.
baseURI - the base URI, or null to remove current valueIllegalArgumentException - if baseURI is not RFC 2396 compliantgetBaseURI()KeySelector getKeySelector()
Returns the key selector for finding a key.
null if not specifiedsetKeySelector(KeySelector)void setKeySelector(KeySelector ks)
Sets the key selector for finding a key.
ks - the key selector, or null to remove the current settinggetKeySelector()URIDereferencer getURIDereferencer()
Returns a URIDereferencer that is used to dereference URIReferences.
URIDereferencer, or null if not specifiedsetURIDereferencer(URIDereferencer)void setURIDereferencer(URIDereferencer dereferencer)
Sets a 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 settinggetURIDereferencer()String getNamespacePrefix(String namespaceURI,
String defaultPrefix) 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 the 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)String putNamespacePrefix(String namespaceURI,
String prefix) 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.
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
getNamespacePrefix(String, String)String getDefaultNamespacePrefix()
Returns the default namespace prefix. The default namespace prefix is the prefix for all namespace URIs not explicitly set by the putNamespacePrefix method.
null if none has been set.setDefaultNamespacePrefix(String)void setDefaultNamespacePrefix(String defaultPrefix)
Sets the default namespace prefix. This sets the namespace prefix for all namespace URIs not explicitly set by the putNamespacePrefix method.
defaultPrefix - the default namespace prefix, or null to remove the current setting. Specify the empty string ("") to bind no prefix.getDefaultNamespacePrefix()Object setProperty(String name,
Object value) Sets the specified property.
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
getProperty(String)Object getProperty(String name)
Returns the value of the specified property.
name - the name of the propertynull if it does not have a valueNullPointerException - if name is null
setProperty(String, Object)Object get(Object key)
Returns the value to which this context maps the specified 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 keyput(Object, Object)Object put(Object key,
Object value) 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.
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 contextget(Object)
© 1993–2017, 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.