Интерфейс KeyInfo
- Все суперинтерфейсы:
XMLStructure
public interface KeyInfo extends XMLStructure
KeyInfo элемента, как определено в Рекомендации W3C по синтаксису и обработке XML-подписей. A KeyInfo содержит список XMLStructure, каждый из которых содержит информацию, необходимую получателю(лям) для получения ключа, необходимого для проверки XML-подписи. Определение XML-схемы:
<element name="KeyInfo" type="ds:KeyInfoType"/>
<complexType name="KeyInfoType" mixed="true">
<choice maxOccurs="unbounded">
<element ref="ds:KeyName"/>
<element ref="ds:KeyValue"/>
<element ref="ds:RetrievalMethod"/>
<element ref="ds:X509Data"/>
<element ref="ds:PGPData"/>
<element ref="ds:SPKIData"/>
<element ref="ds:MgmtData"/>
<any processContents="lax" namespace="##other"/>
<!-- (1,1) elements from (0,unbounded) namespaces -->
</choice>
<attribute name="Id" type="ID" use="optional"/>
</complexType>
Экземпляр KeyInfo может быть создан путём вызова одного из newKeyInfo методов класса KeyInfoFactory и передачи ему списка одного или нескольких XMLStructure и необязательного параметра id; например:
KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM");
KeyInfo keyInfo = factory.newKeyInfo
(Collections.singletonList(factory.newKeyName("Alice"), "keyinfo-1"));
Объекты KeyInfo также могут быть сериализованы в XML, вызвав метод marshal.
- С момента:
- 1.6
- См. также:
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
List<XMLStructure> |
getContent() |
Возвращает unmodifiable
list, содержащий информацию о ключе. |
String |
getId() |
Возвращает необязательный атрибут Id этого KeyInfo, который может быть полезен для ссылки на этот KeyInfo из других XML-структур. |
void |
marshal |
Сериализует информацию о ключе в XML. |
Методы, объявленные в интерфейсе javax.xml.crypto.XMLStructure
isFeatureSupported
Подробное описание методов
getContent
List<XMLStructure> getContent()
unmodifiable
list, содержащий информацию о ключе. Каждый элемент списка является XMLStructure. Если существует общедоступный подкласс, представляющий тип XMLStructure, он возвращается как экземпляр этого класса (например, элемент X509Data возвращается как экземпляр X509Data).
- Возвращает:
- неизменяемый список одного или нескольких
XMLStructureв этомKeyInfo. Никогда не возвращаетnullили пустой список.
getId
String getId()
KeyInfo, который может быть полезен для ссылки на этот KeyInfo из других XML-структур.- Возвращает:
- атрибут Id этого
KeyInfo(может бытьnullесли не указан)
marshal
void marshal(XMLStructure parent, XMLCryptoContext context) throws MarshalException
- Параметры:
-
parent- структура, специфичная для механизма, содержащая родительский узел, к которому будет добавлен сериализованный ключ -
context-XMLCryptoContextсодержащий дополнительный контекст (может быть null, если не применимо) - Исключения:
-
ClassCastException- если типparentилиcontextне совместим с этим ключом -
MarshalException- если ключ не может быть сериализован -
NullPointerException- еслиparentявляетсяnull
© 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/dsig/keyinfo/KeyInfo.html