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 を返します。

定義:

getNamespacePrefix、インタフェース: XMLCryptoContext

パラメータ:

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 を指定した接頭辞にマッピングします。

定義:

putNamespacePrefix、インタフェース: XMLCryptoContext

パラメータ:

namespaceURI - 名前空間 URI

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

戻り値:

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

例外:

NullPointerException - namespaceURI が null である場合

関連項目:

XMLCryptoContext.getNamespacePrefix(String, String)

getDefaultNamespacePrefix

public String getDefaultNamespacePrefix()

インタフェースからコピーされた説明: XMLCryptoContext

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

定義:

getDefaultNamespacePrefix、インタフェース: XMLCryptoContext

戻り値:

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

関連項目:

XMLCryptoContext.setDefaultNamespacePrefix(String)

setDefaultNamespacePrefix

public void setDefaultNamespacePrefix(String defaultPrefix)

インタフェースからコピーされた説明: XMLCryptoContext

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

定義:

setDefaultNamespacePrefix、インタフェース: XMLCryptoContext

パラメータ:

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

関連項目:

XMLCryptoContext.getDefaultNamespacePrefix()

getBaseURI

public String getBaseURI()

インタフェースからコピーされた説明: XMLCryptoContext

ベース URI を返します。

定義:

getBaseURI、インタフェース: XMLCryptoContext

戻り値:

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

関連項目:

XMLCryptoContext.setBaseURI(String)

setBaseURI

public void setBaseURI(String baseURI)

インタフェースからコピーされた説明: XMLCryptoContext

ベース URI を設定します。

定義:

setBaseURI、インタフェース: XMLCryptoContext

パラメータ:

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

例外:

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

関連項目:

XMLCryptoContext.getBaseURI()

getURIDereferencer

public URIDereferencer getURIDereferencer()

インタフェースからコピーされた説明: XMLCryptoContext

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

定義:

getURIDereferencer、インタフェース: XMLCryptoContext

戻り値:

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

関連項目:

XMLCryptoContext.setURIDereferencer(URIDereferencer)

setURIDereferencer

public void setURIDereferencer(URIDereferencer dereferencer)

インタフェースからコピーされた説明: XMLCryptoContext

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

定義:

setURIDereferencer、インタフェース: XMLCryptoContext

パラメータ:

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

関連項目:

XMLCryptoContext.getURIDereferencer()

getProperty

public Object getProperty(String name)

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

定義:

getProperty、インタフェース: XMLCryptoContext

パラメータ:

name - プロパティーの名前

戻り値:

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

例外:

NullPointerException - name が null である場合

関連項目:

XMLCryptoContext.setProperty(String, Object)

setProperty

public Object setProperty(String name,
                 Object value)

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

定義:

setProperty、インタフェース: XMLCryptoContext

パラメータ:

name - プロパティーの名前

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

戻り値:

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

例外:

NullPointerException - name が null である場合

関連項目:

XMLCryptoContext.getProperty(String)

getKeySelector

public KeySelector getKeySelector()

インタフェースからコピーされた説明: XMLCryptoContext

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

定義:

getKeySelector、インタフェース: XMLCryptoContext

戻り値:

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

関連項目:

XMLCryptoContext.setKeySelector(KeySelector)

setKeySelector

public void setKeySelector(KeySelector ks)

インタフェースからコピーされた説明: XMLCryptoContext

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

定義:

setKeySelector、インタフェース: XMLCryptoContext

パラメータ:

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 を使用して、指定した鍵がマッピングするオブジェクトを取得します。

定義:

get、インタフェース: XMLCryptoContext

パラメータ:

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

戻り値:

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

関連項目:

XMLCryptoContext.put(Object, Object)

put

public Object put(Object key,
         Object value)

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

定義:

put、インタフェース: XMLCryptoContext

パラメータ:

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

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

戻り値:

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

例外:

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

関連項目:

XMLCryptoContext.get(Object)