src/share/jaxws_classes/com/oracle/webservices/internal/api/message/MessageContext.java

Tue, 23 Apr 2013 18:33:20 -0700

author
katleman
date
Tue, 23 Apr 2013 18:33:20 -0700
changeset 374
72e03566f0a6
parent 368
0989ad8c0860
child 637
9c07ef4934dd
permissions
-rw-r--r--

8012643: JDK8 b86 source with GPL header errors
Reviewed-by: dholmes, alanb

alanb@368 1 /*
katleman@374 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
katleman@374 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
alanb@368 4 *
katleman@374 5 * This code is free software; you can redistribute it and/or modify it
katleman@374 6 * under the terms of the GNU General Public License version 2 only, as
katleman@374 7 * published by the Free Software Foundation. Oracle designates this
katleman@374 8 * particular file as subject to the "Classpath" exception as provided
katleman@374 9 * by Oracle in the LICENSE file that accompanied this code.
alanb@368 10 *
katleman@374 11 * This code is distributed in the hope that it will be useful, but WITHOUT
katleman@374 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
katleman@374 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
katleman@374 14 * version 2 for more details (a copy is included in the LICENSE file that
katleman@374 15 * accompanied this code).
alanb@368 16 *
katleman@374 17 * You should have received a copy of the GNU General Public License version
katleman@374 18 * 2 along with this work; if not, write to the Free Software Foundation,
katleman@374 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
alanb@368 20 *
katleman@374 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
katleman@374 22 * or visit www.oracle.com if you need additional information or have any
katleman@374 23 * questions.
alanb@368 24 */
alanb@368 25
alanb@368 26 package com.oracle.webservices.internal.api.message;
alanb@368 27
alanb@368 28 import java.io.IOException;
alanb@368 29 import java.io.OutputStream;
alanb@368 30 import java.nio.ByteBuffer;
alanb@368 31 import java.nio.channels.WritableByteChannel;
alanb@368 32
alanb@368 33 import javax.xml.soap.SOAPException;
alanb@368 34 import javax.xml.soap.SOAPMessage;
alanb@368 35
alanb@368 36 /**
alanb@368 37 * MessageContext represents a container of a SOAP message and all the properties
alanb@368 38 * including the transport headers.
alanb@368 39 *
alanb@368 40 * MessageContext is a composite {@link PropertySet} that combines properties exposed from multiple
alanb@368 41 * {@link PropertySet}s into one.
alanb@368 42 *
alanb@368 43 * <p>
alanb@368 44 * This implementation allows one {@link PropertySet} to assemble
alanb@368 45 * all properties exposed from other "satellite" {@link PropertySet}s.
alanb@368 46 * (A satellite may itself be a {@link DistributedPropertySet}, so
alanb@368 47 * in general this can form a tree.)
alanb@368 48 *
alanb@368 49 * @author shih-chang.chen@oracle.com
alanb@368 50 */
alanb@368 51 public interface MessageContext extends DistributedPropertySet {
alanb@368 52 /**
alanb@368 53 * Gets the SAAJ SOAPMessage representation of the SOAP message.
alanb@368 54 *
alanb@368 55 * @return The SOAPMessage
alanb@368 56 */
alanb@368 57 SOAPMessage getAsSOAPMessage() throws SOAPException;
alanb@368 58
alanb@368 59 /**
alanb@368 60 * Gets the SAAJ SOAPMessage representation of the SOAP message.
alanb@368 61 * @deprecated use getAsSOAPMessage
alanb@368 62 * @return The SOAPMessage
alanb@368 63 */
alanb@368 64 SOAPMessage getSOAPMessage() throws SOAPException;
alanb@368 65
alanb@368 66 /**
alanb@368 67 * Writes the XML infoset portion of this MessageContext
alanb@368 68 * (from &lt;soap:Envelope> to &lt;/soap:Envelope>).
alanb@368 69 *
alanb@368 70 * @param out
alanb@368 71 * Must not be null. The caller is responsible for closing the stream,
alanb@368 72 * not the callee.
alanb@368 73 *
alanb@368 74 * @return
alanb@368 75 * The MIME content type of the encoded message (such as "application/xml").
alanb@368 76 * This information is often ncessary by transport.
alanb@368 77 *
alanb@368 78 * @throws IOException
alanb@368 79 * if a {@link OutputStream} throws {@link IOException}.
alanb@368 80 */
alanb@368 81 ContentType writeTo( OutputStream out ) throws IOException;
alanb@368 82
alanb@368 83 /**
alanb@368 84 * The version of {@link #writeTo(OutputStream)}
alanb@368 85 * that writes to NIO {@link ByteBuffer}.
alanb@368 86 *
alanb@368 87 * <p>
alanb@368 88 * TODO: for the convenience of implementation, write
alanb@368 89 * an adapter that wraps {@link WritableByteChannel} to {@link OutputStream}.
alanb@368 90 */
alanb@368 91 // ContentType writeTo( WritableByteChannel buffer );
alanb@368 92
alanb@368 93 /**
alanb@368 94 * Gets the Content-type of this message. For an out-bound message that this getContentType()
alanb@368 95 * method returns a null, the Content-Type can be determined only by calling the writeTo
alanb@368 96 * method to write the MessageContext to an OutputStream.
alanb@368 97 *
alanb@368 98 * @return The MIME content type of this message
alanb@368 99 */
alanb@368 100 ContentType getContentType();
alanb@368 101 }

mercurial