Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.axis
Class Message  view Message download Message.java

java.lang.Object
  extended byjavax.xml.soap.SOAPMessage
      extended byorg.apache.axis.Message
All Implemented Interfaces:
java.io.Serializable

public class Message
extends javax.xml.soap.SOAPMessage
implements java.io.Serializable

A complete SOAP (and/or XML-RPC, eventually) message. Includes both the root part (as a SOAPPart), and zero or more MIME attachments (as AttachmentParts).

Eventually should be refactored to generalize SOAPPart for multiple protocols (XML-RPC?).


Field Summary
private static java.lang.Class attachImpl
           
private static boolean attachmentSupportEnabled
           
private static boolean checkForAttachmentSupport
           
static java.lang.String DEFAULT_ATTACHMNET_IMPL
          Default Attachments Implementation class.
private  org.apache.axis.message.MimeHeaders headers
           
protected static org.apache.commons.logging.Log log
          The Log that this class uses for logging all messages.
private  org.apache.axis.attachments.Attachments mAttachments
          This Message's Attachments object, which manages the attachments contained in this Message.
private static java.lang.String mAttachmentsImplClassName
          Current Attachment implementation.
private  java.lang.String messageType
          The messageType indicates whether this is request or response.
static java.lang.String MIME_APPLICATION_DIME
          DIME parts defined for messages.
static java.lang.String MIME_MULTIPART_RELATED
          MIME parts defined for messages.
static java.lang.String MIME_UNKNOWN
          Look at the input stream to find the headers to decide the mime type.
private  java.util.Hashtable mProps
           
private  MessageContext msgContext
           
private  SOAPPart mSOAPPart
          This Message's SOAPPart.
static java.lang.String REQUEST
          Message is a request.
static java.lang.String RESPONSE
          Message is a a response.
private  boolean saveRequired
           
 
Fields inherited from class javax.xml.soap.SOAPMessage
CHARACTER_SET_ENCODING, WRITE_XML_DECLARATION
 
Constructor Summary
Message(java.lang.Object initialContents)
          Construct a Message.
Message(java.lang.Object initialContents, boolean bodyInStream)
          Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.
Message(java.lang.Object initialContents, boolean bodyInStream, javax.xml.soap.MimeHeaders headers)
          Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.
Message(java.lang.Object initialContents, boolean bodyInStream, java.lang.String contentType, java.lang.String contentLocation)
          Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.
Message(java.lang.Object initialContents, org.apache.axis.message.MimeHeaders headers)
          Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.
 
Method Summary
 void addAttachmentPart(javax.xml.soap.AttachmentPart attachmentpart)
          Adds the given AttachmentPart object to this SOAPMessage object.
 int countAttachments()
          Gets a count of the number of attachments in this message.
 javax.xml.soap.AttachmentPart createAttachmentPart()
          Creates a new empty AttachmentPart object.
 void dispose()
          Dispose of attachments.
static java.lang.String getAttachmentImplClassName()
          Returns the name of the class prividing Attachment Implementation.
 java.util.Iterator getAttachments()
          Retrieves all the AttachmentPart objects that are part of this SOAPMessage object.
 java.util.Iterator getAttachments(javax.xml.soap.MimeHeaders headers)
          Retrieves all the AttachmentPart objects that have header entries that match the specified headers.
 org.apache.axis.attachments.Attachments getAttachmentsImpl()
          Get the Attachments of this Message.
 java.lang.String getContentDescription()
          Retrieves a description of this SOAPMessage object's content.
 long getContentLength()
          Get the content length, including both soap and any attachments.
 java.lang.String getContentType(org.apache.axis.soap.SOAPConstants sc)
          Get the content type of the attachments.
 MessageContext getMessageContext()
          Get the context associated with this message.
 java.lang.String getMessageType()
          Get the message type.
 javax.xml.soap.MimeHeaders getMimeHeaders()
          Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion.
 java.lang.Object getProperty(java.lang.String property)
          Retrieves value of the specified property.
private  int getSendType()
           
 javax.xml.soap.SOAPBody getSOAPBody()
          Gets the SOAP Body contained in this SOAPMessage object.
 org.apache.axis.message.SOAPEnvelope getSOAPEnvelope()
          Get this message's SOAPPart as a SOAPEnvelope.
 javax.xml.soap.SOAPHeader getSOAPHeader()
          Gets the SOAP Header contained in this SOAPMessage object.
 javax.xml.soap.SOAPPart getSOAPPart()
          Get this message's SOAPPart.
 byte[] getSOAPPartAsBytes()
          Get a byte array representation of this message's SOAPPart.
 java.lang.String getSOAPPartAsString()
          Get a string representation of this message's SOAPPart.
private static boolean isAttachmentSupportEnabled(MessageContext mc)
           
 void removeAllAttachments()
          Removes all AttachmentPart objects that have been added to this SOAPMessage object.
 void saveChanges()
          Updates this SOAPMessage object with all the changes that have been made to it.
 boolean saveRequired()
          Indicates whether this SOAPMessage object has had the method saveChanges called on it.
 void setContentDescription(java.lang.String description)
          Sets the description of this SOAPMessage object's content with the given description.
 void setMessageContext(MessageContext msgContext)
          Set the context associated with this message.
 void setMessageType(java.lang.String messageType)
          Set the message type.
 void setProperty(java.lang.String property, java.lang.Object value)
          Associates the specified value with the specified property.
private  void setup(java.lang.Object initialContents, boolean bodyInStream, java.lang.String contentType, java.lang.String contentLocation, javax.xml.soap.MimeHeaders mimeHeaders)
          Do the work of construction.
 void writeTo(java.io.OutputStream os)
          Writes this SOAPMessage object to the given output stream.
 
Methods inherited from class javax.xml.soap.SOAPMessage
createAttachmentPart, createAttachmentPart
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected static org.apache.commons.logging.Log log
The Log that this class uses for logging all messages.


REQUEST

public static final java.lang.String REQUEST
Message is a request.

See Also:
Constant Field Values

RESPONSE

public static final java.lang.String RESPONSE
Message is a a response.

See Also:
Constant Field Values

MIME_MULTIPART_RELATED

public static final java.lang.String MIME_MULTIPART_RELATED
MIME parts defined for messages.

See Also:
Constant Field Values

MIME_APPLICATION_DIME

public static final java.lang.String MIME_APPLICATION_DIME
DIME parts defined for messages.

See Also:
Constant Field Values

DEFAULT_ATTACHMNET_IMPL

public static final java.lang.String DEFAULT_ATTACHMNET_IMPL
Default Attachments Implementation class.

See Also:
Constant Field Values

mAttachmentsImplClassName

private static java.lang.String mAttachmentsImplClassName
Current Attachment implementation.


MIME_UNKNOWN

public static final java.lang.String MIME_UNKNOWN
Look at the input stream to find the headers to decide the mime type.

See Also:
Constant Field Values

messageType

private java.lang.String messageType
The messageType indicates whether this is request or response.


mSOAPPart

private SOAPPart mSOAPPart
This Message's SOAPPart. Will always be here.


mAttachments

private org.apache.axis.attachments.Attachments mAttachments
This Message's Attachments object, which manages the attachments contained in this Message.


headers

private org.apache.axis.message.MimeHeaders headers

saveRequired

private boolean saveRequired

msgContext

private MessageContext msgContext

attachImpl

private static java.lang.Class attachImpl

checkForAttachmentSupport

private static boolean checkForAttachmentSupport

attachmentSupportEnabled

private static boolean attachmentSupportEnabled

mProps

private java.util.Hashtable mProps
Constructor Detail

Message

public Message(java.lang.Object initialContents,
               boolean bodyInStream)
Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.

Eventually, genericize this to return the RootPart instead, which will have some kind of EnvelopeFactory to enable support for things other than SOAP. But that all will come later, with lots of additional refactoring.


Message

public Message(java.lang.Object initialContents,
               boolean bodyInStream,
               javax.xml.soap.MimeHeaders headers)
Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.

Eventually, genericize this to return the RootPart instead, which will have some kind of EnvelopeFactory to enable support for things other than SOAP. But that all will come later, with lots of additional refactoring.


Message

public Message(java.lang.Object initialContents,
               org.apache.axis.message.MimeHeaders headers)
Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.

Eventually, genericize this to return the RootPart instead, which will have some kind of EnvelopeFactory to enable support for things other than SOAP. But that all will come later, with lots of additional refactoring.


Message

public Message(java.lang.Object initialContents,
               boolean bodyInStream,
               java.lang.String contentType,
               java.lang.String contentLocation)
Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.

Eventually, genericize this to return the RootPart instead, which will have some kind of EnvelopeFactory to enable support for things other than SOAP. But that all will come later, with lots of additional refactoring.


Message

public Message(java.lang.Object initialContents)
Construct a Message. An overload of Message(Object, boolean), defaulting bodyInStream to false.

Method Detail

getAttachmentImplClassName

public static java.lang.String getAttachmentImplClassName()
Returns the name of the class prividing Attachment Implementation.


getMessageType

public java.lang.String getMessageType()
Get the message type.


setMessageType

public void setMessageType(java.lang.String messageType)
Set the message type.


getMessageContext

public MessageContext getMessageContext()
Get the context associated with this message.


setMessageContext

public void setMessageContext(MessageContext msgContext)
Set the context associated with this message.


isAttachmentSupportEnabled

private static boolean isAttachmentSupportEnabled(MessageContext mc)

setup

private void setup(java.lang.Object initialContents,
                   boolean bodyInStream,
                   java.lang.String contentType,
                   java.lang.String contentLocation,
                   javax.xml.soap.MimeHeaders mimeHeaders)
Do the work of construction.


getSOAPPart

public javax.xml.soap.SOAPPart getSOAPPart()
Get this message's SOAPPart.

Eventually, this should be generalized beyond just SOAP, but it's hard to know how to do that without necessitating a lot of casts in client code. Refactoring keeps getting easier anyhow.


getSOAPPartAsString

public java.lang.String getSOAPPartAsString()
                                     throws AxisFault
Get a string representation of this message's SOAPPart.


getSOAPPartAsBytes

public byte[] getSOAPPartAsBytes()
                          throws AxisFault
Get a byte array representation of this message's SOAPPart.


getSOAPEnvelope

public org.apache.axis.message.SOAPEnvelope getSOAPEnvelope()
                                                     throws AxisFault
Get this message's SOAPPart as a SOAPEnvelope.


getAttachmentsImpl

public org.apache.axis.attachments.Attachments getAttachmentsImpl()
Get the Attachments of this Message.

If this returns null, then NO ATTACHMENT SUPPORT EXISTS in this configuration of Axis, and no attachment operations may be performed.


getContentType

public java.lang.String getContentType(org.apache.axis.soap.SOAPConstants sc)
                                throws AxisFault
Get the content type of the attachments.


getSendType

private int getSendType()

getContentLength

public long getContentLength()
                      throws AxisFault
Get the content length, including both soap and any attachments.


writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.soap.SOAPException,
                    java.io.IOException
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.


getSOAPBody

public javax.xml.soap.SOAPBody getSOAPBody()
                                    throws javax.xml.soap.SOAPException
Description copied from class: javax.xml.soap.SOAPMessage
Gets the SOAP Body contained in this SOAPMessage object.


getSOAPHeader

public javax.xml.soap.SOAPHeader getSOAPHeader()
                                        throws javax.xml.soap.SOAPException
Description copied from class: javax.xml.soap.SOAPMessage
Gets the SOAP Header contained in this SOAPMessage object.


setProperty

public void setProperty(java.lang.String property,
                        java.lang.Object value)
                 throws javax.xml.soap.SOAPException
Description copied from class: javax.xml.soap.SOAPMessage
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.


getProperty

public java.lang.Object getProperty(java.lang.String property)
                             throws javax.xml.soap.SOAPException
Description copied from class: javax.xml.soap.SOAPMessage
Retrieves value of the specified property.


getContentDescription

public java.lang.String getContentDescription()
Retrieves a description of this SOAPMessage object's content.


setContentDescription

public void setContentDescription(java.lang.String description)
Sets the description of this SOAPMessage object's content with the given description.


saveChanges

public void saveChanges()
                 throws javax.xml.soap.SOAPException
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.


saveRequired

public boolean saveRequired()
Indicates whether this SOAPMessage object has had the method saveChanges called on it.


getMimeHeaders

public javax.xml.soap.MimeHeaders getMimeHeaders()
Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion.


removeAllAttachments

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

This method does not touch the SOAP part.


countAttachments

public int countAttachments()
Gets a count of the number of attachments in this message. This count does not include the SOAP part.


getAttachments

public java.util.Iterator getAttachments()
Retrieves all the AttachmentPart objects that are part of this SOAPMessage object.


getAttachments

public java.util.Iterator getAttachments(javax.xml.soap.MimeHeaders headers)
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.


addAttachmentPart

public void addAttachmentPart(javax.xml.soap.AttachmentPart attachmentpart)
Adds the given AttachmentPart object to this SOAPMessage object. An AttachmentPart object must be created before it can be added to a message.


createAttachmentPart

public javax.xml.soap.AttachmentPart createAttachmentPart()
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.


dispose

public void dispose()
Dispose of attachments.