Интерфейс 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()`	Возвращает необязательный идентификатор этого `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

Модификатор и тип	Метод	Описание
`boolean`	`isFeatureSupported(String feature)`	Указывает, поддерживается ли указанная функция.

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

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()

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

Возвращает:: идентификатор (может иметь значение 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.