Интерфейс XMLSignature

Все суперинтерфейсы:: XMLStructure

public interface XMLSignature extends XMLStructure

Представление элемента XML Signature, определённого в Рекомендации W3C по синтаксису и обработке XML-подписей. Этот класс содержит методы для подписи и проверки XML-подписей с поведением, определённым спецификацией W3C. Определение XML-схемы:


 <element name="Signature" type="ds:SignatureType"/>
 <complexType name="SignatureType">
    <sequence>
      <element ref="ds:SignedInfo"/>
      <element ref="ds:SignatureValue"/>
      <element ref="ds:KeyInfo" minOccurs="0"/>
      <element ref="ds:Object" minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
    <attribute name="Id" type="ID" use="optional"/>
 </complexType>

Экземпляр XMLSignature можно создать, вызвав один из методов newXMLSignature класса XMLSignatureFactory.

Если содержимое базового документа, содержащего XMLSignature, будет впоследствии изменено, поведение неопределённо.

Обратите внимание, что этот класс назван XMLSignature вместо Signature для предотвращения конфликтов имён с существующим классом java.security.Signature.

С:

1.6

См. также:

Краткое описание вложенных классов

Модификатор и тип	Интерфейс	Описание
`static interface`	`XMLSignature.SignatureValue`	Представление элемента XML `SignatureValue`, определённого в Рекомендации W3C по синтаксису и обработке XML-подписей.

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final String`	`XMLNS`	URI пространства имён XML для Рекомендации W3C по синтаксису и обработке XML-подписей.

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

Модификатор и тип	Метод	Описание
`String`	`getId()`	Возвращает необязательный Id этого `XMLSignature`.
`KeyInfo`	`getKeyInfo()`	Возвращает информацию о ключе этого `XMLSignature`.
`KeySelectorResult`	`getKeySelectorResult()`	Возвращает результат `KeySelector`, если указано, после того, как этот `XMLSignature` был подписан или проверен.
`List<XMLObject>`	`getObjects()`	Возвращает список (неизменяемый) `unmodifiable list` объектов `XMLObject`, содержащихся в этом `XMLSignature`.
`XMLSignature.SignatureValue`	`getSignatureValue()`	Возвращает значение подписи этого `XMLSignature`.
`SignedInfo`	`getSignedInfo()`	Возвращает информацию о подписанном объекте этого `XMLSignature`.
`void`	`sign(XMLSignContext signContext)`	Подписывает этот `XMLSignature`.
`boolean`	`validate(XMLValidateContext validateContext)`	Проверяет подпись в соответствии с правилами проверки основных подписей.

Методы, объявленные в интерфейсе javax.xml.crypto.XMLStructure

isFeatureSupported

Подробное описание полей

XMLNS

static final String XMLNS

URI пространства имён XML для Рекомендации W3C по синтаксису и обработке XML-подписей.

См. также:

Значения константных полей

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

validate

boolean validate(XMLValidateContext validateContext) throws XMLSignatureException

Проверяет подпись в соответствии с правилами проверки основных подписей. Этот метод проверяет подпись, используя существующее состояние, он не распаковывает и не перезапускает содержимое XMLSignature с помощью информации о местоположении, указанной в контексте.

Этот метод проверяет подпись только один раз при первом вызове. При последующих вызовах он возвращает кэшированный результат.

Параметры:: validateContext - контекст проверки
Возвращает:: true если подпись прошла основную проверку, в противном случае false
Исключения:: ClassCastException - если тип validateContext несовместим с этим XMLSignature; NullPointerException - если validateContext является null; XMLSignatureException - если при проверке произошла непредвиденная ошибка, которая помешала завершить операцию проверки

getKeyInfo

KeyInfo getKeyInfo()

Возвращает информацию о ключе этого XMLSignature.

Возвращает:: информацию о ключе (может быть null если она не указана)

getSignedInfo

SignedInfo getSignedInfo()

Возвращает информацию о подписанном объекте этого XMLSignature.

Возвращает:: информацию о подписанном объекте (никогда null)

getObjects

List<XMLObject> getObjects()

Возвращает список (неизменяемый)

unmodifiable
 list

объектов XMLObject, содержащихся в этом XMLSignature.

Возвращает:: неизменяемый список XMLObject (может быть пустым, но никогда null)

getId

String getId()

Возвращает необязательный Id этого XMLSignature.

Возвращает:: Id (может быть null если он не указан)

getSignatureValue

XMLSignature.SignatureValue getSignatureValue()

Возвращает значение подписи этого XMLSignature.

Возвращает:: значение подписи

sign

void sign(XMLSignContext signContext) throws MarshalException, XMLSignatureException

Подписывает этот XMLSignature.

Если этот метод выбросит исключение, этот XMLSignature и параметр signContext останутся в том состоянии, в котором они находились до вызова.

Параметры:: signContext - контекст подписи
Исключения:: ClassCastException - если тип signContext несовместим с этим XMLSignature; NullPointerException - если signContext является null; MarshalException - если произошла ошибка при маршаллировании; XMLSignatureException - если произошла непредвиденная ошибка при генерации подписи

getKeySelectorResult

KeySelectorResult getKeySelectorResult()

Возвращает результат KeySelector, если указан, после того, как этот XMLSignature был подписан или проверен.

Возвращает:: результат выбора ключа, или null если селектор ключа не был указан или этот XMLSignature не был подписан или проверен

© 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/XMLSignature.html