Справочник по интерфейсам

Все суперинтерфейсы:: 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

См. также:

Краткое описание методов

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

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

getType, getURI

Модификатор и тип	Метод	Описание
`String`	`getType()`	Возвращает тип данных, на которые ссылается этот URI.
`String`	`getURI()`	Возвращает URI объекта данных, на который ведёт ссылка.

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

isFeatureSupported

Модификатор и тип	Метод	Описание
`boolean`	`isFeatureSupported(String feature)`	Указывает, поддерживается ли заданная функция.

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

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

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

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

getDigestInputStream

InputStream getDigestInputStream()

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

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

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.