Spec-Zone.ru › OpenJDK 21

Интерфейс Transform

Все суперинтерфейсы:
AlgorithmMethod, XMLStructure
Все известные дочерние интерфейсы:
CanonicalizationMethod
Все известные реализующие классы:
TransformService
public interface Transform extends XMLStructure, AlgorithmMethod
Представление XML Transform элемента, как определено в Рекомендации W3C по синтаксису и обработке XML-подписи. Определение XML-схемы:
 <element name="Transform" type="ds:TransformType"/>
   <complexType name="TransformType" mixed="true">
     <choice minOccurs="0" maxOccurs="unbounded">
       <any namespace="##other" processContents="lax"/>
       <!-- (1,1) elements from (0,unbounded) namespaces -->
       <element name="XPath" type="string"/>
     </choice>
     <attribute name="Algorithm" type="anyURI" use="required"/>
   </complexType>
 
Экземпляр Transform может быть создан вызовом метода newTransform класса XMLSignatureFactory.
С момента:
1.6
См. также:
  • XMLSignatureFactory.newTransform(String, TransformParameterSpec)

Краткое описание полей

Модификатор и тип Поле Описание
static final String BASE64
URI алгоритма преобразования Base64.
static final String ENVELOPED
URI алгоритма преобразования Оборачивающей подписи.
static final String XPATH
URI алгоритма преобразования XPath.
static final String XPATH2
URI алгоритма преобразования XPath Filter 2.
static final String XSLT
URI алгоритма преобразования XSLT.

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

Модификатор и тип Метод Описание
AlgorithmParameterSpec getParameterSpec()
Возвращает параметры входных данных, специфичные для алгоритма, связанные с данным Transform.
Data transform(Data data, XMLCryptoContext context)
Преобразует указанные данные с использованием базового алгоритма преобразования.
Data transform(Data data, XMLCryptoContext context, OutputStream os)
Преобразует указанные данные с использованием базового алгоритма преобразования.

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

getAlgorithm

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

isFeatureSupported

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

BASE64

static final String BASE64
URI алгоритма преобразования Base64.
См. также:
  • Значения константных полей

ENVELOPED

static final String ENVELOPED
URI алгоритма преобразования Оборачивающей подписи.
См. также:
  • Значения константных полей

XPATH

static final String XPATH
URI алгоритма преобразования XPath.
См. также:
  • Значения константных полей

XPATH2

static final String XPATH2
URI алгоритма преобразования XPath Filter 2.
См. также:
  • Значения константных полей

XSLT

static final String XSLT
URI алгоритма преобразования XSLT.
См. также:
  • Значения константных полей

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

getParameterSpec

AlgorithmParameterSpec getParameterSpec()
Возвращает параметры входных данных, специфичные для алгоритма, связанные с этим Transform.

Возвращаемые параметры могут быть приведённы к типу TransformParameterSpec объекта.

Спецификация:
getParameterSpec в интерфейсе AlgorithmMethod
Возвращает:
параметры входных данных, специфичные для алгоритма (может быть null если не указаны)

transform

Data transform(Data data, XMLCryptoContext context) throws TransformException
Преобразует указанные данные с использованием базового алгоритма преобразования.
Параметры:
data - данные, подлежащие преобразованию
context - XMLCryptoContext содержащий дополнительный контекст (может быть null если не применимо)
Возвращает:
преобразованные данные
Исключения:
NullPointerException - если data является null
TransformException - если произошла ошибка во время выполнения преобразования

transform

Data transform(Data data, XMLCryptoContext context, OutputStream os) throws TransformException
Преобразует указанные данные с использованием базового алгоритма преобразования. Если выходной результат этого преобразования является OctetStreamData, то этот метод возвращает null и байты записываются в указанный OutputStream. В противном случае, OutputStream игнорируется и метод ведет себя так, как будто был вызван transform(Data, XMLCryptoContext).
Параметры:
data - данные, подлежащие преобразованию
context - XMLCryptoContext содержащий дополнительный контекст (может быть null если не применимо)
os - OutputStream для записи преобразованных данных
Возвращает:
преобразованные данные (или null если данные были записаны в параметр OutputStream)
Исключения:
NullPointerException - если data или os является null
TransformException - если произошла ошибка во время выполнения преобразования

© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml.crypto/javax/xml/crypto/dsig/Transform.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API