javax.xml.crypto
介面 XMLCryptoContext

所有已知子介面：

XMLSignContext, XMLValidateContext

所有已知實作類別：

DOMCryptoContext, DOMSignContext, DOMValidateContext

public interface XMLCryptoContext

包含用於 XML 加密操作的通用上下文資訊。

此介面包含一些方法可用來設置和檢索那些影響 XML 簽章或 XML 加密結構處理的屬性。

注意，XMLCryptoContext 實例可以包含特定於所使用的 XML 加密結構的資訊和狀態。如果 XMLCryptoContext 使用多個結構（例如，不應該使用相同的 XMLValidateContext 實例來驗證兩個不同的 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 關聯以前使用的前綴，如果沒有任何前綴，則返回 null

拋出：

NullPointerException - 如果 namespaceURI 為 null

另請參見：

getNamespacePrefix(String, String)

getDefaultNamespacePrefix

String getDefaultNamespacePrefix()

返回預設名稱空間前綴。預設的名稱空間前綴是用於所有名稱空間 URI 的前綴，該前綴未通過 putNamespacePrefix 方法顯式設置。

返回：

預設的名稱空間前綴；如果未設置任何前綴，則返回 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)

返回此上下文將指定鍵映射到的值。

更正式地說，如果此上下文包含鍵 k 到值 v 的映射關係：(key==null ? k==null :key.equals(k))，則此方法返回 v；否則返回 null。（最多只能有一個這樣的映射關係）。

對於檢索特定於使用此上下文的加密操作的任意資訊，此方法很有用。

參數：

key - 關聯值將被返回的鍵

返回：

此上下文將指定鍵映射到的值；如果沒有與該鍵有關的映射關係，則返回 null

另請參見：

put(Object, Object)

put

Object put(Object key,
           Object value)

將指定值與此上下文中的指定鍵關聯。如果此上下文中以前包含一個此鍵的映射關係，則用指定值替換原來的值。

對於存儲特定於使用此上下文的加密操作的任意資訊，此方法很有用。

參數：

key - 將與指定值關聯的鍵

value - 將與指定鍵關聯的值

返回：

與指定鍵關聯的以前的值；如果沒有與該鍵有關的映射關係，則返回 null

拋出：

IllegalArgumentException - 如果此鍵或值的某個方面阻止它存儲在此上下文中

另請參見：

get(Object)