Интерфейс 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
См. также:: XMLSignatureFactory.newXMLSignature(SignedInfo, KeyInfo), XMLSignatureFactory.newXMLSignature(SignedInfo, KeyInfo, List, String, String)

Вложенные классы

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

Поля

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

Методы

Модификатор и тип	Метод	Описание
`String`	`getId()`	Возвращает необязательный Id этой `XMLSignature`.
`KeyInfo`	`getKeyInfo()`	Возвращает key info этой `XMLSignature`.
`KeySelectorResult`	`getKeySelectorResult()`	Возвращает результат `KeySelector`, если указан, после того, как эта `XMLSignature` была подписана или проверена.
`List<XMLObject>`	`getObjects()`	Возвращает `unmodifiable list` объектов `XMLObject`, содержащихся в этой `XMLSignature`.
`XMLSignature.SignatureValue`	`getSignatureValue()`	Возвращает значение подписи этой `XMLSignature`.
`SignedInfo`	`getSignedInfo()`	Возвращает signed info этой `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()

Возвращает key info этой XMLSignature.

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

getSignedInfo

SignedInfo getSignedInfo()

Возвращает signed info этой XMLSignature.

Возвращает:: signed info (никогда 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 не была подписана или проверена