OpenJDK 27 · javax.xml.crypto.XMLCryptoContext · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public Object	Returns: the value to which this context maps the specified key, or `null` if there is no mapping for the key get(Object the key whose associated value is to be returned key) Returns the value to which this context maps the specified key.
public String	Returns: the base URI, or `null` if not specified getBaseURI() Returns the base URI.
public String	Returns: the default namespace prefix, or `null` if none has been set. getDefaultNamespacePrefix() Returns the default namespace prefix.
public KeySelector	Returns: the key selector, or `null` if not specified getKeySelector() Returns the key selector for finding a key.
public String	Returns: the prefix that is associated with the specified namespace URI, or `defaultPrefix` if the URI is not registered. If the namespace URI is registered but has no prefix, an empty string (`""`) is returned. getNamespacePrefix(String a namespace URI namespaceURI, String the prefix to be returned in the event that the the specified namespace URI has not been bound to a prefix. defaultPrefix) Returns the namespace prefix that the specified namespace URI is associated with.
public Object	Returns: the current value of the specified property, or `null` if it does not have a value getProperty(String the name of the property name) Returns the value of the specified property.
public URIDereferencer	Returns: the `URIDereferencer`, or `null` if not specified getURIDereferencer() Returns a `URIDereferencer` that is used to dereference `URIReference`s.
public Object	Returns: the previous value associated with the key, or `null` if there was no mapping for the key put(Object key with which the specified value is to be associated with key, Object value to be associated with the specified key value) Associates the specified value with the specified key in this context.
public String	Returns: the previous prefix associated with the specified namespace URI, or `null` if there was none putNamespacePrefix(String a namespace URI namespaceURI, String a namespace prefix (or `null` to remove any existing mapping). Specifying the empty string (`""`) binds no prefix to the namespace URI. prefix) Maps the specified namespace URI to the specified prefix.
public void	setBaseURI(String the base URI, or `null` to remove current value baseURI) Sets the base URI.
public void	setDefaultNamespacePrefix(String the default namespace prefix, or `null` to remove the current setting. Specify the empty string (`""`) to bind no prefix. defaultPrefix) Sets the default namespace prefix.
public void	setKeySelector(KeySelector the key selector, or `null` to remove the current setting ks) Sets the key selector for finding a key.
public Object	Returns: the previous value of the specified property, or `null` if it did not have a value setProperty(String the name of the property name, Object the value of the property to be set value) Sets the specified property.
public void	setURIDereferencer(URIDereferencer the `URIDereferencer`, or `null` to remove any current setting dereferencer) Sets a `URIDereferencer` that is used to dereference `URIReference`s.

Method Detail

get back to summary

get	back to summary
public Object get(Object key) Returns the value to which this context maps the specified key. More formally, if this context contains a mapping from a key `k` to a value `v` such that `(key==null ? k==null : key.equals(k))`, then this method returns `v`; otherwise it returns `null`. (There can be at most one such mapping.) This method is useful for retrieving arbitrary information that is specific to the cryptographic operation that this context is used for. Parameters key:Object the key whose associated value is to be returned Returns:Object the value to which this context maps the specified key, or `null` if there is no mapping for the key See Also `put(Object, Object)`

public Object get(Object key)

Returns the value to which this context maps the specified key.

More formally, if this context contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

This method is useful for retrieving arbitrary information that is specific to the cryptographic operation that this context is used for.

Parameters

key:Object: the key whose associated value is to be returned

Returns:Object

the value to which this context maps the specified key, or null if there is no mapping for the key

See Also

put(Object, Object)

getBaseURI back to summary

getBaseURI	back to summary
public String getBaseURI() Returns the base URI. Returns:String the base URI, or `null` if not specified See Also `setBaseURI(String)`

public String getBaseURI()

Returns the base URI.

Returns:String: the base URI, or null if not specified
See Also: setBaseURI(String)

getDefaultNamespacePrefix back to summary

getDefaultNamespacePrefix	back to summary
public String getDefaultNamespacePrefix() Returns the default namespace prefix. The default namespace prefix is the prefix for all namespace URIs not explicitly set by the `putNamespacePrefix` method. Returns:String the default namespace prefix, or `null` if none has been set. See Also `setDefaultNamespacePrefix(String)`

public String getDefaultNamespacePrefix()

Returns the default namespace prefix. The default namespace prefix is the prefix for all namespace URIs not explicitly set by the putNamespacePrefix method.

Returns:String: the default namespace prefix, or null if none has been set.
See Also: setDefaultNamespacePrefix(String)

getKeySelector back to summary

getKeySelector	back to summary
public KeySelector getKeySelector() Returns the key selector for finding a key. Returns:KeySelector the key selector, or `null` if not specified See Also `setKeySelector(KeySelector)`

public KeySelector getKeySelector()

Returns the key selector for finding a key.

Returns:KeySelector: the key selector, or null if not specified
See Also: setKeySelector(KeySelector)

getNamespacePrefix back to summary

getNamespacePrefix	back to summary
public String getNamespacePrefix(String namespaceURI, String defaultPrefix) Returns the namespace prefix that the specified namespace URI is associated with. Returns the specified default prefix if the specified namespace URI has not been bound to a prefix. To bind a namespace URI to a prefix, call the `putNamespacePrefix` method. Parameters namespaceURI:String a namespace URI defaultPrefix:String the prefix to be returned in the event that the the specified namespace URI has not been bound to a prefix. Returns:String the prefix that is associated with the specified namespace URI, or `defaultPrefix` if the URI is not registered. If the namespace URI is registered but has no prefix, an empty string (`""`) is returned. Exceptions NullPointerException: if `namespaceURI` is `null` See Also `putNamespacePrefix(String, String)`

public String getNamespacePrefix(String namespaceURI, String defaultPrefix)

Returns the namespace prefix that the specified namespace URI is associated with. Returns the specified default prefix if the specified namespace URI has not been bound to a prefix. To bind a namespace URI to a prefix, call the putNamespacePrefix method.

Parameters

namespaceURI:String: a namespace URI
defaultPrefix:String: the prefix to be returned in the event that the the specified namespace URI has not been bound to a prefix.

Returns:String

the prefix that is associated with the specified namespace URI, or defaultPrefix if the URI is not registered. If the namespace URI is registered but has no prefix, an empty string ("") is returned.

Exceptions

NullPointerException:: if namespaceURI is null

See Also

putNamespacePrefix(String, String)

getProperty back to summary

getProperty	back to summary
public Object getProperty(String name) Returns the value of the specified property. Parameters name:String the name of the property Returns:Object the current value of the specified property, or `null` if it does not have a value Exceptions NullPointerException: if `name` is `null` See Also `setProperty(String, Object)`

public Object getProperty(String name)

Returns the value of the specified property.

Parameters

name:String: the name of the property

Returns:Object

the current value of the specified property, or null if it does not have a value

Exceptions

NullPointerException:: if name is null

See Also

setProperty(String, Object)

getURIDereferencer back to summary

getURIDereferencer	back to summary
public URIDereferencer getURIDereferencer() Returns a `URIDereferencer` that is used to dereference `URIReference`s. Returns:URIDereferencer the `URIDereferencer`, or `null` if not specified See Also `setURIDereferencer(URIDereferencer)`

public URIDereferencer getURIDereferencer()

Returns a URIDereferencer that is used to dereference URIReferences.

Returns:URIDereferencer: the URIDereferencer, or null if not specified
See Also: setURIDereferencer(URIDereferencer)

put back to summary

put	back to summary
public Object put(Object key, Object value) Associates the specified value with the specified key in this context. If the context previously contained a mapping for this key, the old value is replaced by the specified value. This method is useful for storing arbitrary information that is specific to the cryptographic operation that this context is used for. Parameters key:Object key with which the specified value is to be associated with value:Object value to be associated with the specified key Returns:Object the previous value associated with the key, or `null` if there was no mapping for the key Exceptions IllegalArgumentException: if some aspect of this key or value prevents it from being stored in this context See Also `get(Object)`

public Object put(Object key, Object value)

Associates the specified value with the specified key in this context. If the context previously contained a mapping for this key, the old value is replaced by the specified value.

This method is useful for storing arbitrary information that is specific to the cryptographic operation that this context is used for.

Parameters

key:Object: key with which the specified value is to be associated with
value:Object: value to be associated with the specified key

Returns:Object

the previous value associated with the key, or null if there was no mapping for the key

Exceptions

IllegalArgumentException:: if some aspect of this key or value prevents it from being stored in this context

See Also

get(Object)

putNamespacePrefix back to summary

putNamespacePrefix	back to summary
public String putNamespacePrefix(String namespaceURI, String prefix) Maps the specified namespace URI to the specified prefix. If there is already a prefix associated with the specified namespace URI, the old prefix is replaced by the specified prefix. Parameters namespaceURI:String a namespace URI prefix:String a namespace prefix (or `null` to remove any existing mapping). Specifying the empty string (`""`) binds no prefix to the namespace URI. Returns:String the previous prefix associated with the specified namespace URI, or `null` if there was none Exceptions NullPointerException: if `namespaceURI` is `null` See Also `getNamespacePrefix(String, String)`

public String putNamespacePrefix(String namespaceURI, String prefix)

Maps the specified namespace URI to the specified prefix. If there is already a prefix associated with the specified namespace URI, the old prefix is replaced by the specified prefix.

Parameters

namespaceURI:String: a namespace URI
prefix:String: a namespace prefix (or null to remove any existing mapping). Specifying the empty string ("") binds no prefix to the namespace URI.

Returns:String

the previous prefix associated with the specified namespace URI, or null if there was none

Exceptions

NullPointerException:: if namespaceURI is null

See Also

getNamespacePrefix(String, String)

setBaseURI back to summary

setBaseURI	back to summary
public void setBaseURI(String baseURI) Sets the base URI. Parameters baseURI:String the base URI, or `null` to remove current value Exceptions IllegalArgumentException: if `baseURI` is not RFC 2396 compliant See Also `getBaseURI`

public void setBaseURI(String baseURI)

Sets the base URI.

Parameters

baseURI:String: the base URI, or null to remove current value

Exceptions

IllegalArgumentException:: if baseURI is not RFC 2396 compliant

See Also

getBaseURI

setDefaultNamespacePrefix back to summary

setDefaultNamespacePrefix	back to summary
public void setDefaultNamespacePrefix(String defaultPrefix) Sets the default namespace prefix. This sets the namespace prefix for all namespace URIs not explicitly set by the `putNamespacePrefix` method. Parameters defaultPrefix:String the default namespace prefix, or `null` to remove the current setting. Specify the empty string (`""`) to bind no prefix. See Also `getDefaultNamespacePrefix`

public void setDefaultNamespacePrefix(String defaultPrefix)

Sets the default namespace prefix. This sets the namespace prefix for all namespace URIs not explicitly set by the putNamespacePrefix method.

Parameters

defaultPrefix:String: the default namespace prefix, or null to remove the current setting. Specify the empty string ("") to bind no prefix.

See Also

getDefaultNamespacePrefix

setKeySelector back to summary

setKeySelector	back to summary
public void setKeySelector(KeySelector ks) Sets the key selector for finding a key. Parameters ks:KeySelector the key selector, or `null` to remove the current setting See Also `getKeySelector`

public void setKeySelector(KeySelector ks)

Sets the key selector for finding a key.

Parameters

ks:KeySelector: the key selector, or null to remove the current setting

See Also

getKeySelector

setProperty back to summary

setProperty	back to summary
public Object setProperty(String name, Object value) Sets the specified property. Parameters name:String the name of the property value:Object the value of the property to be set Returns:Object the previous value of the specified property, or `null` if it did not have a value Exceptions NullPointerException: if `name` is `null` See Also `getProperty(String)`

public Object setProperty(String name, Object value)

Sets the specified property.

Parameters

name:String: the name of the property
value:Object: the value of the property to be set

Returns:Object

the previous value of the specified property, or null if it did not have a value

Exceptions

NullPointerException:: if name is null

See Also

getProperty(String)

setURIDereferencer back to summary

setURIDereferencer	back to summary
public void setURIDereferencer(URIDereferencer dereferencer) Sets a `URIDereferencer` that is used to dereference `URIReference`s. The specified `URIDereferencer` is used in place of an implementation's default `URIDereferencer`. Parameters dereferencer:URIDereferencer the `URIDereferencer`, or `null` to remove any current setting See Also `getURIDereferencer`

public void setURIDereferencer(URIDereferencer dereferencer)

Sets a URIDereferencer that is used to dereference URIReferences. The specified URIDereferencer is used in place of an implementation's default URIDereferencer.

Parameters

dereferencer:URIDereferencer: the URIDereferencer, or null to remove any current setting

See Also

getURIDereferencer

public Interface XMLCryptoContext

Method Summary

Method Detail