Интерфейс 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://docs.oracle.com/en/java/javase/25/docs/api/java.xml.crypto/javax/xml/crypto/XMLCryptoContext.html