javax.xml.crypto.dom
クラス DOMCryptoContext

java.lang.Object
  javax.xml.crypto.dom.DOMCryptoContext

すべての実装されたインタフェース:

XMLCryptoContext

直系の既知のサブクラス:

DOMSignContext, DOMValidateContext

public class DOMCryptoContext
extends Object
implements XMLCryptoContext

このクラスは、XMLCryptoContext インタフェースの DOM 固有の実装を提供します。型 ID の属性を含む要素を登録し取得するための、DOM ベースの実装に固有の追加メソッドも含まれます。

導入されたバージョン:

1.6

コンストラクタの概要

protected

DOMCryptoContext() デフォルトのコンストラクタです。

メソッドの概要

Object	get(Object key) この実装は内部 HashMap を使用して、指定したキーがマッピングするオブジェクトを取得します。
String	getBaseURI() ベース URI を返します。
String	getDefaultNamespacePrefix() デフォルトの名前空間接頭辞を返します。
Element	getElementById(String idValue) 指定された ID 属性値を含む Element を返します。
KeySelector	getKeySelector() キーの検索用のキーセレクタを返します。
String	getNamespacePrefix(String namespaceURI, String defaultPrefix) この実装は内部 HashMap を使用して、指定した URI がマッピングする接頭辞を取得します。
Object	getProperty(String name) この実装は内部 HashMap を使用して、指定した名前がマッピングするオブジェクトを取得します。
URIDereferencer	getURIDereferencer() URIReference の間接参照に使用される URIDereferencer を返します。
Iterator	iterator() この DOMCryptoContext の識別子/要素マッピングのセットに対する、読み込み専用反復子を返します。
Object	put(Object key, Object value) この実装は内部 HashMap を使用して、指定したオブジェクトにキーをマッピングします。
String	putNamespacePrefix(String namespaceURI, String prefix) この実装は内部 HashMap を使用して、URI を指定した接頭辞にマッピングします。
void	setBaseURI(String baseURI) ベース URI を設定します。
void	setDefaultNamespacePrefix(String defaultPrefix) デフォルトの名前空間接頭辞を設定します。
void	setIdAttributeNS(Element element, String namespaceURI, String localName) 名前空間 URI および型 ID となるローカル名によって指定される要素の属性を登録します。
void	setKeySelector(KeySelector ks) キーの検索用のキーセレクタを設定します。
Object	setProperty(String name, Object value) この実装は内部 HashMap を使用して、名前を指定したオブジェクトにマッピングします。
void	setURIDereferencer(URIDereferencer dereferencer) URIReference の間接参照に使用される URIDereferencer を設定します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

DOMCryptoContext

protected DOMCryptoContext()

デフォルトのコンストラクタです。サブクラスのコンストラクタによる呼び出し用です。

メソッドの詳細

getNamespacePrefix

public String getNamespacePrefix(String namespaceURI,
                                 String defaultPrefix)

この実装は内部 HashMap を使用して、指定した URI がマッピングする接頭辞を取得します。null にマッピングする場合は、defaultPrefix を返します。

定義:

インタフェース XMLCryptoContext 内の getNamespacePrefix

パラメータ:

namespaceURI - 名前空間 URI

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

戻り値:

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

例外:

NullPointerException - namespaceURI が null の場合

関連項目:

XMLCryptoContext.putNamespacePrefix(String, String)

putNamespacePrefix

public String putNamespacePrefix(String namespaceURI,
                                 String prefix)

この実装は内部 HashMap を使用して、URI を指定した接頭辞にマッピングします。

定義:

インタフェース XMLCryptoContext 内の putNamespacePrefix

パラメータ:

namespaceURI - 名前空間 URI

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

戻り値:

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

例外:

NullPointerException - namespaceURI が null の場合

関連項目:

XMLCryptoContext.getNamespacePrefix(String, String)

getDefaultNamespacePrefix

public String getDefaultNamespacePrefix()

インタフェース XMLCryptoContext の記述:

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

定義:

インタフェース XMLCryptoContext 内の getDefaultNamespacePrefix

戻り値:

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

関連項目:

XMLCryptoContext.setDefaultNamespacePrefix(String)

setDefaultNamespacePrefix

public void setDefaultNamespacePrefix(String defaultPrefix)

インタフェース XMLCryptoContext の記述:

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

定義:

インタフェース XMLCryptoContext 内の setDefaultNamespacePrefix

パラメータ:

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

関連項目:

XMLCryptoContext.getDefaultNamespacePrefix()

getBaseURI

public String getBaseURI()

インタフェース XMLCryptoContext の記述:

ベース URI を返します。

定義:

インタフェース XMLCryptoContext 内の getBaseURI

戻り値:

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

関連項目:

XMLCryptoContext.setBaseURI(String)

setBaseURI

public void setBaseURI(String baseURI)

インタフェース XMLCryptoContext の記述:

ベース URI を設定します。

定義:

インタフェース XMLCryptoContext 内の setBaseURI

パラメータ:

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

例外:

IllegalArgumentException - baseURI が RFC 2396 準拠でない場合

関連項目:

XMLCryptoContext.getBaseURI()

getURIDereferencer

public URIDereferencer getURIDereferencer()

インタフェース XMLCryptoContext の記述:

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

定義:

インタフェース XMLCryptoContext 内の getURIDereferencer

戻り値:

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

関連項目:

XMLCryptoContext.setURIDereferencer(URIDereferencer)

setURIDereferencer

public void setURIDereferencer(URIDereferencer dereferencer)

インタフェース XMLCryptoContext の記述:

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

定義:

インタフェース XMLCryptoContext 内の setURIDereferencer

パラメータ:

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

関連項目:

XMLCryptoContext.getURIDereferencer()

getProperty

public Object getProperty(String name)

この実装は内部 HashMap を使用して、指定した名前がマッピングするオブジェクトを取得します。

定義:

インタフェース XMLCryptoContext 内の getProperty

パラメータ:

name - プロパティーの名前

戻り値:

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

例外:

NullPointerException - name が null の場合

関連項目:

XMLCryptoContext.setProperty(String, Object)

setProperty

public Object setProperty(String name,
                          Object value)

この実装は内部 HashMap を使用して、名前を指定したオブジェクトにマッピングします。

定義:

インタフェース XMLCryptoContext 内の setProperty

パラメータ:

name - プロパティーの名前

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

戻り値:

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

例外:

NullPointerException - name が null の場合

関連項目:

XMLCryptoContext.getProperty(String)

getKeySelector

public KeySelector getKeySelector()

インタフェース XMLCryptoContext の記述:

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

定義:

インタフェース XMLCryptoContext 内の getKeySelector

戻り値:

キーセレクタ。または指定されない場合は null

関連項目:

XMLCryptoContext.setKeySelector(KeySelector)

setKeySelector

public void setKeySelector(KeySelector ks)

インタフェース XMLCryptoContext の記述:

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

定義:

インタフェース XMLCryptoContext 内の setKeySelector

パラメータ:

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

関連項目:

XMLCryptoContext.getKeySelector()

getElementById

public Element getElementById(String idValue)

指定された ID 属性値を含む Element を返します。 　

この実装は内部 HashMap を使用して、指定した属性値がマッピングする要素を取得します。

パラメータ:

idValue - ID の値

戻り値:

指定された ID 属性値を含む Element、 ない場合は null を返します。

例外:

NullPointerException - idValue が null の場合

関連項目:

setIdAttributeNS(org.w3c.dom.Element, java.lang.String, java.lang.String)

setIdAttributeNS

public void setIdAttributeNS(Element element,
                             String namespaceURI,
                             String localName)

名前空間 URI および型 ID となるローカル名によって指定される要素の属性を登録します。 この属性には、空でない値が必要です。

　

この実装は内部 HashMap を使用して、指定した要素に属性の値をマッピングします。

パラメータ:

element - 要素

namespaceURI - 属性の名前空間 URI 適用不可の場合は、null を指定)

localName - 属性のローカル名

例外:

IllegalArgumentException - localName が指定した要素の属性ではない場合、 または特定の値を含まない 場合

NullPointerException - element または localName が null の場合

関連項目:

getElementById(java.lang.String)

iterator

public Iterator iterator()

この DOMCryptoContext の識別子/要素マッピングのセットに対する、読み込み専用反復子を返します。Iterator.remove() メソッド経由でセットを変更しようとすると、UnsupportedOperationException をスローします。マッピングが返されるときに特定の順序はありません。反復子内の各要素は Map.Entry で表されます。繰り返し処理の進行中に DOMCryptoContext が変更される場合、繰り返し処理の結果は保証されません。

戻り値:

マッピングのセットに対する読み込み専用の反復子

get

public Object get(Object key)

この実装は内部 HashMap を使用して、指定したキーがマッピングするオブジェクトを取得します。

定義:

インタフェース XMLCryptoContext 内の get

パラメータ:

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

戻り値:

このコンテキストが、指定されたキーにマッピングしている値。 または、キーのマッピングがない場合は null

関連項目:

XMLCryptoContext.put(Object, Object)

put

public Object put(Object key,
                  Object value)

この実装は内部 HashMap を使用して、指定したオブジェクトにキーをマッピングします。

定義:

インタフェース XMLCryptoContext 内の put

パラメータ:

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

value - 指定されるキーに関連付けられる値

戻り値:

キーに関連付けられた以前の値または、キーのマッピングがない場合は null

例外:

IllegalArgumentException - このキーまたは値の一部の特性のために このコンテキストに格納できない場合

関連項目:

XMLCryptoContext.get(Object)