Reference (Java Platform SE 6)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM Platform
Standard Ed. 6

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

javax.xml.crypto.dsig
インタフェース Reference

すべてのスーパーインタフェース:: URIReference, XMLStructure

public interface Reference
extends URIReference, XMLStructure
extends URIReference, XMLStructure

「W3C Recommendation for XML-Signature Syntax and Processing」で定義されている XML Reference 要素の表現。XML スキーマは、次のように定義されます。

 <element name="Reference" type="ds:ReferenceType"/>
 <complexType name="ReferenceType">
   <sequence>
     <element ref="ds:Transforms" minOccurs="0"/>
     <element ref="ds:DigestMethod"/>
     <element ref="ds:DigestValue"/>
   </sequence>
   <attribute name="Id" type="ID" use="optional"/>
   <attribute name="URI" type="anyURI" use="optional"/>
   <attribute name="Type" type="anyURI" use="optional"/>
 </complexType>

 <element name="DigestValue" type="ds:DigestValueType"/>
 <simpleType name="DigestValueType">
   <restriction base="base64Binary"/>
 </simpleType>

Reference インスタンスは、XMLSignatureFactory クラスの newReference メソッドの 1 つを呼び出すことで作成されます。次に例を示します。

   XMLSignatureFactory factory = XMLSignatureFactory.getInstance("DOM");
   Reference ref = factory.newReference
     ("http://www.ietf.org/rfc/rfc3275.txt", 
        factory.newDigestMethod(DigestMethod.SHA1, null));

導入されたバージョン:: 1.6
関連項目:: XMLSignatureFactory.newReference(String, DigestMethod), XMLSignatureFactory.newReference(String, DigestMethod, List, String, String)

メソッドの概要
`byte[]`	`getCalculatedDigestValue()` 検証操作のあとで、この `Reference` の計算されたダイジェスト値を返します。
`Data`	`getDereferencedData()` 参照キャッシュが有効な場合、間接参照されたデータを返します。
`InputStream`	`getDigestInputStream()` 参照キャッシュが有効な場合、事前ダイジェストされた入力ストリームを返します。
`DigestMethod`	`getDigestMethod()` この `Reference` のダイジェストメソッドを返します。
`byte[]`	`getDigestValue()` この `Reference` のダイジェスト値を返します。
`String`	`getId()` この `Reference` の省略可能な `Id` 属性を返し、ほかの場所からこの参照が参照されることを許可します。
`List`	`getTransforms()` この `Reference` に格納されている `Transform` の`変更不可能なリスト`を返します。
`boolean`	`validate(XMLValidateContext validateContext)` この参照を検証します。

インタフェース javax.xml.crypto.URIReference から継承されたメソッド
`getType, getURI`

インタフェース javax.xml.crypto.XMLStructure から継承されたメソッド
`isFeatureSupported`

メソッドの詳細

getTransforms

List getTransforms()

この Reference に格納されている Transform の変更不可能なリストを返します。

戻り値:: Transform の変更不可能なリスト。空の場合もあるが null になることはない

getDigestMethod

DigestMethod getDigestMethod()

この Reference のダイジェストメソッドを返します。

戻り値:: ダイジェストメソッド

getId

String getId()

この Reference の省略可能な Id 属性を返し、ほかの場所からこの参照が参照されることを許可します。

戻り値:: Id 属性。指定されていない場合は null になることもある

getDigestValue

byte[] getDigestValue()

この Reference のダイジェスト値を返します。

戻り値:: raw ダイジェスト値。この参照がまだダイジェストされていない場合は null。このメソッドの各呼び出しでは、以後の変更から保護するために新しいクローンが返される

getCalculatedDigestValue

byte[] getCalculatedDigestValue()

検証操作のあとで、この Reference の計算されたダイジェスト値を返します。このメソッドは、参照が検証に失敗した場合のデバッグに便利です。

戻り値:: 計算されたダイジェスト値。この参照がまだ検証されていない場合は nullこのメソッドの各呼び出しでは、以後の変更から保護するために新しいクローンが返される

validate

boolean validate(XMLValidateContext validateContext)
                 throws XMLSignatureException

この参照を検証します。このメソッドは、この参照のダイジェストを検証します。

このメソッドは参照が最初に呼び出されたときのみ検証します。次回以降の呼び出しでは、キャッシュされた結果を返します。

パラメータ:: validateContext - 検証するコンテキスト
戻り値:: この参照が正常に検証された場合は true。そうでない場合は false
例外:: NullPointerException - validateContext が null の場合; XMLSignatureException - 参照の検証中に予想外の例外が発生した場合