Java Doc for SOAPHeader.java in  » 6.0-JDK-Modules » saaj » javax » xml » soap » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / 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 geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » saaj » javax.xml.soap 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.xml.soap.SOAPHeader

All known Subclasses:   com.sun.xml.messaging.saaj.soap.impl.HeaderImpl,
SOAPHeader
public interface SOAPHeader extends SOAPElement(Code)
A representation of the SOAP header element. A SOAP header element consists of XML data that affects the way the application-specific content is processed by the message provider. For example, transaction semantics, authentication information, and so on, can be specified as the content of a SOAPHeader object.

A SOAPEnvelope object contains an empty SOAPHeader object by default. If the SOAPHeader object, which is optional, is not needed, it can be retrieved and deleted with the following line of code. The variable se is a SOAPEnvelope object.

 se.getHeader().detachNode();
 
A SOAPHeader object is created with the SOAPEnvelope method addHeader. This method, which creates a new header and adds it to the envelope, may be called only after the existing header has been removed.
 se.getHeader().detachNode();
 SOAPHeader sh = se.addHeader();
 

A SOAPHeader object can have only SOAPHeaderElement objects as its immediate children. The method addHeaderElement creates a new HeaderElement object and adds it to the SOAPHeader object. In the following line of code, the argument to the method addHeaderElement is a Name object that is the name for the new HeaderElement object.

 SOAPHeaderElement shElement = sh.addHeaderElement(name);
 

See Also:   SOAPHeaderElement




Method Summary
public  SOAPHeaderElementaddHeaderElement(Name name)
     Creates a new SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object.
public  SOAPHeaderElementaddHeaderElement(QName qname)
     Creates a new SOAPHeaderElement object initialized with the specified qname and adds it to this SOAPHeader object.
public  SOAPHeaderElementaddNotUnderstoodHeaderElement(QName name)
     Creates a new NotUnderstood SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object. This operation is supported only by SOAP 1.2.
Parameters:
  name - a QName object with the name of theSOAPHeaderElement object that was not understood.
public  SOAPHeaderElementaddUpgradeHeaderElement(Iterator supportedSOAPURIs)
     Creates a new Upgrade SOAPHeaderElement object initialized with the specified List of supported SOAP URIs and adds it to this SOAPHeader object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
Parameters:
  supportedSOAPURIs - an Iterator object with the URIs of SOAPversions supported.
public  SOAPHeaderElementaddUpgradeHeaderElement(String[] supportedSoapUris)
     Creates a new Upgrade SOAPHeaderElement object initialized with the specified array of supported SOAP URIs and adds it to this SOAPHeader object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
Parameters:
  supportedSoapUris - an array of the URIs of SOAP versions supported.
public  SOAPHeaderElementaddUpgradeHeaderElement(String supportedSoapUri)
     Creates a new Upgrade SOAPHeaderElement object initialized with the specified supported SOAP URI and adds it to this SOAPHeader object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
Parameters:
  supportedSoapUri - the URI of SOAP the version that is supported.
public  IteratorexamineAllHeaderElements()
     Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object.
public  IteratorexamineHeaderElements(String actor)
     Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor. An actor is a global attribute that indicates the intermediate parties that should process a message before it reaches its ultimate receiver.
public  IteratorexamineMustUnderstandHeaderElements(String actor)
     Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor and that have a MustUnderstand attribute whose value is equivalent to true.
public  IteratorextractAllHeaderElements()
     Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object and detaches them from this SOAPHeader object.
public  IteratorextractHeaderElements(String actor)
     Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor and detaches them from this SOAPHeader object.



Method Detail
addHeaderElement
public SOAPHeaderElement addHeaderElement(Name name) throws SOAPException(Code)
Creates a new SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object.
Parameters:
  name - a Name object with the name of the newSOAPHeaderElement object the new SOAPHeaderElement object that wasinserted into this SOAPHeader object
exception:
  SOAPException - if a SOAP error occurs
See Also:   SOAPHeader.addHeaderElement(javax.xml.namespace.QName)



addHeaderElement
public SOAPHeaderElement addHeaderElement(QName qname) throws SOAPException(Code)
Creates a new SOAPHeaderElement object initialized with the specified qname and adds it to this SOAPHeader object.
Parameters:
  qname - a QName object with the qname of the newSOAPHeaderElement object the new SOAPHeaderElement object that wasinserted into this SOAPHeader object
exception:
  SOAPException - if a SOAP error occurs
See Also:   SOAPHeader.addHeaderElement(Name)
since:
   SAAJ 1.3



addNotUnderstoodHeaderElement
public SOAPHeaderElement addNotUnderstoodHeaderElement(QName name) throws SOAPException(Code)
Creates a new NotUnderstood SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object. This operation is supported only by SOAP 1.2.
Parameters:
  name - a QName object with the name of theSOAPHeaderElement object that was not understood. the new SOAPHeaderElement object that wasinserted into this SOAPHeader object
exception:
  SOAPException - if a SOAP error occurs.
exception:
  UnsupportedOperationException - if this is a SOAP 1.1 Header.
since:
   SAAJ 1.3



addUpgradeHeaderElement
public SOAPHeaderElement addUpgradeHeaderElement(Iterator supportedSOAPURIs) throws SOAPException(Code)
Creates a new Upgrade SOAPHeaderElement object initialized with the specified List of supported SOAP URIs and adds it to this SOAPHeader object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
Parameters:
  supportedSOAPURIs - an Iterator object with the URIs of SOAPversions supported. the new SOAPHeaderElement object that wasinserted into this SOAPHeader object
exception:
  SOAPException - if a SOAP error occurs.
since:
   SAAJ 1.3



addUpgradeHeaderElement
public SOAPHeaderElement addUpgradeHeaderElement(String[] supportedSoapUris) throws SOAPException(Code)
Creates a new Upgrade SOAPHeaderElement object initialized with the specified array of supported SOAP URIs and adds it to this SOAPHeader object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
Parameters:
  supportedSoapUris - an array of the URIs of SOAP versions supported. the new SOAPHeaderElement object that wasinserted into this SOAPHeader object
exception:
  SOAPException - if a SOAP error occurs.
since:
   SAAJ 1.3



addUpgradeHeaderElement
public SOAPHeaderElement addUpgradeHeaderElement(String supportedSoapUri) throws SOAPException(Code)
Creates a new Upgrade SOAPHeaderElement object initialized with the specified supported SOAP URI and adds it to this SOAPHeader object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
Parameters:
  supportedSoapUri - the URI of SOAP the version that is supported. the new SOAPHeaderElement object that wasinserted into this SOAPHeader object
exception:
  SOAPException - if a SOAP error occurs.
since:
   SAAJ 1.3



examineAllHeaderElements
public Iterator examineAllHeaderElements()(Code)
Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object. an Iterator object over all theSOAPHeaderElement objects contained by thisSOAPHeader
See Also:   SOAPHeader.extractAllHeaderElements
since:
   SAAJ 1.2



examineHeaderElements
public Iterator examineHeaderElements(String actor)(Code)
Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor. An actor is a global attribute that indicates the intermediate parties that should process a message before it reaches its ultimate receiver. An actor receives the message and processes it before sending it on to the next actor. The default actor is the ultimate intended recipient for the message, so if no actor attribute is included in a SOAPHeader object, it is sent to the ultimate receiver along with the message body.

In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics.
Parameters:
  actor - a String giving the URI of the actor / rolefor which to search an Iterator object over all theSOAPHeaderElement objects that contain the specifiedactor / role
See Also:   SOAPHeader.extractHeaderElements
See Also:   SOAPConstants.URI_SOAP_ACTOR_NEXT




examineMustUnderstandHeaderElements
public Iterator examineMustUnderstandHeaderElements(String actor)(Code)
Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor and that have a MustUnderstand attribute whose value is equivalent to true.

In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics.
Parameters:
  actor - a String giving the URI of the actor / rolefor which to search an Iterator object over all theSOAPHeaderElement objects that contain the specifiedactor / role and are marked as MustUnderstand
See Also:   SOAPHeader.examineHeaderElements
See Also:   SOAPHeader.extractHeaderElements
See Also:   SOAPConstants.URI_SOAP_ACTOR_NEXT
since:
   SAAJ 1.2




extractAllHeaderElements
public Iterator extractAllHeaderElements()(Code)
Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object and detaches them from this SOAPHeader object. an Iterator object over all theSOAPHeaderElement objects contained by thisSOAPHeader
See Also:   SOAPHeader.examineAllHeaderElements
since:
   SAAJ 1.2



extractHeaderElements
public Iterator extractHeaderElements(String actor)(Code)
Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor and detaches them from this SOAPHeader object.

This method allows an actor to process the parts of the SOAPHeader object that apply to it and to remove them before passing the message on to the next actor.

In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics.
Parameters:
  actor - a String giving the URI of the actor / rolefor which to search an Iterator object over all theSOAPHeaderElement objects that contain the specifiedactor / role
See Also:   SOAPHeader.examineHeaderElements
See Also:   SOAPConstants.URI_SOAP_ACTOR_NEXT




www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.