Java Doc for SOAPMessage.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) 


java.lang.Object
   javax.xml.soap.SOAPMessage

SOAPMessage
abstract public class SOAPMessage (Code)

The root class for all SOAP messages. As transmitted on the "wire", a SOAP message is an XML document or a MIME message whose first body part is an XML/SOAP document.

A SOAPMessage object consists of a SOAP part and optionally one or more attachment parts. The SOAP part for a SOAPMessage object is a SOAPPart object, which contains information used for message routing and identification, and which can contain application-specific content. All data in the SOAP Part of a message must be in XML format.

A new SOAPMessage object contains the following by default:

  • A SOAPPart object
  • A SOAPEnvelope object
  • A SOAPBody object
  • A SOAPHeader object
The SOAP part of a message can be retrieved by calling the method SOAPMessage.getSOAPPart(). The SOAPEnvelope object is retrieved from the SOAPPart object, and the SOAPEnvelope object is used to retrieve the SOAPBody and SOAPHeader objects.
 SOAPPart
 sp = message.getSOAPPart(); SOAPEnvelope se = sp.getEnvelope(); SOAPBody sb = se.getBody();
 SOAPHeader sh = se.getHeader(); 

In addition to the mandatory SOAPPart object, a SOAPMessage object may contain zero or more AttachmentPart objects, each of which contains application-specific data. The SOAPMessage interface provides methods for creating AttachmentPart objects and also for adding them to a SOAPMessage object. A party that has received a SOAPMessage object can examine its contents by retrieving individual attachment parts.

Unlike the rest of a SOAP message, an attachment is not required to be in XML format and can therefore be anything from simple text to an image file. Consequently, any message content that is not in XML format must be in an AttachmentPart object.

A MessageFactory object creates new SOAPMessage objects. If the MessageFactory object was initialized with a messaging Profile, it produces SOAPMessage objects that conform to that Profile. For example, a SOAPMessage object created by a MessageFactory object initialized with the ebXML Profile will have the appropriate ebXML headers.


See Also:   MessageFactory
See Also:    MessageFactory
See Also:   AttachmentPart
See Also:    AttachmentPart


Field Summary
final public static  StringCHARACTER_SET_ENCODING
     Specifies the character type encoding for the SOAP Message.
final public static  StringWRITE_XML_DECLARATION
     Specifies whether the SOAP Message should contain an XML declaration.

Constructor Summary
public  SOAPMessage()
    

Method Summary
abstract public  voidaddAttachmentPart(AttachmentPart attachmentpart)
     Adds the given AttachmentPart object to this SOAPMessage object.
abstract public  intcountAttachments()
     Gets a count of the number of attachments in this message.
abstract public  AttachmentPartcreateAttachmentPart()
     Creates a new empty AttachmentPart object.
public  AttachmentPartcreateAttachmentPart(DataHandler datahandler)
     Creates an AttachmentPart object and populates it using the given DataHandler object.
public  AttachmentPartcreateAttachmentPart(Object content, String contentType)
     Creates an AttachmentPart object and populates it with the specified data of the specified content type.
abstract public  AttachmentPartgetAttachment(SOAPElement soapelement)
    
abstract public  IteratorgetAttachments()
     Retrieves all the AttachmentPart objects that are part of this SOAPMessage object.
abstract public  IteratorgetAttachments(MimeHeaders headers)
     Retrieves all the AttachmentPart objects that have header entries that match the specified headers.
abstract public  StringgetContentDescription()
     Retrieves a description of this SOAPMessage object's content.
abstract public  MimeHeadersgetMimeHeaders()
     Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion.
public  ObjectgetProperty(String property)
     Retrieves value of the specified property.
public  SOAPBodygetSOAPBody()
     Gets the SOAP Body contained in this SOAPMessage object.
public  SOAPHeadergetSOAPHeader()
     Gets the SOAP Header contained in this SOAPMessage object.
abstract public  SOAPPartgetSOAPPart()
     Gets the SOAP part of this SOAPMessage object.
abstract public  voidremoveAllAttachments()
     Removes all AttachmentPart objects that have been added to this SOAPMessage object.
abstract public  voidremoveAttachments(MimeHeaders mimeheaders)
    
abstract public  voidsaveChanges()
     Updates this SOAPMessage object with all the changes that have been made to it. This method is called automatically when a message is sent or written to by the methods ProviderConnection.send, SOAPConnection.call, or SOAPMessage.writeTo.
abstract public  booleansaveRequired()
     Indicates whether this SOAPMessage object has had the method saveChanges called on it.
abstract public  voidsetContentDescription(String description)
     Sets the description of this SOAPMessage object's content with the given description.
public  voidsetProperty(String property, Object value)
     Associates the specified value with the specified property.
abstract public  voidwriteTo(OutputStream out)
     Writes this SOAPMessage object to the given output stream.

Field Detail
CHARACTER_SET_ENCODING
final public static String CHARACTER_SET_ENCODING(Code)
Specifies the character type encoding for the SOAP Message.



WRITE_XML_DECLARATION
final public static String WRITE_XML_DECLARATION(Code)
Specifies whether the SOAP Message should contain an XML declaration.




Constructor Detail
SOAPMessage
public SOAPMessage()(Code)




Method Detail
addAttachmentPart
abstract public void addAttachmentPart(AttachmentPart attachmentpart)(Code)
Adds the given AttachmentPart object to this SOAPMessage object. An AttachmentPart object must be created before it can be added to a message.
Parameters:
  attachmentpart - an AttachmentPart object that is to become part of thisSOAPMessage object
throws:
  IllegalArgumentException -



countAttachments
abstract public int countAttachments()(Code)
Gets a count of the number of attachments in this message. This count does not include the SOAP part. the number of AttachmentPart objects that are part of thisSOAPMessage object



createAttachmentPart
abstract public AttachmentPart createAttachmentPart()(Code)
Creates a new empty AttachmentPart object. Note that the method addAttachmentPart must be called with this new AttachmentPart object as the parameter in order for it to become an attachment to this SOAPMessage object. a new AttachmentPart object that can be populated and added to thisSOAPMessage object



createAttachmentPart
public AttachmentPart createAttachmentPart(DataHandler datahandler)(Code)
Creates an AttachmentPart object and populates it using the given DataHandler object.
Parameters:
  datahandler - the javax.activation.DataHandler object that will generatethe content for this SOAPMessage object a new AttachmentPart object that contains data generated by the given DataHandler object
throws:
  IllegalArgumentException - if there was a problem with the specified DataHandler object
See Also:   DataHandler
See Also:    DataHandler
See Also:   javax.activation.DataContentHandler
See Also:    DataContentHandler



createAttachmentPart
public AttachmentPart createAttachmentPart(Object content, String contentType)(Code)
Creates an AttachmentPart object and populates it with the specified data of the specified content type.
Parameters:
  content - an Object containing the content for thisSOAPMessage object
Parameters:
  contentType - a String object giving the type of content; examples are"text/xml", "text/plain", and "image/jpeg" a new AttachmentPart object that contains the given data
throws:
  IllegalArgumentException - if the contentType does not match the type of the content object, or if there was no DataContentHandler object for the given content object
See Also:   DataHandler
See Also:    DataHandler
See Also:   javax.activation.DataContentHandler
See Also:    DataContentHandler



getAttachment
abstract public AttachmentPart getAttachment(SOAPElement soapelement) throws SOAPException(Code)



getAttachments
abstract public Iterator getAttachments()(Code)
Retrieves all the AttachmentPart objects that are part of this SOAPMessage object. an iterator over all the attachments in this message



getAttachments
abstract public Iterator getAttachments(MimeHeaders headers)(Code)
Retrieves all the AttachmentPart objects that have header entries that match the specified headers. Note that a returned attachment could have headers in addition to those specified.
Parameters:
  headers - a MimeHeaders object containing the MIME headers for which tosearch an iterator over all attachments that have a header that matches one of the givenheaders



getContentDescription
abstract public String getContentDescription()(Code)
Retrieves a description of this SOAPMessage object's content. a String describing the content of this message or null ifno description has been set
See Also:   SOAPMessage.setContentDescription(String)
See Also:    setContentDescription(java.lang.String)



getMimeHeaders
abstract public MimeHeaders getMimeHeaders()(Code)
Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion. a MimeHeaders object containing the MimeHeader objects



getProperty
public Object getProperty(String property) throws SOAPException(Code)
Retrieves value of the specified property.
Parameters:
  property - the name of the property to retrieve the value of the property or null if no such property exists
throws:
  SOAPException - if the property name is not recognized



getSOAPBody
public SOAPBody getSOAPBody() throws SOAPException(Code)
Gets the SOAP Body contained in this SOAPMessage object. the SOAPBody object contained by this SOAPMessage object
throws:
  SOAPException - if the SOAP Body does not exist or cannot be retrieved



getSOAPHeader
public SOAPHeader getSOAPHeader() throws SOAPException(Code)
Gets the SOAP Header contained in this SOAPMessage object. the SOAPHeader object contained by this SOAPMessage object
throws:
  SOAPException - if the SOAP Header does not exist or cannot be retrieved



getSOAPPart
abstract public SOAPPart getSOAPPart()(Code)
Gets the SOAP part of this SOAPMessage object.

If a SOAPMessage object contains one or more attachments, the SOAP Part must be the first MIME body part in the message.

the SOAPPart object for this SOAPMessage object



removeAllAttachments
abstract public void removeAllAttachments()(Code)
Removes all AttachmentPart objects that have been added to this SOAPMessage object.

This method does not touch the SOAP part.




removeAttachments
abstract public void removeAttachments(MimeHeaders mimeheaders)(Code)



saveChanges
abstract public void saveChanges() throws SOAPException(Code)
Updates this SOAPMessage object with all the changes that have been made to it. This method is called automatically when a message is sent or written to by the methods ProviderConnection.send, SOAPConnection.call, or SOAPMessage.writeTo. However, if changes are made to a message that was received or to one that has already been sent, the method saveChanges needs to be called explicitly in order to save the changes. The method saveChanges also generates any changes that can be read back (for example, a MessageId in profiles that support a message id). All MIME headers in a message that is created for sending purposes are guaranteed to have valid values only after saveChanges has been called.

In addition, this method marks the point at which the data from all constituent AttachmentPart objects are pulled into the message.


throws:
  SOAPException - if there was a problem saving changes to this message.



saveRequired
abstract public boolean saveRequired()(Code)
Indicates whether this SOAPMessage object has had the method saveChanges called on it. true if saveChanges has been called on this message atleast once; false otherwise.



setContentDescription
abstract public void setContentDescription(String description)(Code)
Sets the description of this SOAPMessage object's content with the given description.
Parameters:
  description - a String describing the content of this message
See Also:   SOAPMessage.getContentDescription()
See Also:    getContentDescription()



setProperty
public void setProperty(String property, Object value) throws SOAPException(Code)
Associates the specified value with the specified property. If there was already a value associated with this property, the old value is replaced.

The valid property names include WRITE_XML_DECLARATION and CHARACTER_SET_ENCODING. All of these standard SAAJ properties are prefixed by "javax.xml.soap". Vendors may also add implementation specific properties. These properties must be prefixed with package names that are unique to the vendor.

Setting the property WRITE_XML_DECLARATION to "true" will cause an XML Declaration to be written out at the start of the SOAP message. The default value of "false" suppresses this declaration.

The property CHARACTER_SET_ENCODING defaults to the value "utf-8" which causes the SOAP message to be encoded using UTF-8. Setting CHARACTER_SET_ENCODING to "utf-16" causes the SOAP message to be encoded using UTF-16.

Some implementations may allow encodings in addition to UTF-8 and UTF-16. Refer to your vendor's documentation for details.
Parameters:
  property - the property with which the specified value is to be associated
Parameters:
  value - the value to be associated with the specified property
throws:
  SOAPException - if the property name is not recognized




writeTo
abstract public void writeTo(OutputStream out) throws SOAPException, IOException(Code)
Writes this SOAPMessage object to the given output stream. The externalization format is as defined by the SOAP 1.1 with Attachments specification.

If there are no attachments, just an XML stream is written out. For those messages that have attachments, writeTo writes a MIME-encoded byte stream.


Parameters:
  out - the OutputStream object to which this SOAPMessage objectwill be written
throws:
  SOAPException - if there was a problem in externalizing this SOAP message
throws:
  IOException - if an I/O error occurs



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

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