public abstract class KeySelector extends Object
KeyInfo
object. An example of an implementation of this class is one that searches a 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.
Modifier and Type | Class | Description |
---|---|---|
static class |
KeySelector.Purpose |
The purpose of the key that is to be selected. |
Modifier | Constructor | Description |
---|---|---|
protected |
Default no-args constructor; intended for invocation by subclasses only. |
Modifier and Type | Method | Description |
---|---|---|
abstract KeySelectorResult |
select |
Attempts to find a key that satisfies the specified constraints. |
static KeySelector |
singletonKeySelector |
Returns a KeySelector that always selects the specified key, regardless of the KeyInfo passed to it. |
protected KeySelector()
public abstract KeySelectorResult select(KeyInfo keyInfo, KeySelector.Purpose purpose, AlgorithmMethod method, XMLCryptoContext context) throws KeySelectorException
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 XMLCryptoContext
that may contain useful 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.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 be returned 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.ClassCastException
- if the data type of method
is not supported by this key selectorpublic static KeySelector singletonKeySelector(Key key)
KeySelector
that always selects the specified key, regardless of the KeyInfo
passed to it.key
- the sole key to be stored in the key selectorNullPointerException
- if key
is null
© 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/KeySelector.html