Интерфейс 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

void setBaseURI(String baseURI)

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

Параметры:

baseURI - базовый URI или null для удаления текущего значения

Исключения:

IllegalArgumentException - если baseURI не соответствует RFC 2396

См. также:

getKeySelector

KeySelector getKeySelector()

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

Возвращает:

селектор ключа или null если не указан

См. также:

setKeySelector

void setKeySelector(KeySelector ks)

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

Параметры:

ks - селектор ключа или null для удаления текущей настройки

См. также:

getURIDereferencer

URIDereferencer getURIDereferencer()

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

Возвращает:

разыменователь URIDereferencer, или null если не указан

См. также:

setURIDereferencer

void setURIDereferencer(URIDereferencer dereferencer)

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

Параметры:

dereferencer - разыменователь URIDereferencer, или null для удаления текущей настройки

См. также:

getNamespacePrefix

String getNamespacePrefix(String namespaceURI, String defaultPrefix)

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

Параметры:

namespaceURI - URI пространства имен

defaultPrefix - префикс, который должен быть возвращен в случае, если указанному URI пространства имен не присвоен префикс.

Возвращает:

префикс, связанный с указанным URI пространства имен, или defaultPrefix если URI не зарегистрирован. Если URI пространства имен зарегистрирован, но не имеет префикса, возвращается пустая строка ("").

Исключения:

NullPointerException - если namespaceURI является null

См. также:

putNamespacePrefix

String putNamespacePrefix(String namespaceURI, String prefix)

Привязывает указанный URI пространства имен к указанному префиксу. Если указанному URI пространства имен уже назначен префикс, старый префикс заменяется указанным.

Параметры:

namespaceURI - URI пространства имен

prefix - префикс пространства имен (или null для удаления существующей привязки). Указание пустой строки (""). привязывает к URI пространства имен без префикса.

Возвращает:

предыдущий префикс, связанный с указанным URI пространства имен, или null если его не было

Исключения:

NullPointerException - если namespaceURI является null

См. также:

getDefaultNamespacePrefix

String getDefaultNamespacePrefix()

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

Возвращает:

префикс пространства имен по умолчанию или null если он не задан.

См. также:

setDefaultNamespacePrefix

void setDefaultNamespacePrefix(String defaultPrefix)

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

Параметры:

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

См. также:

setProperty

Object setProperty(String name, Object value)

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

Параметры:

name - имя свойства

value - значение свойства, которое необходимо установить

Возвращает:

предыдущее значение указанного свойства или null если оно не имело значения

Исключения:

NullPointerException - если name является null

См. также:

getProperty

Object getProperty(String name)

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

Параметры:

name - имя свойства

Возвращает:

текущее значение указанного свойства или null если оно не имеет значения

Исключения:

NullPointerException - если name является null

См. также:

get

Object get(Object key)

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

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

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

Параметры:

key - ключ, связанное значение которого должно быть возвращено

Возвращает:

значение, которому этот контекст сопоставляет указанный ключ, или null если для ключа нет отображения

См. также:

put

Object put(Object key, Object value)

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

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

Параметры:

key - ключ, сопоставленный с указанным значением

value - значение, которое должно быть связано с указанным ключом

Возвращает:

предыдущее значение, связанное с ключом, или null если для ключа не было отображения

Исключения:

IllegalArgumentException - если какой-либо аспект этого ключа или значения препятствует его хранению в этом контексте

См. также:

© 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/XMLCryptoContext.html