モジュール java.xml.crypto

パッケージ 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<Map.Entry<String,Element>>	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<Map.Entry<String,Element>> 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)