Class JAXBCryptoContext
- java.lang.Object
-
- com.sun.xml.ws.security.opt.crypto.jaxb.JAXBCryptoContext
-
- All Implemented Interfaces:
XMLCryptoContext
- Direct Known Subclasses:
JAXBSignContext,JAXBValidateContext
public class JAXBCryptoContext extends Object implements XMLCryptoContext
- Author:
- Abhijit Das
-
-
Constructor Summary
Constructors Constructor Description JAXBCryptoContext()Creates a new instance of JAXBCryptoContext
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Objectget(Object key)Returns the value to which this context maps the specified key.StringgetBaseURI()Returns the base URI.StringgetDefaultNamespacePrefix()Returns the default namespace prefix.KeySelectorgetKeySelector()Returns the key selector for finding a key.StringgetNamespacePrefix(String namespaceURI, String defaultPrefix)Returns the namespace prefix that the specified namespace URI is associated with.ObjectgetProperty(String name)Returns the value of the specified property.URIDereferencergetURIDereferencer()Returns aURIDereferencerthat is used to dereferenceURIDereferencers.Objectput(Object key, Object value)Associates the specified value with the specified key in this context.StringputNamespacePrefix(String namespaceURI, String prefix)Maps the specified namespace URI to the specified prefix.voidsetBaseURI(String baseURI)Sets the base URI.voidsetDefaultNamespacePrefix(String defaultNamespacePrefix)Sets the default namespace prefix.voidsetKeySelector(KeySelector keySelector)Sets the key selector for finding a key.ObjectsetProperty(String name, Object value)Sets the specified property.voidsetURIDereferencer(URIDereferencer uriDereferencer)Sets aURIDereferencerthat is used to dereferenceURIDereferencers.
-
-
-
Method Detail
-
getBaseURI
public String getBaseURI()
Returns the base URI.- Specified by:
getBaseURIin interfaceXMLCryptoContext- Returns:
- the base URI, or
nullif not specified - See Also:
setBaseURI(String)
-
setBaseURI
public void setBaseURI(String baseURI)
Sets the base URI.- Specified by:
setBaseURIin interfaceXMLCryptoContext- Parameters:
baseURI- the base URI, ornullto remove current value- Throws:
IllegalArgumentException- ifbaseURIis not RFC 2396 compliant- See Also:
getBaseURI()
-
getKeySelector
public KeySelector getKeySelector()
Returns the key selector for finding a key.- Specified by:
getKeySelectorin interfaceXMLCryptoContext- Returns:
- the key selector, or
nullif not specified - See Also:
setKeySelector(KeySelector)
-
setKeySelector
public void setKeySelector(KeySelector keySelector)
Sets the key selector for finding a key.- Specified by:
setKeySelectorin interfaceXMLCryptoContext- Parameters:
keySelector- the key selector, ornullto remove the current setting- See Also:
getKeySelector()
-
getURIDereferencer
public URIDereferencer getURIDereferencer()
Returns aURIDereferencerthat is used to dereferenceURIDereferencers.- Specified by:
getURIDereferencerin interfaceXMLCryptoContext- Returns:
- the
URIDereferencer, ornullif not specified - See Also:
setURIDereferencer(URIDereferencer)
-
setURIDereferencer
public void setURIDereferencer(URIDereferencer uriDereferencer)
Sets aURIDereferencerthat is used to dereferenceURIDereferencers. The specifiedURIDereferenceris used in place of an implementation's defaultURIDereferencer.- Specified by:
setURIDereferencerin interfaceXMLCryptoContext- Parameters:
uriDereferencer- theURIDereferencer, ornullto remove any current setting- See Also:
getURIDereferencer()
-
getNamespacePrefix
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 theputNamespacePrefixmethod.- Specified by:
getNamespacePrefixin interfaceXMLCryptoContext- Parameters:
namespaceURI- a namespace URIdefaultPrefix- the prefix to be returned in the event that the the specified namespace URI has not been bound to a prefix.- Returns:
- the prefix that is associated with the specified namespace URI,
or
defaultPrefixif the URI is not registered. If the namespace URI is registered but has no prefix, an empty string ("") is returned. - Throws:
NullPointerException- ifnamespaceURIisnull- See Also:
putNamespacePrefix(String, String)
-
putNamespacePrefix
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.- Specified by:
putNamespacePrefixin interfaceXMLCryptoContext- Parameters:
namespaceURI- a namespace URIprefix- a namespace prefix (ornullto remove any existing mapping). Specifying the empty string ("") binds no prefix to the namespace URI.- Returns:
- the previous prefix associated with the specified namespace
URI, or
nullif there was none - Throws:
NullPointerException- ifnamespaceURIisnull- See Also:
getNamespacePrefix(String, String)
-
getDefaultNamespacePrefix
public String getDefaultNamespacePrefix()
Returns the default namespace prefix. The default namespace prefix is the prefix for all namespace URIs not explicitly set by theputNamespacePrefixmethod.- Specified by:
getDefaultNamespacePrefixin interfaceXMLCryptoContext- Returns:
- the default namespace prefix, or
nullif none has been set. - See Also:
setDefaultNamespacePrefix(String)
-
setDefaultNamespacePrefix
public void setDefaultNamespacePrefix(String defaultNamespacePrefix)
Sets the default namespace prefix. This sets the namespace prefix for all namespace URIs not explicitly set by theputNamespacePrefixmethod.- Specified by:
setDefaultNamespacePrefixin interfaceXMLCryptoContext- Parameters:
defaultNamespacePrefix- the default namespace prefix, ornullto remove the current setting. Specify the empty string ("") to bind no prefix.- See Also:
getDefaultNamespacePrefix()
-
setProperty
public Object setProperty(String name, Object value)
Sets the specified property.- Specified by:
setPropertyin interfaceXMLCryptoContext- Parameters:
name- the name of the propertyvalue- the value of the property to be set- Returns:
- the previous value of the specified property, or
nullif it did not have a value - Throws:
NullPointerException- ifnameisnull- See Also:
getProperty(String)
-
getProperty
public Object getProperty(String name)
Returns the value of the specified property.- Specified by:
getPropertyin interfaceXMLCryptoContext- Parameters:
name- the name of the property- Returns:
- the current value of the specified property, or
nullif it does not have a value - Throws:
NullPointerException- ifnameisnull- See Also:
setProperty(String, Object)
-
get
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
kto a valuevsuch that(key==null ? k==null : key.equals(k)), then this method returnsv; otherwise it returnsnull. (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.
- Specified by:
getin interfaceXMLCryptoContext- Parameters:
key- the key whose associated value is to be returned- Returns:
- the value to which this context maps the specified key, or
nullif there is no mapping for the key - See Also:
put(Object, Object)
-
put
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.
- Specified by:
putin interfaceXMLCryptoContext- Parameters:
key- key with which the specified value is to be associated withvalue- value to be associated with the specified key- Returns:
- the previous value associated with the key, or
nullif there was no mapping for the key - Throws:
IllegalArgumentException- if some aspect of this key or value prevents it from being stored in this context- See Also:
get(Object)
-
-