Класс 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 Security Standard Algorithm Names.

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

Доступ из нескольких потоков

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

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

С:: 1.6

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

Поля, объявленные в интерфейсе javax.xml.crypto.dsig.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)`	Маршаллит параметры, специфичные для алгоритма.

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

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

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

getParameterSpec, transform, transform

Методы, объявленные в интерфейсе javax.xml.crypto.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 дополнительно использует свойство jdk.security.provider.preferred Security для определения предпочтительного порядка поставщиков для указанного алгоритма. Это может отличаться от порядка поставщиков, возвращаемого методом Security.getProviders().

Параметры:

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

mechanismType - тип механизма и представления обработки XML. См. раздел TransformService в Спецификации Java Security Standard Algorithm Names для списка стандартных типов механизмов.

Возвращает:

новый 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, следует использовать метод init(XMLStructure, XMLCryptoContext) для инициализации TransformService.

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

marshalParams

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

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

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

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, 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/TransformService.html