Интерфейс 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)`	Проверяет подпись в соответствии с основными правилами проверки.

Методы, объявленные в интерфейсе 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, 2025, 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/25/docs/api/java.xml.crypto/javax/xml/crypto/dsig/XMLSignature.html