Класс KeySelector
java.lang.Object
javax.xml.crypto.KeySelector
public abstract class KeySelector extends Object
Селектор, который находит и возвращает ключ, используя данные, содержащиеся в объекте
KeyInfo. Примером реализации этого класса является поиск в KeyStore доверенных ключей, соответствующих информации, содержащейся в KeyInfo. Доверенность возвращаемого ключа и механизмы определения доверенности зависят от реализации.
- Since:
- 1.6
Краткое описание вложенных классов
| Модификатор и тип | Класс | Описание |
|---|---|---|
static class |
KeySelector.Purpose |
Цель ключа, который необходимо выбрать. |
Краткое описание конструкторов
| Модификатор | Конструктор | Описание |
|---|---|---|
protected |
Конструктор по умолчанию без аргументов; предназначен только для вызова подклассами. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
abstract KeySelectorResult |
select |
Попытка найти ключ, удовлетворяющий указанным ограничениям. |
static KeySelector |
singletonKeySelector |
Возвращает KeySelector, который всегда выбирает указанный ключ, независимо от KeyInfo, переданного ему. |
Подробное описание конструкторов
KeySelector
protected KeySelector()
Конструктор по умолчанию без аргументов; предназначен только для вызова подклассами.
Подробное описание методов
select
public abstract KeySelectorResult select(KeyInfo keyInfo, KeySelector.Purpose purpose, AlgorithmMethod method, XMLCryptoContext context) throws KeySelectorException
Попытка найти ключ, удовлетворяющий указанным ограничениям.
- Параметры:
-
keyInfo-KeyInfo(может бытьnull) -
purpose- цель ключа (KeySelector.Purpose.SIGN,KeySelector.Purpose.VERIFY,KeySelector.Purpose.ENCRYPTилиKeySelector.Purpose.DECRYPT) -
method- метод алгоритма, для которого будет использоваться этот ключ. Должны возвращаться только ключи, совместимые с алгоритмом и удовлетворяющие ограничениям указанного алгоритма. -
context-XMLCryptoContext, который может содержать полезную информацию для поиска подходящего ключа. Если этот селектор ключей поддерживает разрешение типовRetrievalMethod, параметрыbaseURIиdereferencerконтекста (если указаны) должны использоваться селектором для разрешения и дериференции URI. - Возвращает:
- результат селектора ключей
- Исключения:
-
KeySelectorException- если при попытке найти ключ возникает исключительное состояние. Отсутствие ключа не считается исключением (в этом случае должен быть возвращёнnull). Однако, ошибка (например, сбой сетевого соединения), которая помешалаKeySelectorнайти потенциальный ключ, должна рассматриваться как исключение. -
ClassCastException- если тип данныхmethodне поддерживается этим селектором ключей
singletonKeySelector
public static KeySelector singletonKeySelector(Key key)
Возвращает
KeySelector, который всегда выбирает указанный ключ, независимо от KeyInfo, переданного ему.- Параметры:
-
key- единственный ключ, который нужно сохранить в селекторе ключей - Возвращает:
- селектор ключей, который всегда выбирает указанный ключ
- Исключения:
-
NullPointerException- еслиkeyявляетсяnull
© 1993, 2021, 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/17/docs/api/java.xml.crypto/javax/xml/crypto/KeySelector.html