モジュール java.xml.crypto

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

インタフェースKeyInfo

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

XMLStructure

public interface KeyInfo
extends XMLStructure

「W3C Recommendation for XML-Signature Syntax and Processing」で定義されているXML KeyInfo要素の表現。 KeyInfoには、XMLStructureのリストが含まれています。それぞれのXMLStructureには、XML署名を検証するために必要なキーを受信者が取得できるようにする情報が格納されています。 XMLスキーマ定義は、次のように定義されます。

 <element name="KeyInfo" type="ds:KeyInfoType"/>
 <complexType name="KeyInfoType" mixed="true">
   <choice maxOccurs="unbounded">
     <element ref="ds:KeyName"/>
     <element ref="ds:KeyValue"/>
     <element ref="ds:RetrievalMethod"/>
     <element ref="ds:X509Data"/>
     <element ref="ds:PGPData"/>
     <element ref="ds:SPKIData"/>
     <element ref="ds:MgmtData"/>
     <any processContents="lax" namespace="##other"/>
     <!-- (1,1) elements from (0,unbounded) namespaces -->
   </choice>
   <attribute name="Id" type="ID" use="optional"/>
 </complexType>
 

KeyInfoインスタンスは、KeyInfoFactoryクラスのnewKeyInfoメソッドの1つを呼び出し、それに1つ以上のXMLStructureのリストおよびオプションのidパラメータを渡すことによって作成されます。たとえば:

   KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM");
   KeyInfo keyInfo = factory.newKeyInfo
      (Collections.singletonList(factory.newKeyName("Alice"), "keyinfo-1"));
 

KeyInfoオブジェクトは、marshalメソッドを呼び出すことによってもXMLに整列化できます。

導入されたバージョン:

1.6

関連項目:

KeyInfoFactory.newKeyInfo(List), KeyInfoFactory.newKeyInfo(List, String)

メソッドのサマリー

修飾子と型	メソッド	説明
List<XMLStructure>	getContent()	キー情報を格納するunmodifiable listを返します。
String	getId()	このKeyInfoのオプションのid属性を返します。KeyInfoをほかのXML構造から参照する場合に有用です。
void	marshal(XMLStructure parent, XMLCryptoContext context)	キー情報をXMLに整列化します。

インタフェース javax.xml.crypto.XMLStructureで宣言されたメソッド

isFeatureSupported

メソッドの詳細

getContent

List<XMLStructure> getContent()

キー情報を格納するunmodifiable listを返します。 リストのそれぞれのエントリはXMLStructureです。

XMLStructureの型を表現するpublicサブクラスがある場合、そのクラスのインスタンスとして返されます。たとえば、X509Data要素はX509Dataのインスタンスとして返されます。

戻り値:

このKeyInfo内の1つ以上のXMLStructureの変更不可能なリスト。 nullまたは空のリストが返されることはない。

getId

String getId()

このKeyInfoのオプションのid属性を返します。KeyInfoをほかのXML構造から参照する場合に有用です。

戻り値:

このKeyInfoのid属性。指定されていない場合はnullになることもある

marshal

void marshal(XMLStructure parent,
             XMLCryptoContext context)
      throws MarshalException

キー情報をXMLに整列化します。

パラメータ:

parent - 整列化されたキー情報が追加される親ノードを格納する、メカニズム固有の構造

context - 追加のコンテキストを格納するXMLCryptoContext。該当しない場合はnullも可

例外:

ClassCastException - parentまたはcontextの型がこのキー情報と互換性がない場合

MarshalException - キー情報を整列化できない場合

NullPointerException - parentがnullである場合