Java Doc for SOAPMessageImpl.java in » Web-Services-AXIS2 » saaj » org » apache » axis2 » saaj » 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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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 » org.apache.axis2.saaj

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

javax.xml.soap .SOAPMessage

org.apache.axis2.saaj .SOAPMessageImpl

SOAPMessageImpl
public class SOAPMessageImpl extends SOAPMessage (Code)

Constructor Summary
public	SOAPMessageImpl(SOAPEnvelopeImpl soapEnvelope)
public	SOAPMessageImpl(InputStream inputstream, javax.xml.soap.MimeHeaders mimeHeaders)

Method Summary
public void	addAttachmentPart(AttachmentPart attachmentPart) Adds the given `AttachmentPart` object to this `SOAPMessage` object.
public int	countAttachments() Gets a count of the number of attachments in this message.
public AttachmentPart	createAttachmentPart() Creates a new empty `AttachmentPart` object.
public AttachmentPart	getAttachment(SOAPElement soapelement) Returns an AttachmentPart object that is associated with an attachment that is referenced by this SOAPElement or null if no such attachment exists.
public Iterator	getAttachments() Retrieves all the `AttachmentPart` objects that are part of this `SOAPMessage` object.
public Iterator	getAttachments(javax.xml.soap.MimeHeaders headers) Retrieves all the AttachmentPart objects that have header entries that match the specified headers.
public String	getContentDescription() Retrieves a description of this `SOAPMessage` object's content.
public javax.xml.soap.MimeHeaders	getMimeHeaders() Returns all the transport-specific MIME headers for this `SOAPMessage` object in a transport-independent fashion.
public Object	getProperty(String property) Retrieves value of the specified property.
public SOAPBody	getSOAPBody() Gets the SOAP Body contained in this `SOAPMessage` object.
public SOAPHeader	getSOAPHeader() Gets the SOAP Header contained in this `SOAPMessage` object.
public SOAPPart	getSOAPPart() Gets the SOAP part of this `SOAPMessage` object.
public void	removeAllAttachments() Removes all `AttachmentPart` objects that have been added to this `SOAPMessage` object.
public void	removeAttachments(MimeHeaders headers) Removes all the AttachmentPart objects that have header entries that match the specified headers.
public void	saveChanges() 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`.
public boolean	saveRequired() Indicates whether this `SOAPMessage` object has had the method SOAPMessageImpl.saveChanges() called on it.
public void	setContentDescription(String description) Sets the description of this `SOAPMessage` object's content with the given description.
public void	setProperty(String property, Object value) Associates the specified value with the specified property.
public void	setSaveRequired()
public void	writeTo(OutputStream out) Writes this `SOAPMessage` object to the given output stream.

Constructor Detail

SOAPMessageImpl
public SOAPMessageImpl(SOAPEnvelopeImpl soapEnvelope)(Code)

SOAPMessageImpl
public SOAPMessageImpl(InputStream inputstream, javax.xml.soap.MimeHeaders mimeHeaders) throws SOAPException(Code)

Method Detail

addAttachmentPart
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 this`SOAPMessage` object throws: IllegalArgumentException -

countAttachments
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 this`SOAPMessage` object

createAttachmentPart
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 this`SOAPMessage` object

getAttachment
public AttachmentPart getAttachment(SOAPElement soapelement) throws SOAPException(Code)
	Returns an AttachmentPart object that is associated with an attachment that is referenced by this SOAPElement or null if no such attachment exists. References can be made via an href attribute as described in SOAP Messages with Attachments (http://www.w3.org/TR/SOAPattachments#SOAPReferenceToAttachements) , or via a single Text child node containing a URI as described in the WS-I Attachments Profile 1.0 for elements of schema type ref:swaRef(ref:swaRef (http://www.wsi.org/Profiles/AttachmentsProfile-1.0-2004-08-24.html") ). These two mechanisms must be supported. The support for references via href attribute also implies that this method should also be supported on an element that is an xop:Include element (XOP (http://www.w3.org/2000/xp/Group/3/06/Attachments/XOP.html) ). other reference mechanisms may be supported by individual implementations of this standard. Contact your vendor for details. Parameters: element - - The SOAPElement containing the reference to an Attachment the referenced AttachmentPart or null if no such AttachmentPart exists or noreference can be found in this SOAPElement. throws: SOAPException - - if there is an error in the attempt to access the attachment

getAttachments
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
public Iterator getAttachments(javax.xml.soap.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 javax.xml.soap.MimeHeaders object containing the MIME headers forwhich to search an iterator over all attachments(javax.xml.soap.AttachmentPart) that have aheader that matches one of the given headers

getContentDescription
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: SOAPMessageImpl.setContentDescription(String) See Also: setContentDescription(java.lang.String)

getMimeHeaders
public javax.xml.soap.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: javax.xml.soap.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: javax.xml.soap.SOAPException - if the SOAP Header does not exist or cannot beretrieved

getSOAPPart

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

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
public void removeAttachments(MimeHeaders headers)(Code)
	Removes all the AttachmentPart objects that have header entries that match the specified headers. Note that the removed attachment could have headers in addition to those specified. Parameters: headers - - a MimeHeaders object containing the MIME headers for which to search since: SAAJ 1.3

saveChanges

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
public boolean saveRequired()(Code)
	Indicates whether this `SOAPMessage` object has had the method SOAPMessageImpl.saveChanges() called on it. `true` if `saveChanges` has been called on this message atleast once; `false` otherwise.

setContentDescription
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: SOAPMessageImpl.getContentDescription() See Also: getContentDescription()

setProperty

public void setProperty(String property, Object value)(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

setSaveRequired
public void setSaveRequired()(Code)

writeTo

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

Fields inherited from javax.xml.soap.SOAPMessage

final public static String CHARACTER_SET_ENCODING(Code)(Java Doc)
final public static String WRITE_XML_DECLARATION(Code)(Java Doc)

Methods inherited from javax.xml.soap.SOAPMessage

abstract public void addAttachmentPart(AttachmentPart AttachmentPart)(Code)(Java Doc)
abstract public int countAttachments()(Code)(Java Doc)
abstract public AttachmentPart createAttachmentPart()(Code)(Java Doc)
public AttachmentPart createAttachmentPart(DataHandler dataHandler)(Code)(Java Doc)
public AttachmentPart createAttachmentPart(Object content, String contentType)(Code)(Java Doc)
abstract public AttachmentPart getAttachment(SOAPElement element) throws SOAPException(Code)(Java Doc)
abstract public Iterator getAttachments()(Code)(Java Doc)
abstract public Iterator getAttachments(MimeHeaders headers)(Code)(Java Doc)
abstract public String getContentDescription()(Code)(Java Doc)
abstract public MimeHeaders getMimeHeaders()(Code)(Java Doc)
public Object getProperty(String property) throws SOAPException(Code)(Java Doc)
public SOAPBody getSOAPBody() throws SOAPException(Code)(Java Doc)
public SOAPHeader getSOAPHeader() throws SOAPException(Code)(Java Doc)
abstract public SOAPPart getSOAPPart()(Code)(Java Doc)
abstract public void removeAllAttachments()(Code)(Java Doc)
abstract public void removeAttachments(MimeHeaders headers)(Code)(Java Doc)
abstract public void saveChanges() throws SOAPException(Code)(Java Doc)
abstract public boolean saveRequired()(Code)(Java Doc)
abstract public void setContentDescription(String description)(Code)(Java Doc)
public void setProperty(String property, Object value) throws SOAPException(Code)(Java Doc)
abstract public void writeTo(OutputStream out) throws SOAPException, IOException(Code)(Java Doc)

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

All other trademarks are property of their respective owners.