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

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

Методы

getTransforms

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

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

Возвращает:

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

getDigestInputStream

InputStream getDigestInputStream()

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

Возвращает:

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