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