javax.xml.crypto.dsig

インタフェース XMLSignature

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

XMLStructure

public interface XMLSignature
extends XMLStructure

「W3C Recommendation for XML-Signature Syntax and Processing」で定義されている XML Signature 要素の表現。このクラスには、W3C 仕様で定義されている、動作を含めた XML 署名の署名および検証用のメソッドを格納します。XML スキーマ定義は、次のように定義されます。

 <element name="Signature" type="ds:SignatureType"/>
 <complexType name="SignatureType">
    <sequence>
      <element ref="ds:SignedInfo"/>
      <element ref="ds:SignatureValue"/>
      <element ref="ds:KeyInfo" minOccurs="0"/>
      <element ref="ds:Object" minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
    <attribute name="Id" type="ID" use="optional"/>
 </complexType>
 

XMLSignature インスタンスは、XMLSignatureFactory クラスの newXMLSignature メソッドの 1 つを呼び出すことで作成できます。

XMLSignature を格納する基本となる文書のコンテンツが、その後変更された場合、動作は定義されていません。

このクラスは、既存の java.security.Signature クラスとの命名でのクラッシュを避けるため、Signature ではなく XMLSignature で名前が付けられます。

導入されたバージョン:

1.6

関連項目:

XMLSignatureFactory.newXMLSignature(SignedInfo, KeyInfo), XMLSignatureFactory.newXMLSignature(SignedInfo, KeyInfo, List, String, String)

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	インタフェースと説明
static interface	XMLSignature.SignatureValue 「W3C Recommendation for XML-Signature Syntax and Processing」で定義されている XML SignatureValue 要素の表現。

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static String	XMLNS XML 署名構文および処理のための W3C 勧告の、XML 名前空間 URI。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
String	getId() この XMLSignature のオプションの Id を返します。
KeyInfo	getKeyInfo() この XMLSignature の鍵情報を返します。
KeySelectorResult	getKeySelectorResult() 指定された場合には、XMLSignature が署名または検証されたあとで KeySelector の結果を返します。
List	getObjects() この XMLSignature に格納される XMLObject の unmodifiable list を返します。
XMLSignature.SignatureValue	getSignatureValue() この XMLSignature の署名値を返します。
SignedInfo	getSignedInfo() この XMLSignature の署名情報を返します。
void	sign(XMLSignContext signContext) この XMLSignature に署名します。
boolean	validate(XMLValidateContext validateContext) コア検証の処理規則に従って、署名を検証します。

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

isFeatureSupported

フィールドの詳細

XMLNS

static final String XMLNS

XML 署名構文および処理のための W3C 勧告の、XML 名前空間 URI。

関連項目:

定数フィールド値

メソッドの詳細

validate

boolean validate(XMLValidateContext validateContext)
                 throws XMLSignatureException

コア検証の処理規則に従って、署名を検証します。このメソッドは既存の状態を使用して署名を検証しますが、コンテキストで指定された位置情報を使用して XMLSignature の内容を整列化したり再初期化したりすることはありません。

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

パラメータ:

validateContext - 検証するコンテキスト

戻り値:

署名がコア検証をパスした場合は true、そうでない場合は false

例外:

ClassCastException - validateContext の型がこの XMLSignature と互換性がない場合

NullPointerException - validateContext が null である場合

XMLSignatureException - 検証中に検証処理が完了できなくなる予想外のエラーが発生した場合

getKeyInfo

KeyInfo getKeyInfo()

この XMLSignature の鍵情報を返します。

戻り値:

鍵情報。指定されない場合は null も可

getSignedInfo

SignedInfo getSignedInfo()

この XMLSignature の署名情報を返します。

戻り値:

署名情報。null にはならない

getObjects

List getObjects()

この XMLSignature に格納される XMLObject の unmodifiable list を返します。

戻り値:

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

getId

String getId()

この XMLSignature のオプションの Id を返します。

戻り値:

Id。指定されない場合は null も可

getSignatureValue

XMLSignature.SignatureValue getSignatureValue()

この XMLSignature の署名値を返します。

戻り値:

署名値

sign

void sign(XMLSignContext signContext)
          throws MarshalException,
                 XMLSignatureException

この XMLSignature に署名します。

このメソッドが例外をスローした場合、この XMLSignature パラメータおよび signContext パラメータは呼び出し前の状態と同じ状態になります。

パラメータ:

signContext - 署名コンテキスト

例外:

ClassCastException - signContext の型がこの XMLSignature と互換性がない場合

NullPointerException - signContext が null である場合

MarshalException - 整列化中に例外が発生した場合

XMLSignatureException - 署名の生成中に予想外の例外が発生した場合

getKeySelectorResult

KeySelectorResult getKeySelectorResult()

指定された場合には、XMLSignature が署名または検証されたあとで KeySelector の結果を返します。

戻り値:

鍵セレクタの結果。鍵セレクタが指定されなかった場合、あるいはこの XMLSignature が署名または検証されていない場合は null