modules/jaxws/src/org/apache/axis2/jaxws/message/Message.java

/*
 * Copyright 2004,2005 The Apache Software Foundation.
 * Copyright 2006 International Business Machines Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.axis2.jaxws.message;

import java.util.List;

import javax.xml.soap.SOAPMessage;

/**
 * Message
 * 
 * A Message represents the XML + Attachments
 * 
 * Most of the methods available on a message are only applicable to 
 * the XML part of the Message.  See the XMLPart interface for an explantation of these methods.
 * 
 * @see org.apache.axis2.jaxws.message.XMLPart
 * @see org.apache.axis2.jaxws.message.Attachment
 * 
 */
public interface Message extends XMLPart {
	
	/**
	 * Get the protocol for this Message (soap11, soap12, etc.)
	 * @return Protocl
	 */
	public Protocol getProtocol();
	
	/**
	 * getAsSOAPMessage
	 * Get the xml part as a read/write SOAPEnvelope
	 * @return SOAPEnvelope
	 */
	public SOAPMessage getAsSOAPMessage() throws MessageException;
	
    /**
     * Adds an attachment part to the message
     * @param Attachment - the content to add
     */
	public void addAttachment(Attachment a);
    
    /**
	 * Get the list of attachments for the message
	 * @return List<Attachments>
	 */
	public List<Attachment> getAttachments();
    
    /**
     * Get the attachment identified by the contentID 
     * @param cid
     * @return
     */
    public Attachment getAttachment(String cid);
    
    public boolean isMTOMEnabled();
    
    public void setMTOMEnabled(boolean b);
	
}