aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.oracle.webservices.internal.api.message;
aoqi@0: 
aoqi@0: import java.io.IOException;
aoqi@0: import java.io.OutputStream;
aoqi@0: import java.nio.ByteBuffer;
aoqi@0: import java.nio.channels.WritableByteChannel;
aoqi@0: 
aoqi@0: import javax.xml.soap.SOAPException;
aoqi@0: import javax.xml.soap.SOAPMessage;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * MessageContext represents a container of a SOAP message and all the properties
aoqi@0:  * including the transport headers.
aoqi@0:  *
aoqi@0:  * MessageContext is a composite {@link PropertySet} that combines properties exposed from multiple
aoqi@0:  * {@link PropertySet}s into one.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This implementation allows one {@link PropertySet} to assemble
aoqi@0:  * all properties exposed from other "satellite" {@link PropertySet}s.
aoqi@0:  * (A satellite may itself be a {@link DistributedPropertySet}, so
aoqi@0:  * in general this can form a tree.)
aoqi@0:  *
aoqi@0:  * @author shih-chang.chen@oracle.com
aoqi@0:  */
aoqi@0: public interface MessageContext extends DistributedPropertySet {
aoqi@0:     /**
aoqi@0:      * Gets the SAAJ SOAPMessage representation of the SOAP message.
aoqi@0:      *
aoqi@0:      * @return The SOAPMessage
aoqi@0:      */
aoqi@0:     SOAPMessage getAsSOAPMessage() throws SOAPException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets the SAAJ SOAPMessage representation of the SOAP message.
aoqi@0:      * @deprecated use getAsSOAPMessage
aoqi@0:      * @return The SOAPMessage
aoqi@0:      */
aoqi@0:     SOAPMessage getSOAPMessage() throws SOAPException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Writes the XML infoset portion of this MessageContext
aoqi@0:      * (from &lt;soap:Envelope> to &lt;/soap:Envelope>).
aoqi@0:      *
aoqi@0:      * @param out
aoqi@0:      *      Must not be null. The caller is responsible for closing the stream,
aoqi@0:      *      not the callee.
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      The MIME content type of the encoded message (such as "application/xml").
aoqi@0:      *      This information is often ncessary by transport.
aoqi@0:      *
aoqi@0:      * @throws IOException
aoqi@0:      *      if a {@link OutputStream} throws {@link IOException}.
aoqi@0:      */
aoqi@0:     ContentType writeTo( OutputStream out ) throws IOException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * The version of {@link #writeTo(OutputStream)}
aoqi@0:      * that writes to NIO {@link ByteBuffer}.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * TODO: for the convenience of implementation, write
aoqi@0:      * an adapter that wraps {@link WritableByteChannel} to {@link OutputStream}.
aoqi@0:      */
aoqi@0: //  ContentType writeTo( WritableByteChannel buffer );
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets the Content-type of this message. For an out-bound message that this getContentType()
aoqi@0:      * method returns a null, the Content-Type can be determined only by calling the writeTo
aoqi@0:      * method to write the MessageContext to an OutputStream.
aoqi@0:      *
aoqi@0:      * @return The MIME content type of this message
aoqi@0:      */
aoqi@0:     ContentType getContentType();
aoqi@0: }