javax.xml.crypto.dsig

Интерфейсный 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 XML URI Пространства имен Рекомендации W3C для Синтаксиса XML-подписи и Обработки.

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
Строка	getId() Возвращает дополнительный Идентификатор этого XMLSignature.
KeyInfo	getKeyInfo() Возвращает ключевую информацию этого XMLSignature.
KeySelectorResult	getKeySelectorResult() Возвращает результат KeySelector, если определено, после этого XMLSignature был подписан или проверен.
Список	getObjects() Возвраты unmodifiable list из XMLObjects содержавшийся в этом 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

XML URI Пространства имен Рекомендации W3C для Синтаксиса XML-подписи и Обработки.

См. Также:

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

Деталь метода

проверить

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

Возвраты unmodifiable list из XMLObjects содержавшийся в этом XMLSignature.

Возвраты:

неподдающийся изменению список XMLObjects (может быть пустым, но никогда null)

getId

String getId()

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

Возвраты:

Идентификатор (может быть null если не определенный)

getSignatureValue

XMLSignature.SignatureValue getSignatureValue()

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

Возвраты:

значение подписи

знак

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 не был подписан или проверен