- java.lang.Object
- 
- javax.xml.crypto.KeySelector
 
- 
 public abstract class KeySelector extends Object A selector that finds and returns a key using the data contained in aKeyInfoobject. An example of an implementation of this class is one that searches aKeyStorefor trusted keys that match information contained in aKeyInfo.Whether or not the returned key is trusted and the mechanisms used to determine that is implementation-specific. - Since:
- 1.6
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classKeySelector.PurposeThe purpose of the key that is to be selected.
 - 
Constructor SummaryConstructors Modifier Constructor Description protectedKeySelector()Default no-args constructor; intended for invocation by subclasses only.
 - 
Method SummaryAll Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract KeySelectorResultselect(KeyInfo keyInfo, KeySelector.Purpose purpose, AlgorithmMethod method, XMLCryptoContext context)Attempts to find a key that satisfies the specified constraints.static KeySelectorsingletonKeySelector(Key key)Returns aKeySelectorthat always selects the specified key, regardless of theKeyInfopassed to it.
 
- 
- 
- 
Method Detail- 
selectpublic abstract KeySelectorResult select(KeyInfo keyInfo, KeySelector.Purpose purpose, AlgorithmMethod method, XMLCryptoContext context) throws KeySelectorException Attempts to find a key that satisfies the specified constraints.- Parameters:
- keyInfo- a- KeyInfo(may be- null)
- purpose- the key's purpose (- KeySelector.Purpose.SIGN,- KeySelector.Purpose.VERIFY,- KeySelector.Purpose.ENCRYPT, or- KeySelector.Purpose.DECRYPT)
- 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.
- context- an- XMLCryptoContextthat may contain useful information for finding an appropriate key. If this key selector supports resolving- RetrievalMethodtypes, the context's- baseURIand- dereferencerparameters (if specified) should be used by the selector to resolve and dereference the URI.
- Returns:
- 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 (- nullshould be returned in that case). However, an error condition (ex: network communications failure) that prevented the- KeySelectorfrom finding a potential key should be considered an exception.
- ClassCastException- if the data type of- methodis not supported by this key selector
 
 - 
singletonKeySelectorpublic static KeySelector singletonKeySelector(Key key) Returns aKeySelectorthat always selects the specified key, regardless of theKeyInfopassed to it.- Parameters:
- key- the sole key to be stored in the key selector
- Returns:
- a key selector that always selects the specified key
- Throws:
- NullPointerException- if- keyis- null
 
 
- 
 
-