Интерфейс XMLCryptoContext

Все известные подинтерфейсы:: XMLSignContext, XMLValidateContext

Все известные реализующие классы:: DOMCryptoContext, DOMSignContext, DOMValidateContext

public interface XMLCryptoContext

Содержит общую информацию о контексте для операций с XML-криптографией.

Этот интерфейс содержит методы для установки и извлечения свойств, влияющих на обработку XML-подписей или XML-зашифрованных структур.

Обратите внимание, что экземпляры XMLCryptoContext могут содержать информацию и состояние, специфичные для XML-криптографической структуры, с которой они используются. Результаты будут непредсказуемыми, если экземпляр XMLCryptoContext используется с несколькими структурами (например, вы не должны использовать один и тот же экземпляр XMLValidateContext для проверки двух разных объектов XMLSignature).

С:: 1.6

Методы

Модификатор и тип	Метод	Описание
`Object`	`get(Object key)`	Возвращает значение, которому этот контекст сопоставляет указанный ключ.
`String`	`getBaseURI()`	Возвращает базовый URI.
`String`	`getDefaultNamespacePrefix()`	Возвращает префикс имени пространства имён по умолчанию.
`KeySelector`	`getKeySelector()`	Возвращает селектор ключа для поиска ключа.
`String`	`getNamespacePrefix(String namespaceURI, String defaultPrefix)`	Возвращает префикс имени пространства имён, связанный с указанным URI пространства имён.
`Object`	`getProperty(String name)`	Возвращает значение указанного свойства.
`URIDereferencer`	`getURIDereferencer()`	Возвращает `URIDereferencer`, который используется для разыменования `URIReference`.
`Object`	`put(Object key, Object value)`	Связывает указанное значение с указанным ключом в этом контексте.
`String`	`putNamespacePrefix(String namespaceURI, String prefix)`	Сопоставляет указанный URI пространства имён с указанным префиксом.
`void`	`setBaseURI(String baseURI)`	Устанавливает базовый URI.
`void`	`setDefaultNamespacePrefix(String defaultPrefix)`	Устанавливает префикс имени пространства имён по умолчанию.
`void`	`setKeySelector(KeySelector ks)`	Устанавливает селектор ключа для поиска ключа.
`Object`	`setProperty(String name, Object value)`	Устанавливает указанное свойство.
`void`	`setURIDereferencer(URIDereferencer dereferencer)`	Устанавливает `URIDereferencer`, который используется для разыменования `URIReference`.

Методы

getBaseURI

String getBaseURI()

Возвращает базовый URI.

Возвращает:: базовый URI или null если не указан
См. также:: setBaseURI(String)

setBaseURI

void setBaseURI(String baseURI)

Устанавливает базовый URI.

Параметры:: baseURI - базовый URI или null для удаления текущего значения
Исключение:: IllegalArgumentException - если baseURI не соответствует RFC 2396
См. также:: getBaseURI()

getKeySelector

KeySelector getKeySelector()

Возвращает селектор ключа для поиска ключа.

Возвращает:: селектор ключа или null если не указан
См. также:: setKeySelector(KeySelector)

setKeySelector

void setKeySelector(KeySelector ks)

Устанавливает селектор ключа для поиска ключа.

Параметры:: ks - селектор ключа или null для удаления текущего значения
См. также:: getKeySelector()

getURIDereferencer

URIDereferencer getURIDereferencer()

Возвращает URIDereferencer, который используется для разыменования URIReference.

Возвращает:: URIDereferencer, или null если не указан
См. также:: setURIDereferencer(URIDereferencer)

setURIDereferencer

void setURIDereferencer(URIDereferencer dereferencer)

Устанавливает URIDereferencer, который используется для разыменования URIReference. Указанный URIDereferencer используется вместо значения по умолчанию URIDereferencer реализации.

Параметры:: dereferencer - URIDereferencer, или null для удаления текущего значения
См. также:: getURIDereferencer()

getNamespacePrefix

String getNamespacePrefix(String namespaceURI,
                          String defaultPrefix)

Возвращает префикс пространства имён, связанный с указанным URI пространства имён. Возвращает указанный префикс по умолчанию, если указанный URI пространства имён не связан с префиксом. Для связывания URI пространства имён с префиксом, вызовите метод putNamespacePrefix.

Параметры:: namespaceURI - URI пространства имён; defaultPrefix - префикс, который будет возвращён в случае, если указанный URI пространства имён не связан с префиксом.
Возвращает:: префикс, связанный с указанным URI пространства имён, или defaultPrefix если URI не зарегистрирован. Если URI пространства имён зарегистрирован, но не имеет префикса, возвращается пустая строка ("").
Исключение:: NullPointerException - если namespaceURI null
См. также:: putNamespacePrefix(String, String)

putNamespacePrefix

String putNamespacePrefix(String namespaceURI,
                          String prefix)

Сопоставляет указанный URI пространства имён с указанным префиксом. Если для указанного URI пространства имён уже существует префикс, старый префикс заменяется указанным.

Параметры:: namespaceURI - URI пространства имён; prefix - префикс пространства имён (или null для удаления существующего соответствия). Указание пустой строки ("") не связывает префикс с URI пространства имён.
Возвращает:: предыдущий префикс, связанный с указанным URI пространства имён, или null если его не было
Исключение:: NullPointerException - если namespaceURI null
См. также:: getNamespacePrefix(String, String)

getDefaultNamespacePrefix

String getDefaultNamespacePrefix()

Возвращает префикс пространства имён по умолчанию. Префикс пространства имён по умолчанию — это префикс для всех URI пространства имён, не явно установленных методом putNamespacePrefix.

Возвращает:: префикс пространства имён по умолчанию или null если не установлен.
См. также:: setDefaultNamespacePrefix(String)

setDefaultNamespacePrefix

void setDefaultNamespacePrefix(String defaultPrefix)

Устанавливает префикс пространства имён по умолчанию. Это устанавливает префикс пространства имён для всех URI пространства имён, не явно установленных методом putNamespacePrefix.

Параметры:: defaultPrefix - префикс пространства имён по умолчанию, или null для удаления текущего значения. Укажите пустую строку ("") чтобы не назначить префикс.
См. также:: getDefaultNamespacePrefix()

setProperty

Object setProperty(String name,
                   Object value)

Устанавливает указанное свойство.

Параметры:: name - имя свойства; value - значение свойства для установки
Возвращает:: предыдущее значение указанного свойства, или null если оно не имело значения
Исключение:: NullPointerException - если name null
См. также:: getProperty(String)

getProperty

Object getProperty(String name)

Возвращает значение указанного свойства.

Параметры:: name - имя свойства
Возвращает:: текущее значение указанного свойства или null если оно не имеет значения
Исключение:: NullPointerException - если name null
См. также:: setProperty(String, Object)

get

Object get(Object key)

Возвращает значение, которому этот контекст сопоставляет указанный ключ.

Более формально, если этот контекст содержит отображение от ключа k к значению v, такое, что (key==null ? k==null : key.equals(k)), то этот метод возвращает v; в противном случае он возвращает null. (Может быть не более одного такого отображения.)

Этот метод полезен для получения произвольной информации, специфичной для криптографической операции, для которой используется этот контекст.

Параметры:: key - ключ, связанное значение которого нужно вернуть
Возвращает:: значение, которому этот контекст сопоставляет указанный ключ, или null если для ключа нет отображения
См. также:: put(Object, Object)

put

Object put(Object key,
           Object value)

Связывает указанное значение с указанным ключом в этом контексте. Если контекст ранее содержал отображение для этого ключа, старое значение заменяется указанным.

Этот метод полезен для хранения произвольной информации, специфичной для криптографической операции, для которой используется этот контекст.

Параметры:: key - ключ, с которым нужно связать указанное значение; value - значение, которое нужно связать с указанным ключом
Возвращает:: предыдущее значение, связанное с ключом, или null если для ключа не было отображения
Исключение:: IllegalArgumentException - если какой-либо аспект этого ключа или значения препятствует его хранению в этом контексте
См. также:: get(Object)

© 1993, 2020, 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/11/docs/api/java.xml.crypto/javax/xml/crypto/XMLCryptoContext.html