Класс DOMCryptoContext

java.lang.Object

javax.xml.crypto.dom.DOMCryptoContext

Все реализованные интерфейсы:: XMLCryptoContext

Непосредственные известные подклассы:: DOMSignContext, DOMValidateContext

public class DOMCryptoContext extends Object implements XMLCryptoContext

Этот класс предоставляет DOM-специфическую реализацию интерфейса XMLCryptoContext. Он также включает дополнительные методы, специфичные для реализации на основе DOM, для регистрации и получения элементов, содержащих атрибуты типа ID.

С:: 1.6

Краткое описание конструкторов

DOMCryptoContext()

Модификатор	Конструктор	Описание
`protected`	Конструктор по умолчанию.

Краткое описание методов

Модификатор и тип	Метод	Описание
`Object`	`get(Object key)`	Данная реализация использует внутренний `HashMap` для получения объекта, которому соответствует указанный ключ.
`String`	`getBaseURI()`	Возвращает базовый URI.
`String`	`getDefaultNamespacePrefix()`	Возвращает префикс по умолчанию для пространства имён.
`Element`	`getElementById(String idValue)`	Возвращает `Element` с указанным значением атрибута ID.
`KeySelector`	`getKeySelector()`	Возвращает селектор ключа для поиска ключа.
`String`	`getNamespacePrefix(String namespaceURI, String defaultPrefix)`	Данная реализация использует внутренний `HashMap` для получения префикса, которому соответствует указанный URI.
`Object`	`getProperty(String name)`	Данная реализация использует внутренний `HashMap` для получения объекта, которому соответствует указанное имя.
`URIDereferencer`	`getURIDereferencer()`	Возвращает `URIDereferencer`, используемый для обратной ссылки на `URIReference`.
`Iterator<Map.Entry<String,Element>>`	`iterator()`	Возвращает итератор только для чтения по набору сопоставлений Id/Элемент данного `DOMCryptoContext`.
`Object`	`put(Object key, Object value)`	Данная реализация использует внутренний `HashMap` для сопоставления ключа с указанным объектом.
`String`	`putNamespacePrefix(String namespaceURI, String prefix)`	Данная реализация использует внутренний `HashMap` для сопоставления URI с указанным префиксом.
`void`	`setBaseURI(String baseURI)`	Устанавливает базовый URI.
`void`	`setDefaultNamespacePrefix(String defaultPrefix)`	Устанавливает префикс по умолчанию для пространства имён.
`void`	`setIdAttributeNS(Element element, String namespaceURI, String localName)`	Регистрирует атрибут элемента, заданный URI пространства имён и локальным именем, как атрибут типа ID.
`void`	`setKeySelector(KeySelector ks)`	Устанавливает селектор ключа для поиска ключа.
`Object`	`setProperty(String name, Object value)`	Данная реализация использует внутренний `HashMap` для сопоставления имени с указанным объектом.
`void`	`setURIDereferencer(URIDereferencer dereferencer)`	Устанавливает `URIDereferencer`, используемый для обратной ссылки на `URIReference`.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание конструкторов

DOMCryptoContext

protected DOMCryptoContext()

Конструктор по умолчанию. (Для вызова подклассами конструкторов).

Подробное описание методов

getNamespacePrefix

public String getNamespacePrefix(String namespaceURI, String defaultPrefix)

В этом реализации используется внутренний HashMap, чтобы получить префикс, к которому относится указанный URI. Возвращает defaultPrefix, если он отображается на null.

Определено в:

getNamespacePrefix в интерфейсе XMLCryptoContext

Параметры:

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

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

Возвращает:

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

Изучает:

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

См. также:

XMLCryptoContext.putNamespacePrefix(String, String)

putNamespacePrefix

public String putNamespacePrefix(String namespaceURI, String prefix)

В этой реализации используется внутренний HashMap для сопоставления URI со специфицированным префиксом.

Определено в:

putNamespacePrefix в интерфейсе XMLCryptoContext

Параметры:

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

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

Возвращает:

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

Изучает:

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

См. также:

XMLCryptoContext.getNamespacePrefix(String, String)

getDefaultNamespacePrefix

public String getDefaultNamespacePrefix()

Описание скопировано из интерфейса: XMLCryptoContext

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

Определено в:

getDefaultNamespacePrefix в интерфейсе XMLCryptoContext

Возвращает:

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

См. также:

XMLCryptoContext.setDefaultNamespacePrefix(String)

setDefaultNamespacePrefix

public void setDefaultNamespacePrefix(String defaultPrefix)

Описание скопировано из интерфейса: XMLCryptoContext

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

Определено в:

setDefaultNamespacePrefix в интерфейсе XMLCryptoContext

Параметры:

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

См. также:

XMLCryptoContext.getDefaultNamespacePrefix()

getBaseURI

public String getBaseURI()

Описание скопировано из интерфейса: XMLCryptoContext

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

Определено в:

getBaseURI в интерфейсе XMLCryptoContext

Возвращает:

базовый URI или null, если не указан.

См. также:

XMLCryptoContext.setBaseURI(String)

setBaseURI

public void setBaseURI(String baseURI)

Описание скопировано из интерфейса: XMLCryptoContext

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

Определено в:

setBaseURI в интерфейсе XMLCryptoContext

Параметры:

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

Изучает:

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

См. также:

XMLCryptoContext.getBaseURI()

getURIDereferencer

public URIDereferencer getURIDereferencer()

Описание скопировано из интерфейса: XMLCryptoContext

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

Определено в:

getURIDereferencer в интерфейсе XMLCryptoContext

Возвращает:

URIDereferencer, или null, если не указано.

См. также:

XMLCryptoContext.setURIDereferencer(URIDereferencer)

setURIDereferencer

public void setURIDereferencer(URIDereferencer dereferencer)

Описание скопировано из интерфейса: XMLCryptoContext

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

Определено в:

setURIDereferencer в интерфейсе XMLCryptoContext

Параметры:

dereferencer - URIDereferencer, или null, чтобы удалить текущее значение.

См. также:

XMLCryptoContext.getURIDereferencer()

getProperty

public Object getProperty(String name)

В этой реализации используется внутренний HashMap для получения объекта, которому соответствует указанное имя.

Определено в:

getProperty в интерфейсе XMLCryptoContext

Параметры:

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

Возвращает:

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

Изучает:

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

См. также:

XMLCryptoContext.setProperty(String, Object)

setProperty

public Object setProperty(String name, Object value)

В этой реализации используется внутренний HashMap для сопоставления имени со специфицированным объектом.

Определено в:

setProperty в интерфейсе XMLCryptoContext

Параметры:

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

value - значение свойства, которое нужно установить

Возвращает:

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

Изучает:

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

См. также:

XMLCryptoContext.getProperty(String)

getKeySelector

public KeySelector getKeySelector()

Описание скопировано из интерфейса: XMLCryptoContext

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

Определено в:

getKeySelector в интерфейсе XMLCryptoContext

Возвращает:

селектор ключей, или null, если не задан.

См. также:

XMLCryptoContext.setKeySelector(KeySelector)

setKeySelector

public void setKeySelector(KeySelector ks)

Описание скопировано из интерфейса: XMLCryptoContext

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

Определено в:

setKeySelector в интерфейсе XMLCryptoContext

Параметры:

ks - селектор ключей, или null, чтобы удалить текущее значение.

См. также:

XMLCryptoContext.getKeySelector()

getElementById

public Element getElementById(String idValue)

Возвращает элемент с заданным атрибутом ID.

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

Parameters:

idValue - значение атрибута ID

Returns:

элемент с заданным атрибутом ID или null , если такого элемента нет.

Throws:

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

See Also:

setIdAttributeNS(org.w3c.dom.Element, java.lang.String, java.lang.String)

setIdAttributeNS

public void setIdAttributeNS(Element element, String namespaceURI, String localName)

Регистрирует атрибут элемента, заданный URI пространства имён и локальным именем, как атрибут типа ID. Атрибут должен иметь непустое значение.

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

Parameters:

element - элемент

namespaceURI - URI пространства имён атрибута (укажите null , если не применимо)

localName - локальное имя атрибута

Throws:

IllegalArgumentException - если localName не является атрибутом указанного элемента или не содержит конкретного значения

NullPointerException - если element или localName имеют значение null

See Also:

getElementById(java.lang.String)

iterator

public Iterator<Map.Entry<String,Element>> iterator()

Возвращает только для чтения итератор по набору сопоставлений Id/Элемент для этого DOMCryptoContext. Попытки модифицировать набор с помощью метода Iterator.remove() вызовут исключение UnsupportedOperationException. Сопоставления возвращаются в произвольном порядке. Каждый элемент итерации представлен как Map.Entry. Если DOMCryptoContext изменяется во время выполнения итерации, результаты итерации не определены.

Returns:: только для чтения итератор по набору сопоставлений

get

public Object get(Object key)

Эта реализация использует внутренний HashMap для получения объекта, которому соответствует указанный ключ.

Specified by:

get в интерфейсе XMLCryptoContext

Parameters:

key - ключ, связанное значение которого необходимо вернуть

Returns:

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

See Also:

XMLCryptoContext.put(Object, Object)

put

public Object put(Object key, Object value)

Эта реализация использует внутренний HashMap для сопоставления ключа с указанным объектом.

Specified by:

put в интерфейсе XMLCryptoContext

Parameters:

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

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

Returns:

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

Throws:

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

See Also:

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