Класс TransformService

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 обзора API. Список стандартных типов механизмов см. в разделе Поставщики сервисов обзора API.

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

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

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

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

Конструкторы

TransformService

protected TransformService()

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

Методы

getInstance

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

Параметры:

algorithm - URI алгоритма

mechanismType - тип механизма и представления обработки XML

Возвращает:

новый TransformService

Исключения:

NullPointerException - если algorithm или mechanismType null

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

См. также:

Provider

getInstance

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

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

Параметры:

algorithm - URI алгоритма

mechanismType - тип механизма и представления обработки XML

provider - объект Provider

Возвращает:

новый TransformService

Исключения:

NullPointerException - если provider, algorithm, или mechanismType null

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

См. также:

Provider

getInstance

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

Параметры:

algorithm - URI алгоритма

mechanismType - тип механизма и представления обработки XML

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

Возвращает:

новый TransformService

Исключения:

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

NullPointerException - если provider, mechanismType, или algorithm null

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

См. также:

Provider

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

Параметры:

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 - если указанные параметры недействительны для этого алгоритма