Java Doc for XMLCryptoContext.java in » 6.0-JDK-Core » xml » javax » xml » crypto » Java Source Code / Java DocumentationJava Source Code and Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server
26.	ERP CRM Financial
27.	ESB
28.	Forum
29.	Game
30.	GIS
31.	Graphic 3D
32.	Graphic Library
33.	Groupware
34.	HTML Parser
35.	IDE
36.	IDE Eclipse
37.	IDE Netbeans
38.	Installer
39.	Internationalization Localization
40.	Inversion of Control
41.	Issue Tracking
42.	J2EE
43.	J2ME
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Music
50.	Net
51.	Parser
52.	PDF
53.	Portal
54.	Profiler
55.	Project Management
56.	Report
57.	RSS RDF
58.	Rule Engine
59.	Science
60.	Scripting
61.	Search Engine
62.	Security
63.	Sevlet Container
64.	Source Control
65.	Swing Library
66.	Template Engine
67.	Test Coverage
68.	Testing
69.	UML
70.	Web Crawler
71.	Web Framework
72.	Web Mail
73.	Web Server
74.	Web Services
75.	Web Services apache cxf 2.2.6
76.	Web Services AXIS2
77.	Wiki Engine
78.	Workflow Engines
79.	XML
80.	XML UI

Java Source Code / Java Documentation » 6.0 JDK Core » xml » javax.xml.crypto

Source Cross Reference Class Diagram Java Document (Java Doc)

javax.xml.crypto .XMLCryptoContext

All known Subclasses:   javax.xml.crypto.dom .DOMCryptoContext,
XMLCryptoContext
public interface XMLCryptoContext (Code)
Contains common context information for XML cryptographic operations.
This interface contains methods for setting and retrieving properties that affect the processing of XML signatures or XML encrypted structures.
Note that XMLCryptoContext instances can contain information and state specific to the XML cryptographic structure it is used with. The results are unpredictable if an XMLCryptoContext is used with multiple structures (for example, you should not use the same javax.xml.crypto.dsig.XMLValidateContext instance to validate two different javax.xml.crypto.dsig.XMLSignature objects).
author:
   Sean Mullan
author:
   JSR 105 Expert Group
since:
   1.6

Method Summary
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.
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 URIReference s.
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.
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 defaultPrefix)
     Sets the default namespace prefix.
void setKeySelector(KeySelector ks)
     Sets the key selector for finding a key.
Object setProperty(String name, Object value)
     Sets the specified property.
void setURIDereferencer(URIDereferencer dereferencer)
     Sets a URIDereferencer that is used to dereference URIReference s.

Method Detail
get
Object get(Object key)(Code)
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 - the key whose associated value is to be returned the value to which this context maps the specified key, ornull if there is no mapping for the key
See Also:   XMLCryptoContext.put(Object,Object)

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

getDefaultNamespacePrefix
String getDefaultNamespacePrefix()(Code)
Returns the default namespace prefix. The default namespace prefix is the prefix for all namespace URIs not explicitly set by the XMLCryptoContext.putNamespacePrefix putNamespacePrefix method. the default namespace prefix, or null if none hasbeen set.
See Also:   XMLCryptoContext.setDefaultNamespacePrefix(String)

getKeySelector
KeySelector getKeySelector()(Code)
Returns the key selector for finding a key. the key selector, or null if not specified
See Also:   XMLCryptoContext.setKeySelector(KeySelector)

getNamespacePrefix
String getNamespacePrefix(String namespaceURI, String defaultPrefix)(Code)
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 XMLCryptoContext.putNamespacePrefix putNamespacePrefix method.
Parameters:
  namespaceURI - a namespace URI
Parameters:
  defaultPrefix - the prefix to be returned in the event that thethe specified namespace URI has not been bound to a prefix. the prefix that is associated with the specified namespace URI,or defaultPrefix if the URI is not registered. Ifthe namespace URI is registered but has no prefix, an empty string("") is returned.
throws:
  NullPointerException - if namespaceURI isnull
See Also:   XMLCryptoContext.putNamespacePrefix(String,String)

getProperty
Object getProperty(String name)(Code)
Returns the value of the specified property.
Parameters:
  name - the name of the property the current value of the specified property, ornull if it does not have a value
throws:
  NullPointerException - if name is null
See Also:   XMLCryptoContext.setProperty(String,Object)

getURIDereferencer
URIDereferencer getURIDereferencer()(Code)
Returns a URIDereferencer that is used to dereference URIReference s. the URIDereferencer, or null if notspecified
See Also:   XMLCryptoContext.setURIDereferencer(URIDereferencer)

put
Object put(Object key, Object value)(Code)
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 - key with which the specified value is to be associated with
Parameters:
  value - value to be associated with the specified key 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 valueprevents it from being stored in this context
See Also:   XMLCryptoContext.get(Object)

putNamespacePrefix
String putNamespacePrefix(String namespaceURI, String prefix)(Code)
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 - a namespace URI
Parameters:
  prefix - a namespace prefix (or null to remove anyexisting mapping). Specifying the empty string ("")binds no prefix to the namespace URI. the previous prefix associated with the specified namespaceURI, or null if there was none
throws:
  NullPointerException - if namespaceURI isnull
See Also:   XMLCryptoContext.getNamespacePrefix(String,String)

setBaseURI
void setBaseURI(String baseURI)(Code)
Sets the base URI.
Parameters:
  baseURI - the base URI, or null to remove currentvalue
throws:
  IllegalArgumentException - if baseURI is not RFC2396 compliant
See Also:   XMLCryptoContext.getBaseURI

setDefaultNamespacePrefix
void setDefaultNamespacePrefix(String defaultPrefix)(Code)
Sets the default namespace prefix. This sets the namespace prefix for all namespace URIs not explicitly set by the XMLCryptoContext.putNamespacePrefixputNamespacePrefix method.
Parameters:
  defaultPrefix - the default namespace prefix, or nullto remove the current setting. Specify the empty string("") to bind no prefix.
See Also:   XMLCryptoContext.getDefaultNamespacePrefix

setKeySelector
void setKeySelector(KeySelector ks)(Code)
Sets the key selector for finding a key.
Parameters:
  ks - the key selector, or null to remove the currentsetting
See Also:   XMLCryptoContext.getKeySelector

setProperty
Object setProperty(String name, Object value)(Code)
Sets the specified property.
Parameters:
  name - the name of the property
Parameters:
  value - the value of the property to be set the previous value of the specified property, ornull if it did not have a value
throws:
  NullPointerException - if name is null
See Also:   XMLCryptoContext.getProperty(String)

setURIDereferencer
void setURIDereferencer(URIDereferencer dereferencer)(Code)
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 - the URIDereferencer, or null to remove any current setting
See Also:   XMLCryptoContext.getURIDereferencer

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.