Класс TransformService

java.lang.Object

javax.xml.crypto.dsig.TransformService

Все реализуемые интерфейсы:: AlgorithmMethod, Transform, XMLStructure

public abstract class TransformService extends Object implements Transform

Интерфейс поставщика услуг для алгоритмов преобразования и канонизации.

Каждый экземпляр TransformService поддерживает определённый алгоритм преобразования или канонизации и тип механизма XML. Чтобы создать TransformService, вызовите один из статических методов getInstance, передав URI алгоритма и требуемый тип механизма XML, например:

TransformService ts = TransformService.getInstance(Transform.XPATH2, "DOM");

Реализации TransformService регистрируются и загружаются с использованием механизма Provider. Каждая реализация поставщика услуг TransformService должна включать атрибут службы MechanismType, указывающий поддерживаемый тип механизма XML. Если атрибут не указан, предполагается значение "DOM". Например, поставщик услуг, поддерживающий преобразование XPath Filter 2 и механизм DOM, указывается в подклассе Provider следующим образом:

    put("TransformService." + Transform.XPATH2,
        "org.example.XPath2TransformService");
    put("TransformService." + Transform.XPATH2 + " MechanismType", "DOM");

TransformService Реализации, поддерживающие тип механизма DOM, должны соблюдать требования совместимости DOM, определённые в разделе Требования к механизму DOM. Список стандартных URI алгоритмов и типов механизмов см. в разделе TransformService спецификации Стандартные имена алгоритмов безопасности Java.

После создания TransformService его можно использовать для обработки объектов Transform или CanonicalizationMethod. Если Transform или CanonicalizationMethod существует в форме XML (например, при проверке существующего XMLSignature), для инициализации преобразования и предоставления контекста документа необходимо сначала вызвать метод init(XMLStructure, XMLCryptoContext) (даже если параметры отсутствуют). Если же Transform или CanonicalizationMethod создаётся с нуля, для инициализации преобразования параметрами вызывается метод init(TransformParameterSpec), а для маршалинга параметров в XML и предоставления преобразованию контекста документа вызывается метод marshalParams. Наконец, для выполнения преобразования вызывается метод transform.

Параллельный доступ

Гарантируется, что статические методы этого класса являются потокобезопасными. Несколько потоков могут одновременно вызывать статические методы, определённые в этом классе, без каких-либо нежелательных последствий.

Однако это не относится к нестатическим методам, определённым в этом классе. Если в документации конкретного поставщика не указано иное, потоки, которым необходимо одновременно обращаться к одному экземпляру TransformService, должны самостоятельно синхронизировать доступ и обеспечивать необходимую блокировку. Нескольким потокам, каждый из которых работает с отдельным экземпляром TransformService, синхронизация не требуется.

Начиная с версии:

1.6

Внешние спецификации

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

Поля, объявленные в интерфейсе Transform

BASE64, ENVELOPED, XPATH, XPATH2, XSLT

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

TransformService()

Модификатор	Конструктор	Описание
`protected`	Конструктор по умолчанию, предназначенный для вызова подклассами.

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

Модификатор и тип	Метод	Описание
`final String`	`getAlgorithm()`	Возвращает URI алгоритма, поддерживаемого этим `TransformService`.
`static TransformService`	`getInstance(String algorithm, String mechanismType)`	Возвращает `TransformService`, поддерживающий указанный URI алгоритма (например, `Transform.XPATH2`) и тип механизма (например, DOM).
`static TransformService`	`getInstance(String algorithm, String mechanismType, String provider)`	Возвращает `TransformService`, поддерживающий указанный URI алгоритма (например, `Transform.XPATH2`) и тип механизма (например, DOM), предоставляемые указанным поставщиком.
`static TransformService`	`getInstance(String algorithm, String mechanismType, Provider provider)`	Возвращает `TransformService`, поддерживающий указанный URI алгоритма (например, `Transform.XPATH2`) и тип механизма (например, DOM), предоставляемые указанным поставщиком.
`final String`	`getMechanismType()`	Возвращает тип механизма, поддерживаемый этим `TransformService`.
`final Provider`	`getProvider()`	Возвращает поставщика этого `TransformService`.
`abstract void`	`init(TransformParameterSpec params)`	Инициализирует этот `TransformService` указанными параметрами.
`abstract void`	`init(XMLStructure parent, XMLCryptoContext context)`	Инициализирует этот `TransformService` указанными параметрами и контекстом документа.
`abstract void`	`marshalParams(XMLStructure parent, XMLCryptoContext context)`	Выполняет маршалинг параметров, специфичных для алгоритма.

Методы, объявленные в классе Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getParameterSpec, transform, transform

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

isFeatureSupported

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

TransformService

protected TransformService()

Конструктор по умолчанию для вызова подклассами.

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

getInstance

public static TransformService getInstance(String algorithm, String mechanismType) throws NoSuchAlgorithmException

Возвращает TransformService, поддерживающий указанный URI алгоритма (например, Transform.XPATH2) и тип механизма (например, DOM).

Этот метод использует стандартный механизм поиска поставщиков JCA для обнаружения и создания экземпляра реализации TransformService требуемого алгоритма и атрибута службы MechanismType. Метод перебирает список зарегистрированных поставщиков безопасности Provider, начиная с наиболее предпочтительного Provider. Возвращается новый объект TransformService от первого Provider, поддерживающего указанные алгоритм и тип механизма.

Обратите внимание, что список зарегистрированных поставщиков можно получить с помощью метода Security.getProviders().

Примечание по реализации:

Реализация JDK Reference дополнительно использует свойство jdk.security.provider.preferred Security, чтобы определить предпочтительный порядок поставщиков для указанного алгоритма. Он может отличаться от порядка поставщиков, возвращаемых методом Security.getProviders().

Параметры:

algorithm — URI алгоритма. Список стандартных алгоритмов преобразования см. в разделе TransformService спецификации стандартных имён алгоритмов безопасности Java.

mechanismType — тип механизма обработки XML и представления. Список стандартных типов механизмов см. в разделе TransformService спецификации стандартных имён алгоритмов безопасности Java.

Возвращает:

новый TransformService

Исключения:

NullPointerException — если algorithm или mechanismType имеет значение null

NoSuchAlgorithmException — если ни один Provider не поддерживает реализацию TransformService для указанного алгоритма и типа механизма

Внешние спецификации

См. также:

getInstance

public static TransformService getInstance(String algorithm, String mechanismType, Provider provider) throws NoSuchAlgorithmException

Возвращает TransformService, поддерживающий указанный URI алгоритма (например, Transform.XPATH2) и тип механизма (например, DOM), предоставленные указанным поставщиком. Обратите внимание, что указанный объект Provider не обязательно должен быть зарегистрирован в списке поставщиков.

Параметры:

provider — объект Provider

Возвращает:

новый TransformService

Исключения:

NullPointerException — если provider, algorithm или mechanismType имеет значение null

NoSuchAlgorithmException — если реализация TransformService для указанного алгоритма и типа механизма недоступна у указанного объекта Provider

Внешние спецификации

См. также:

getInstance

public static TransformService getInstance(String algorithm, String mechanismType, String provider) throws NoSuchAlgorithmException, NoSuchProviderException

Возвращает TransformService, поддерживающий указанный URI алгоритма (например, Transform.XPATH2) и тип механизма (например, DOM), предоставленные указанным поставщиком. Указанный поставщик должен быть зарегистрирован в списке поставщиков безопасности.

Параметры:

provider — строковое имя поставщика

Возвращает:

новый TransformService

Исключения:

NoSuchProviderException — если указанный поставщик не зарегистрирован в списке поставщиков безопасности

NullPointerException — если provider, mechanismType или algorithm имеет значение null

NoSuchAlgorithmException — если реализация TransformService для указанного алгоритма и типа механизма недоступна у указанного поставщика

Внешние спецификации

См. также:

getMechanismType

public final String getMechanismType()

Возвращает тип механизма, поддерживаемый данным TransformService.

Возвращает:: тип механизма

getAlgorithm

public final String getAlgorithm()

Возвращает URI алгоритма, поддерживаемого данным TransformService.

Определено в:: getAlgorithm в интерфейсе AlgorithmMethod
Возвращает:: URI алгоритма

getProvider

public final Provider getProvider()

Возвращает поставщика данного TransformService.

Возвращает:: поставщик

init

public abstract void init(TransformParameterSpec params) throws InvalidAlgorithmParameterException

Инициализирует данный TransformService указанными параметрами.

Если параметры представлены в формате XML, для инициализации TransformService следует использовать метод init(XMLStructure, XMLCryptoContext).

Параметры:: params — параметры алгоритма (может иметь значение null, если они не требуются или являются необязательными)
Исключения:: InvalidAlgorithmParameterException — если указанные параметры недопустимы для этого алгоритма

marshalParams

public abstract void marshalParams(XMLStructure parent, XMLCryptoContext context) throws MarshalException

Преобразует параметры, относящиеся к алгоритму, в формат XML. Если параметров для преобразования нет, этот метод завершается без выбрасывания исключения.

Параметры:: parent — структура, зависящая от механизма и содержащая родительский узел, к которому следует добавить преобразованные параметры; context — XMLCryptoContext, содержащий дополнительный контекст (может иметь значение null, если неприменимо)
Исключения:: ClassCastException — если тип parent или context несовместим с данным TransformService; NullPointerException — если parent имеет значение null; MarshalException — если параметры невозможно преобразовать в формат XML

init

public abstract void init(XMLStructure parent, XMLCryptoContext context) throws InvalidAlgorithmParameterException

Инициализирует данный TransformService указанными параметрами и контекстом документа.

Параметры:: parent — структура, зависящая от механизма и содержащая родительскую структуру; context — XMLCryptoContext, содержащий дополнительный контекст (может иметь значение null, если неприменимо)
Исключения:: ClassCastException — если тип parent или context несовместим с данным TransformService; NullPointerException — если parent имеет значение null; InvalidAlgorithmParameterException — если указанные параметры недопустимы для этого алгоритма

© 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.xml.crypto/javax/xml/crypto/dsig/TransformService.html