javax.xml.crypto
インタフェース XMLCryptoContext

既知のサブインタフェースの一覧:

XMLSignContext, XMLValidateContext

既知の実装クラスの一覧:

DOMCryptoContext, DOMSignContext, DOMValidateContext

public interface XMLCryptoContext

XML 暗号化処理についての共通コンテキスト情報を格納します。

このインタフェースには、XML 署名または XML 暗号化された構造の処理に影響するプロパティーを、設定または取得するためのメソッドが格納されます。

XMLCryptoContext インスタンスには、ともに使用される XML 暗号化構造に固有の情報および状態を格納できます。XMLCryptoContext が複数の構造とともに使用された場合、予想外の結果となります。たとえば、同じ XMLValidateContext インスタンスを使用して 2 つの異なる XMLSignature オブジェクトを検証すべきではありません。

導入されたバージョン:

1.6

メソッドの概要

Object	get(Object key) このコンテキストで、指定された鍵がマップされる値を返します。
String	getBaseURI() ベース URI を返します。
String	getDefaultNamespacePrefix() デフォルトの名前空間接頭辞を返します。
KeySelector	getKeySelector() 鍵の検索用の鍵セレクタを返します。
String	getNamespacePrefix(String namespaceURI, String defaultPrefix) 指定した名前空間 URI が関連付けられる名前空間接頭辞を返します。
Object	getProperty(String name) 指定されたプロパティーの値を返します。
URIDereferencer	getURIDereferencer() URIReference の間接参照に使用される URIDereferencer を返します。
Object	put(Object key, Object value) このコンテキストで、指定された値を指定された鍵に関連付けます。
String	putNamespacePrefix(String namespaceURI, String prefix) 指定した名前空間 URI を指定した接頭辞にマッピングします。
void	setBaseURI(String baseURI) ベース URI を設定します。
void	setDefaultNamespacePrefix(String defaultPrefix) デフォルトの名前空間接頭辞を設定します。
void	setKeySelector(KeySelector ks) 鍵の検索用の鍵セレクタを設定します。
Object	setProperty(String name, Object value) 指定したプロパティーを設定します。
void	setURIDereferencer(URIDereferencer dereferencer) URIReference の間接参照に使用される URIDereferencer を設定します。

メソッドの詳細

getBaseURI

String getBaseURI()

ベース URI を返します。

戻り値:

ベース URI。または指定されない場合は null

関連項目:

setBaseURI(String)

setBaseURI

void setBaseURI(String baseURI)

ベース URI を設定します。

パラメータ:

baseURI - ベース URI。現在の値を削除する場合は null

例外:

IllegalArgumentException - baseURI が RFC 2396 に準拠していない場合

関連項目:

getBaseURI()

getKeySelector

KeySelector getKeySelector()

鍵の検索用の鍵セレクタを返します。

戻り値:

鍵セレクタ。指定されていない場合は null

関連項目:

setKeySelector(KeySelector)

setKeySelector

void setKeySelector(KeySelector ks)

鍵の検索用の鍵セレクタを設定します。

パラメータ:

ks - 鍵セレクタ。現在の設定を削除する場合は null

関連項目:

getKeySelector()

getURIDereferencer

URIDereferencer getURIDereferencer()

URIReference の間接参照に使用される URIDereferencer を返します。

戻り値:

URIDereferencer。指定されていない場合は null

関連項目:

setURIDereferencer(URIDereferencer)

setURIDereferencer

void setURIDereferencer(URIDereferencer dereferencer)

URIReference の間接参照に使用される URIDereferencer を設定します。指定した URIDereferencer は、実装のデフォルト URIDereferencer の代わりに使用されます。

パラメータ:

dereferencer - URIDereferencer。現在の設定を削除する場合は null

関連項目:

getURIDereferencer()

getNamespacePrefix

String getNamespacePrefix(String namespaceURI,
                          String defaultPrefix)

指定した名前空間 URI が関連付けられる名前空間接頭辞を返します。指定した名前空間 URI が接頭辞にバインドされていない場合、指定したデフォルトの接頭辞を返します。名前空間 URI を接頭辞にバインドするには、putNamespacePrefix メソッドを呼び出します。

パラメータ:

namespaceURI - 名前空間 URI

defaultPrefix - 指定した名前空間 URI が接頭辞にバインドされていない場合に返される接頭辞

戻り値:

指定した名前空間 URI に関連付けられた接頭辞。URI が登録されていない場合は defaultPrefix。名前空間 URI は登録されているが、接頭辞がない場合は、空の文字列 ("") が返される

例外:

NullPointerException - namespaceURI が null の場合

関連項目:

putNamespacePrefix(String, String)

putNamespacePrefix

String putNamespacePrefix(String namespaceURI,
                          String prefix)

指定した名前空間 URI を指定した接頭辞にマッピングします。指定した名前空間 URI と関連付けられた接頭辞がすでに存在する場合、古い接頭辞は指定された接頭辞に置き換えられます。

パラメータ:

namespaceURI - 名前空間 URI

prefix - 名前空間接頭辞。既存のマッピングを削除する場合は null。空の文字列 ("") を指定すると、接頭辞は名前空間 URI にバインドされない

戻り値:

指定した名前空間 URI に関連付けられた以前の接頭辞。1 つもない場合は null

例外:

NullPointerException - namespaceURI が null の場合

関連項目:

getNamespacePrefix(String, String)

getDefaultNamespacePrefix

String getDefaultNamespacePrefix()

デフォルトの名前空間接頭辞を返します。デフォルトの名前空間接頭辞は、putNamespacePrefix メソッドによって明示的に設定されていない、すべての名前空間 URI 用の接頭辞です。

戻り値:

デフォルトの名前空間接頭辞。設定されたものがない場合は null。

関連項目:

setDefaultNamespacePrefix(String)

setDefaultNamespacePrefix

void setDefaultNamespacePrefix(String defaultPrefix)

デフォルトの名前空間接頭辞を設定します。これは、putNamespacePrefix メソッドによって明示的に設定されていない、すべての名前空間 URI 用の名前空間接頭辞を設定します。

パラメータ:

defaultPrefix - デフォルトの名前空間接頭辞。現在の設定を削除する場合は null。接頭辞をバインドしない場合は空の文字列 ("") を指定する

関連項目:

getDefaultNamespacePrefix()

setProperty

Object setProperty(String name,
                   Object value)

指定したプロパティーを設定します。

パラメータ:

name - プロパティーの名前

value - 設定するプロパティーの値

戻り値:

指定されたプロパティーの以前の値。値がなかった場合は null

例外:

NullPointerException - name が null の場合

関連項目:

getProperty(String)

getProperty

Object getProperty(String name)

指定されたプロパティーの値を返します。

パラメータ:

name - プロパティーの名前

戻り値:

指定されたプロパティーの現在の値。値がない場合は null

例外:

NullPointerException - name が null の場合

関連項目:

setProperty(String, Object)

get

Object get(Object key)

このコンテキストで、指定された鍵がマップされる値を返します。

つまり、このメソッドは、(key==null ? k==null : key.equals(k)) となる鍵 k から値 v へのマッピングがこのコンテキストに含まれている場合は v を返し、それ以外の場合は null を返します。このようなマッピングが 1 つだけあります。

このメソッドは、このコンテキストが使用される暗号化処理に固有である、任意の情報を取得するのに便利です。

パラメータ:

key - 関連付けられた値が返される鍵

戻り値:

このコンテキストで、指定された鍵がマップされる値。この鍵に対するマッピングがない場合は null

関連項目:

put(Object, Object)

put

Object put(Object key,
           Object value)

このコンテキストで、指定された値を指定された鍵に関連付けます。コンテキストにすでにこの鍵に対するマッピングがある場合、古い値は指定された値に置き換えられます。

このメソッドは、このコンテキストが使用される暗号化処理に固有である、任意の情報を格納するのに便利です。

パラメータ:

key - 指定される値が関連付けられる鍵

value - 指定された鍵に関連付けられる値

戻り値:

鍵に関連付けられた以前の値。この鍵に対するマッピングがなかった場合は null

例外:

IllegalArgumentException - この鍵または値のなんらかの特性が原因で、このコンテキストに格納できない場合

関連項目:

get(Object)