Интерфейс XMLSignature

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.

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

XMLNS

static final String XMLNS

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

См. также:

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

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

validate

boolean validate(XMLValidateContext validateContext)
          throws XMLSignatureException

Параметры:

validateContext - контекст проверки

Возвращает:

true , если подпись прошла проверку, иначе false

Исключения:

ClassCastException - если тип validateContext несовместим с этим XMLSignature

NullPointerException - если validateContext является null

XMLSignatureException - если при проверке произошла непредвиденная ошибка, которая помешала завершить операцию проверки

getKeyInfo

KeyInfo getKeyInfo()

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

Возвращает:

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

getSignedInfo

SignedInfo getSignedInfo()

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

Возвращает:

информацию о подписанных данных (никогда null)

getObjects

List 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

Параметры:

signContext - контекст подписи

Исключения:

ClassCastException - если тип signContext несовместим с этим XMLSignature

NullPointerException - если signContext является null

MarshalException - если произошла ошибка при сериализации

XMLSignatureException - если произошла непредвиденная ошибка при генерации подписи

getKeySelectorResult

KeySelectorResult getKeySelectorResult()

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

Возвращает:

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