Ссылка на интерфейс

Все суперинтерфейсы:: URIReference, XMLStructure

public interface Reference
extends URIReference, XMLStructure

Представление элемента Reference согласно Рекомендации W3C по синтаксису и обработке XML-подписей. Схема XML определена как:

<element name="Reference" type="ds:ReferenceType"/>
 <complexType name="ReferenceType">
   <sequence>
     <element ref="ds:Transforms" minOccurs="0"/>
     <element ref="ds:DigestMethod"/>
     <element ref="ds:DigestValue"/>
   </sequence>
   <attribute name="Id" type="ID" use="optional"/>
   <attribute name="URI" type="anyURI" use="optional"/>
   <attribute name="Type" type="anyURI" use="optional"/>
 </complexType>

 <element name="DigestValue" type="ds:DigestValueType"/>
 <simpleType name="DigestValueType">
   <restriction base="base64Binary"/>
 </simpleType>

Экземпляр Reference может быть создан, вызвав один из методов newReference класса XMLSignatureFactory; например:

XMLSignatureFactory factory = XMLSignatureFactory.getInstance("DOM");
   Reference ref = factory.newReference
     ("http://www.ietf.org/rfc/rfc3275.txt",
      factory.newDigestMethod(DigestMethod.SHA1, null));

С момента:: 1.6
См. также:: XMLSignatureFactory.newReference(String, DigestMethod), XMLSignatureFactory.newReference(String, DigestMethod, List, String, String)

Методы

Модификатор и тип	Метод	Описание
`byte[]`	`getCalculatedDigestValue()`	Возвращает вычисленное значение дайджеста данного `Reference` после операции валидации.
`Data`	`getDereferencedData()`	Возвращает разыменованные данные, если включен кэширование ссылок reference caching.
`InputStream`	`getDigestInputStream()`	Возвращает предварительно дайджестированный входной поток, если включен кэширование ссылок reference caching.
`DigestMethod`	`getDigestMethod()`	Возвращает метод дайджеста данного `Reference`.
`byte[]`	`getDigestValue()`	Возвращает значение дайджеста данного `Reference`.
`String`	`getId()`	Возвращает необязательный атрибут `Id` данного `Reference`, который позволяет ссылаться на эту ссылку из других мест.
`List<Transform>`	`getTransforms()`	Возвращает список `unmodifiable list` `Transform`, содержащихся в этом `Reference`.
`boolean`	`validate(XMLValidateContext validateContext)`	Проверяет ссылку.

Методы, объявленные в интерфейсе javax.xml.crypto.URIReference

getType, getURI

Методы, объявленные в интерфейсе javax.xml.crypto.XMLStructure

isFeatureSupported

Методы

getTransforms

List<Transform> getTransforms()

Возвращает список unmodifiable list Transform, содержащихся в этом Reference.

Возвращает:: неизменяемый список Transform (может быть пустым, но никогда null)

getDigestMethod

DigestMethod getDigestMethod()

Возвращает метод дайджеста данного Reference.

Возвращает:: метод дайджеста

getId

String getId()

Возвращает необязательный атрибут Id данного Reference, который позволяет ссылаться на эту ссылку из других мест.

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

getDigestValue

byte[] getDigestValue()

Возвращает значение дайджеста данного Reference.

Возвращает:: сырое значение дайджеста, или null если дайджест еще не был вычислен. Каждый вызов этого метода возвращает новую копию для защиты от последующих изменений.

getCalculatedDigestValue

byte[] getCalculatedDigestValue()

Возвращает вычисленное значение дайджеста данного Reference после операции валидации. Этот метод полезен для отладки, если ссылка не проходит валидацию.

Возвращает:: вычисленное значение дайджеста, или null если эта ссылка еще не была проверена. Каждый вызов этого метода возвращает новую копию для защиты от последующих изменений.

validate

boolean validate(XMLValidateContext validateContext)
          throws XMLSignatureException

Проверяет эту ссылку. Этот метод проверяет дайджест этой ссылки.

Этот метод проверяет ссылку только в первый раз, когда он вызывается. При последующих вызовах он возвращает кэшированный результат.

Параметры:: validateContext - контекст валидации
Возвращает:: true если эта ссылка была успешно проверена; false в противном случае
Исключения:: NullPointerException - если validateContext является null; XMLSignatureException - если во время проверки ссылки произошло непредвиденное исключение

getDereferencedData

Data getDereferencedData()

Возвращает разыменованные данные, если включено кэширование ссылок reference caching. Это результат разыменования URI этой ссылки во время операции валидации или генерации.

Возвращает:: разыменованные данные, или null если кэширование ссылок не включено или эта ссылка не была сгенерирована или проверена

getDigestInputStream

InputStream getDigestInputStream()

Возвращает предварительно дайджестированный входной поток, если включено кэширование ссылок reference caching. Это входной поток для операции дайджеста во время операции валидации или подписи.

Возвращает:: поток ввода с предварительно дайджестированным вводом, или null если кэширование ссылок не включено или эта ссылка не была сгенерирована или проверена