Интерфейс 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() Возвращает |
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) Устанавливает |
Методы
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, 2020, 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.