Класс 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
Краткое описание конструкторов
| Модификатор | Конструктор | Описание |
|---|---|---|
protected |
Конструктор по умолчанию. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
Object |
get |
Данная реализация использует внутренний HashMap для получения объекта, которому соответствует указанный ключ. |
String |
getBaseURI() |
Возвращает базовый URI. |
String |
getDefaultNamespacePrefix() |
Возвращает префикс по умолчанию для пространства имён. |
Element |
getElementById |
Возвращает Element с указанным значением атрибута ID. |
KeySelector |
getKeySelector() |
Возвращает селектор ключа для поиска ключа. |
String |
getNamespacePrefix |
Данная реализация использует внутренний HashMap для получения префикса, которому соответствует указанный URI. |
Object |
getProperty |
Данная реализация использует внутренний HashMap для получения объекта, которому соответствует указанное имя. |
URIDereferencer |
getURIDereferencer() |
Возвращает URIDereferencer, используемый для обратной ссылки на URIReference. |
Iterator |
iterator() |
Возвращает итератор только для чтения по набору сопоставлений Id/Элемент данного DOMCryptoContext. |
Object |
put |
Данная реализация использует внутренний HashMap для сопоставления ключа с указанным объектом. |
String |
putNamespacePrefix |
Данная реализация использует внутренний HashMap для сопоставления URI с указанным префиксом. |
void |
setBaseURI |
Устанавливает базовый URI. |
void |
setDefaultNamespacePrefix |
Устанавливает префикс по умолчанию для пространства имён. |
void |
setIdAttributeNS |
Регистрирует атрибут элемента, заданный URI пространства имён и локальным именем, как атрибут типа ID. |
void |
setKeySelector |
Устанавливает селектор ключа для поиска ключа. |
Object |
setProperty |
Данная реализация использует внутренний HashMap для сопоставления имени с указанным объектом. |
void |
setURIDereferencer |
Устанавливает URIDereferencer, используемый для обратной ссылки на URIReference. |
Краткое описание конструкторов
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 - См. также:
putNamespacePrefix
public String putNamespacePrefix(String namespaceURI, String prefix)
Эта реализация использует внутренний
HashMap для сопоставления URI с указанным префиксом.- Указано в:
-
putNamespacePrefixв интерфейсеXMLCryptoContext - Параметры:
-
namespaceURI- URI пространства имен -
prefix- префикс пространства имен (илиnullдля удаления существующего сопоставления). Указание пустой строки ("") не связывает префикс с URI пространства имен. - Возвращает:
- предыдущий префикс, связанный с указанным URI пространства имен, или
null, если такового не было - Исключения:
-
NullPointerException- еслиnamespaceURIявляетсяnull - См. также:
getDefaultNamespacePrefix
public String getDefaultNamespacePrefix()
Описание скопировано из интерфейса:
XMLCryptoContextВозвращает префикс пространства имен по умолчанию. Префикс пространства имен по умолчанию — это префикс для всех URI пространства имен, явно не установленных методом
putNamespacePrefix.- Указано в:
-
getDefaultNamespacePrefixв интерфейсеXMLCryptoContext - Возвращает:
- префикс пространства имен по умолчанию или
null, если он не был установлен. - См. также:
setDefaultNamespacePrefix
public void setDefaultNamespacePrefix(String defaultPrefix)
Описание скопировано из интерфейса:
XMLCryptoContextУстанавливает префикс пространства имен по умолчанию. Это устанавливает префикс пространства имен для всех URI пространства имен, явно не установленных методом
putNamespacePrefix.- Указано в:
-
setDefaultNamespacePrefixв интерфейсеXMLCryptoContext - Параметры:
-
defaultPrefix- префикс пространства имен по умолчанию илиnullдля удаления текущего значения. Укажите пустую строку ("") для того, чтобы не привязывать префикс. - См. также:
getBaseURI
public String getBaseURI()
Описание скопировано из интерфейса:
XMLCryptoContextВозвращает базовый URI.
- Указано в:
-
getBaseURIв интерфейсеXMLCryptoContext - Возвращает:
- базовый URI или
null, если он не указан - См. также:
setBaseURI
public void setBaseURI(String baseURI)
Описание скопировано из интерфейса:
XMLCryptoContextУстанавливает базовый URI.
- Указано в:
-
setBaseURIв интерфейсеXMLCryptoContext - Параметры:
-
baseURI- базовый URI илиnullдля удаления текущего значения - Исключения:
-
IllegalArgumentException- еслиbaseURIне соответствует RFC 2396 - См. также:
getURIDereferencer
public URIDereferencer getURIDereferencer()
Описание скопировано из интерфейса:
XMLCryptoContextВозвращает
URIDereferencer, который используется для разрешения ссылок URIReference.- Указано в:
-
getURIDereferencerв интерфейсеXMLCryptoContext - Возвращает:
URIDereferencer, илиnull, если он не указан- См. также:
setURIDereferencer
public void setURIDereferencer(URIDereferencer dereferencer)
Описание скопировано из интерфейса:
XMLCryptoContextУстанавливает
URIDereferencer, который используется для разрешения ссылок URIReference. Указанный URIDereferencer используется вместо URIDereferencer по умолчанию.- Указано в:
-
setURIDereferencerв интерфейсеXMLCryptoContext - Параметры:
-
dereferencer-URIDereferencer, илиnullдля удаления текущего значения - См. также:
getProperty
public Object getProperty(String name)
Эта реализация использует внутренний
HashMap для получения объекта, к которому сопоставлено указанное имя.- Указано в:
-
getPropertyв интерфейсеXMLCryptoContext - Параметры:
-
name- имя свойства - Возвращает:
- текущее значение указанного свойства или
null, если у него нет значения - Исключения:
-
NullPointerException- еслиnameявляетсяnull - См. также:
setProperty
public Object setProperty(String name, Object value)
Эта реализация использует внутренний
HashMap для сопоставления имени с указанным объектом.- Указано в:
-
setPropertyв интерфейсеXMLCryptoContext - Параметры:
-
name- имя свойства -
value- значение устанавливаемого свойства - Возвращает:
- предыдущее значение указанного свойства или
null, если у него не было значения - Исключения:
-
NullPointerException- еслиnameявляетсяnull - См. также:
getKeySelector
public KeySelector getKeySelector()
Описание скопировано из интерфейса:
XMLCryptoContextВозвращает селектор ключей для поиска ключа.
- Указано в:
-
getKeySelectorв интерфейсеXMLCryptoContext - Возвращает:
- селектор ключей или
null, если он не указан - См. также:
setKeySelector
public void setKeySelector(KeySelector ks)
Описание скопировано из интерфейса:
XMLCryptoContextУстанавливает селектор ключей для поиска ключа.
- Указано в:
-
setKeySelectorв интерфейсеXMLCryptoContext - Параметры:
-
ks- селектор ключей илиnullдля удаления текущего значения - См. также:
getElementById
public Element getElementById(String idValue)
Возвращает элемент с указанным атрибутом ID.
Эта реализация использует внутреннюю HashMap для получения элемента, которому соответствует указанное значение атрибута.
- Parameters:
-
idValue- значение атрибута ID - Returns:
- элемент с указанным атрибутом ID, или
nullесли такого элемента нет. - Throws:
-
NullPointerException- еслиidValueявляетсяnull - See Also:
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:
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:
put
public Object put(Object key, Object value)
Эта реализация использует внутреннюю
HashMap для сопоставления ключа со значением.- Specified by:
-
putв интерфейсеXMLCryptoContext - Parameters:
-
key- ключ, которому должно быть сопоставлено заданное значение -
value- значение, которое нужно сопоставить с указанным ключом - Returns:
- предыдущее значение, связанное с ключом, или
nullесли для ключа не было сопоставления - Throws:
-
IllegalArgumentException- если какой-либо аспект этого ключа или значения препятствует его хранению в этом контексте - See Also:
© 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/dom/DOMCryptoContext.html