-
- すべてのスーパー・インタフェース:
XMLStructure
public interface XMLSignature extends XMLStructure
「W3C Recommendation for XML-Signature Syntax and Processing」で定義されているXMLSignature
要素の表現。 このクラスには、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
で名前が付けられます。
-
-
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 インタフェース 説明 static interface
XMLSignature.SignatureValue
「W3C Recommendation for XML-Signature Syntax and Processing」で定義されているXMLSignatureValue
要素の表現。
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 抽象メソッド 修飾子と型 メソッド 説明 String
getId()
このXMLSignature
のオプションのIdを返します。KeyInfo
getKeyInfo()
このXMLSignature
のキー情報を返します。KeySelectorResult
getKeySelectorResult()
指定された場合には、XMLSignature
が署名または検証されたあとでKeySelector
の結果を返します。List<XMLObject>
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
-
-
-
-
メソッドの詳細
-
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<XMLObject> 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
-
-