com.sun.xml.ws.security.opt.crypto.jaxb
Class JAXBCryptoContext

java.lang.Object
  extended by 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
JAXBCryptoContext()
          Creates a new instance of JAXBCryptoContext
 
Method Summary
 Object get(Object key)
          Returns the value to which this context maps the specified key.
 String getBaseURI()
          Returns the base URI.
 String getDefaultNamespacePrefix()
          Returns the default namespace prefix.
 KeySelector getKeySelector()
          Returns the key selector for finding a key.
 String getNamespacePrefix(String namespaceURI, String defaultPrefix)
          Returns the namespace prefix that the specified namespace URI is associated with.
 Object getProperty(String name)
          Returns the value of the specified property.
 URIDereferencer getURIDereferencer()
          Returns a URIDereferencer that is used to dereference URIReferences.
 Object put(Object key, Object value)
          Associates the specified value with the specified key in this context.
 String putNamespacePrefix(String namespaceURI, String prefix)
          Maps the specified namespace URI to the specified prefix.
 void setBaseURI(String baseURI)
          Sets the base URI.
 void setDefaultNamespacePrefix(String defaultNamespacePrefix)
          Sets the default namespace prefix.
 void setKeySelector(KeySelector keySelector)
          Sets the key selector for finding a key.
 Object setProperty(String name, Object value)
          Sets the specified property.
 void setURIDereferencer(URIDereferencer uriDereferencer)
          Sets a URIDereferencer that is used to dereference URIReferences.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JAXBCryptoContext

public JAXBCryptoContext()
Creates a new instance of JAXBCryptoContext

Method Detail

getBaseURI

public String getBaseURI()
Returns the base URI.

Specified by:
getBaseURI in interface XMLCryptoContext
Returns:
the base URI, or null if not specified
See Also:
setBaseURI(String)

setBaseURI

public void setBaseURI(String baseURI)
Sets the base URI.

Specified by:
setBaseURI in interface XMLCryptoContext
Parameters:
baseURI - the base URI, or null to remove current value
Throws:
IllegalArgumentException - if baseURI is not RFC 2396 compliant
See Also:
getBaseURI()

getKeySelector

public KeySelector getKeySelector()
Returns the key selector for finding a key.

Specified by:
getKeySelector in interface XMLCryptoContext
Returns:
the key selector, or null if not specified
See Also:
setKeySelector(KeySelector)

setKeySelector

public void setKeySelector(KeySelector keySelector)
Sets the key selector for finding a key.

Specified by:
setKeySelector in interface XMLCryptoContext
Parameters:
ks - the key selector, or null to remove the current setting
See Also:
getKeySelector()

getURIDereferencer

public URIDereferencer getURIDereferencer()
Returns a URIDereferencer that is used to dereference URIReferences.

Specified by:
getURIDereferencer in interface XMLCryptoContext
Returns:
the URIDereferencer, or null if not specified
See Also:
setURIDereferencer(URIDereferencer)

setURIDereferencer

public void setURIDereferencer(URIDereferencer uriDereferencer)
Sets a URIDereferencer that is used to dereference URIReferences. The specified URIDereferencer is used in place of an implementation's default URIDereferencer.

Specified by:
setURIDereferencer in interface XMLCryptoContext
Parameters:
dereferencer - the URIDereferencer, or null to 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 the putNamespacePrefix method.

Specified by:
getNamespacePrefix in interface XMLCryptoContext
Parameters:
namespaceURI - a namespace URI
defaultPrefix - 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 defaultPrefix if the URI is not registered. If the namespace URI is registered but has no prefix, an empty string ("") is returned.
Throws:
NullPointerException - if namespaceURI is null
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:
putNamespacePrefix in interface XMLCryptoContext
Parameters:
namespaceURI - a namespace URI
prefix - a namespace prefix (or null to 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 null if there was none
Throws:
NullPointerException - if namespaceURI is null
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 the putNamespacePrefix method.

Specified by:
getDefaultNamespacePrefix in interface XMLCryptoContext
Returns:
the default namespace prefix, or null if 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 the putNamespacePrefix method.

Specified by:
setDefaultNamespacePrefix in interface XMLCryptoContext
Parameters:
defaultPrefix - the default namespace prefix, or null to 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:
setProperty in interface XMLCryptoContext
Parameters:
name - the name of the property
value - the value of the property to be set
Returns:
the previous value of the specified property, or null if it did not have a value
Throws:
NullPointerException - if name is null
See Also:
getProperty(String)

getProperty

public Object getProperty(String name)
Returns the value of the specified property.

Specified by:
getProperty in interface XMLCryptoContext
Parameters:
name - the name of the property
Returns:
the current value of the specified property, or null if it does not have a value
Throws:
NullPointerException - if name is null
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 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.

Specified by:
get in interface XMLCryptoContext
Parameters:
key - the key whose associated value is to be returned
Returns:
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)

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:
put in interface XMLCryptoContext
Parameters:
key - key with which the specified value is to be associated with
value - value to be associated with the specified key
Returns:
the previous value associated with the key, or null if 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)


Copyright © 2005-2015 Oracle Corporation. All Rights Reserved.