Java Doc for SOAPHeader.java in  » Web-Services-AXIS2 » 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 » Web Services AXIS2 » saaj » javax.xml.soap 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.xml.soap.SOAPHeader

All known Subclasses:   org.apache.axis2.saaj.SOAPHeaderImpl,
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 addHeaderBlock. 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.addHeaderBlock(); 

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
See Also:    SOAPHeaderElement




Method Summary
abstract public  SOAPHeaderElementaddHeaderElement(Name name)
     Creates a new SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object.
abstract public  SOAPHeaderElementaddHeaderElement(javax.xml.namespace.QName qname)
    
abstract public  SOAPHeaderElementaddNotUnderstoodHeaderElement(javax.xml.namespace.QName qname)
    
abstract public  SOAPHeaderElementaddUpgradeHeaderElement(java.util.Iterator iterator)
    
abstract public  SOAPHeaderElementaddUpgradeHeaderElement(java.lang.String[] as)
    
abstract public  SOAPHeaderElementaddUpgradeHeaderElement(java.lang.String s)
    
abstract public  IteratorexamineAllHeaderElements()
     Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object.
abstract public  IteratorexamineHeaderElements(String actor)
     Returns a list of all the SOAPHeaderElement objects in this SOAPHeader object that have the the specified actor.
abstract 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.
abstract public  IteratorextractAllHeaderElements()
     Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object and detaches them from this SOAPHeader object.
abstract public  IteratorextractHeaderElements(String actor)
     Returns a list of all the SOAPHeaderElement objects in this SOAPHeader object that have the the specified actor and detaches them from this SOAPHeader object.



Method Detail
addHeaderElement
abstract 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 new SOAPHeaderElementobject the new SOAPHeaderElement object that was inserted into thisSOAPHeader object
throws:
  SOAPException - if a SOAP error occurs



addHeaderElement
abstract public SOAPHeaderElement addHeaderElement(javax.xml.namespace.QName qname) throws SOAPException(Code)



addNotUnderstoodHeaderElement
abstract public SOAPHeaderElement addNotUnderstoodHeaderElement(javax.xml.namespace.QName qname) throws SOAPException(Code)



addUpgradeHeaderElement
abstract public SOAPHeaderElement addUpgradeHeaderElement(java.util.Iterator iterator) throws SOAPException(Code)



addUpgradeHeaderElement
abstract public SOAPHeaderElement addUpgradeHeaderElement(java.lang.String[] as) throws SOAPException(Code)



addUpgradeHeaderElement
abstract public SOAPHeaderElement addUpgradeHeaderElement(java.lang.String s) throws SOAPException(Code)



examineAllHeaderElements
abstract public Iterator examineAllHeaderElements()(Code)
Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object. an Iterator object over all the SOAPHeaderElement objectscontained by this SOAPHeader



examineHeaderElements
abstract public Iterator examineHeaderElements(String actor)(Code)
Returns a list of all the SOAPHeaderElement objects in this SOAPHeader object that have the the specified actor. An actor is a global attribute that indicates the intermediate parties to whom the message should be sent. An actor receives the message and then sends it 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, the message is sent to its ultimate destination.
Parameters:
  actor - a String giving the URI of the actor for which to search an Iterator object over all the SOAPHeaderElement objectsthat contain the specified actor
See Also:   SOAPHeader.extractHeaderElements(String)
See Also:    extractHeaderElements(java.lang.String)



examineMustUnderstandHeaderElements
abstract 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.
Parameters:
  actor - a String giving the URI of the actor for which to search an Iterator object over all the SOAPHeaderElement objectsthat contain the specified actor and are marked as MustUnderstand



extractAllHeaderElements
abstract 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 the SOAPHeaderElement objectscontained by this SOAPHeader



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

This method allows an actor to process only the parts of the SOAPHeader object that apply to it and to remove them before passing the message on to the next actor.
Parameters:
  actor - a String giving the URI of the actor for which to search an Iterator object over all the SOAPHeaderElement objectsthat contain the specified actor
See Also:   SOAPHeader.examineHeaderElements(String)
See Also:    examineHeaderElements(java.lang.String)




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