モジュール java.xml.crypto

パッケージ javax.xml.crypto.dsig

インタフェースTransform

すべてのスーパー・インタフェース:

AlgorithmMethod, XMLStructure

既知のすべてのサブインタフェース:

CanonicalizationMethod

既知のすべての実装クラス:

TransformService

public interface Transform
extends XMLStructure, AlgorithmMethod

「W3C Recommendation for XML-Signature Syntax and Processing」で定義されているXML Transform要素の表現。 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インスタンスは、XMLSignatureFactoryクラスのnewTransformメソッドを呼び出すことで作成できます。

導入されたバージョン:

1.6

関連項目:

XMLSignatureFactory.newTransform(String, TransformParameterSpec)

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
static String	BASE64	Base64変換アルゴリズムURI。
static String	ENVELOPED	Enveloped Signature変換アルゴリズムURI。
static String	XPATH	XPath変換アルゴリズムURI。
static String	XPATH2	XPath Filter 2変換アルゴリズムURI。
static String	XSLT	XSLT変換アルゴリズムURI。

メソッドのサマリー

修飾子と型	メソッド	説明
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

Base64変換アルゴリズムURI。

関連項目:

定数フィールド値

ENVELOPED

static final String ENVELOPED

Enveloped Signature変換アルゴリズムURI。

関連項目:

定数フィールド値

XPATH

static final String XPATH

XPath変換アルゴリズムURI。

関連項目:

定数フィールド値

XPATH2

static final String XPATH2

XPath Filter 2変換アルゴリズムURI。

関連項目:

定数フィールド値

XSLT

static final String XSLT

XSLT変換アルゴリズムURI。

関連項目:

定数フィールド値

メソッドの詳細

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

戻り値:

変換されたデータ。データがOutputStreamパラメータに書き込まれた場合はnull

例外:

NullPointerException - dataまたはosがnullの場合

TransformException - 変換の実行中にエラーが発生した場合