Интерфейс 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 используется вместо реализации по умолчанию 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, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.xml.crypto/javax/xml/crypto/XMLCryptoContext.html