javax.xml.crypto.dsig.keyinfo

インタフェース RetrievalMethod

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

URIReference, XMLStructure

public interface RetrievalMethod
extends URIReference, XMLStructure

「W3C Recommendation for XML-Signature Syntax and Processing」で定義されている XML RetrievalMethod 要素の表現。RetrievalMethod オブジェクトは、別の場所に格納されている KeyInfo 情報への参照を送信するために使用されます。XML スキーマ定義は、次のように定義されます。

   <element name="RetrievalMethod" type="ds:RetrievalMethodType"/>
   <complexType name="RetrievalMethodType">
     <sequence>
       <element name="Transforms" type="ds:TransformsType" minOccurs="0"/>
     </sequence>
     <attribute name="URI" type="anyURI"/>
     <attribute name="Type" type="anyURI" use="optional"/>
   </complexType>
 

RetrievalMethod インスタンスは、KeyInfoFactory クラスの newRetrievalMethod メソッドの 1 つを呼び出し、KeyInfo の位置を識別する URI、KeyInfo の型を識別するオプションの型 URI、および Transform のオプションのリストを渡すことによって作成されます。次に例を示します。

   KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM");
   RetrievalMethod rm = factory.newRetrievalMethod
      ("#KeyValue-1", KeyValue.DSA_TYPE, Collections.singletonList(Transform.BASE64));
 

導入されたバージョン:

1.6

関連項目:

KeyInfoFactory.newRetrievalMethod(String), KeyInfoFactory.newRetrievalMethod(String, String, List)

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
Data	dereference(XMLCryptoContext context) この RetrievalMethod によって参照される KeyInfo 情報を間接参照し、指定した Transform を適用します。
List	getTransforms() この RetrievalMethod の Transform の unmodifiable list を返します。
String	getURI() 参照された KeyInfo 情報の URI を返します。

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

getType

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

isFeatureSupported

メソッドの詳細

getTransforms

List getTransforms()

この RetrievalMethod の Transform の unmodifiable list を返します。

戻り値:

Transform オブジェクトの変更不可能なリスト。空の場合もあるが null になることはない。

getURI

String getURI()

参照された KeyInfo 情報の URI を返します。

定義:

getURI、インタフェース: URIReference

戻り値:

RFC 2396 形式の、参照された KeyInfo 情報の URI。null になることはない

dereference

Data dereference(XMLCryptoContext context)
                 throws URIReferenceException

この RetrievalMethod によって参照される KeyInfo 情報を間接参照し、指定した Transform を適用します。

パラメータ:

context - URI の間接参照に役立つ追加情報が含まれている場合のある XMLCryptoContext。コンテキストの baseURI および dereferencer パラメータ (指定されている場合) は、この RetrievalMethod の解決と間接参照に使用される

戻り値:

この RetrievalMethod によって参照される KeyInfo 情報の raw コンテンツを表す Data オブジェクト。呼び出し側で、返されたデータを適切な KeyInfo オブジェクトに変換する必要がある。

例外:

NullPointerException - context が null である場合

URIReferenceException - 間接参照の間にエラーが発生した場合