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.XMLStructure から継承されるメソッド

isFeatureSupported

インタフェース javax.xml.crypto.AlgorithmMethod から継承されるメソッド

getAlgorithm

フィールドの詳細

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 - 変換の実行中にエラーが発生した場合