Интерфейс 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, 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/XMLCryptoContext.html