| |
|
| java.lang.Object javax.xml.crypto.KeySelector
KeySelector | abstract public class KeySelector (Code) | | A selector that finds and returns a key using the data contained in a
KeyInfo object. An example of an implementation of
this class is one that searchs a
java.security.KeyStore for
trusted keys that match information contained in a KeyInfo .
Whether or not the returned key is trusted and the mechanisms
used to determine that is implementation-specific.
author: Sean Mullan author: JSR 105 Expert Group since: 1.6 |
Inner Class :public static class Purpose | |
Constructor Summary | |
protected | KeySelector() Default no-args constructor; intended for invocation by subclasses only. |
Method Summary | |
abstract public KeySelectorResult | select(KeyInfo keyInfo, Purpose purpose, AlgorithmMethod method, XMLCryptoContext context) Attempts to find a key that satisfies the specified constraints.
Parameters: keyInfo - a KeyInfo (may be null ) Parameters: purpose - the key's purpose (Purpose.SIGN, Purpose.VERIFY, Purpose.ENCRYPT, or Purpose.DECRYPT) Parameters: method - the algorithm method that this key is to be used for.Only keys that are compatible with the algorithm and meet the constraints of the specified algorithm should be returned. Parameters: context - an XMLCryptoContext that may containuseful information for finding an appropriate key. | public static KeySelector | singletonKeySelector(Key key) Returns a KeySelector that always selects the specified
key, regardless of the KeyInfo passed to it. |
KeySelector | protected KeySelector()(Code) | | Default no-args constructor; intended for invocation by subclasses only.
|
select | abstract public KeySelectorResult select(KeyInfo keyInfo, Purpose purpose, AlgorithmMethod method, XMLCryptoContext context) throws KeySelectorException(Code) | | Attempts to find a key that satisfies the specified constraints.
Parameters: keyInfo - a KeyInfo (may be null ) Parameters: purpose - the key's purpose (Purpose.SIGN, Purpose.VERIFY, Purpose.ENCRYPT, or Purpose.DECRYPT) Parameters: method - the algorithm method that this key is to be used for.Only keys that are compatible with the algorithm and meet the constraints of the specified algorithm should be returned. Parameters: context - an XMLCryptoContext that may containuseful information for finding an appropriate key. If this key selector supports resolving RetrievalMethod types, the context's baseURI and dereferencer parameters (if specified) should be used by the selector to resolve and dereference the URI. the result of the key selector throws: KeySelectorException - if an exceptional condition occurs while attempting to find a key. Note that an inability to find a key is not considered an exception (null should bereturned in that case). However, an error condition (ex: network communications failure) that prevented the KeySelector from finding a potential key should be considered an exception. throws: ClassCastException - if the data type of method is not supported by this key selector |
singletonKeySelector | public static KeySelector singletonKeySelector(Key key)(Code) | | Returns a KeySelector that always selects the specified
key, regardless of the KeyInfo passed to it.
Parameters: key - the sole key to be stored in the key selector a key selector that always selects the specified key throws: NullPointerException - if key is null |
|
|
|