|
1 /* |
|
2 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved. |
|
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
4 * |
|
5 * This code is free software; you can redistribute it and/or modify it |
|
6 * under the terms of the GNU General Public License version 2 only, as |
|
7 * published by the Free Software Foundation. Oracle designates this |
|
8 * particular file as subject to the "Classpath" exception as provided |
|
9 * by Oracle in the LICENSE file that accompanied this code. |
|
10 * |
|
11 * This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 * version 2 for more details (a copy is included in the LICENSE file that |
|
15 * accompanied this code). |
|
16 * |
|
17 * You should have received a copy of the GNU General Public License version |
|
18 * 2 along with this work; if not, write to the Free Software Foundation, |
|
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 * |
|
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 * or visit www.oracle.com if you need additional information or have any |
|
23 * questions. |
|
24 */ |
|
25 |
|
26 package com.sun.xml.internal.ws.api.message; |
|
27 |
|
28 import java.io.IOException; |
|
29 import java.io.OutputStream; |
|
30 |
|
31 import javax.xml.ws.soap.MTOMFeature; |
|
32 |
|
33 import com.oracle.webservices.internal.api.message.ContentType; |
|
34 |
|
35 /** |
|
36 * A Message implementation may implement this interface as an alternative way to write the |
|
37 * message into the OutputStream. |
|
38 * |
|
39 * @author shih-chang.chen@oracle.com |
|
40 */ |
|
41 public interface MessageWritable { |
|
42 |
|
43 /** |
|
44 * Gets the Content-type of this message. |
|
45 * |
|
46 * @return The MIME content type of this message |
|
47 */ |
|
48 ContentType getContentType(); |
|
49 |
|
50 /** |
|
51 * Writes the XML infoset portion of this MessageContext |
|
52 * (from <soap:Envelope> to </soap:Envelope>). |
|
53 * |
|
54 * @param out |
|
55 * Must not be null. The caller is responsible for closing the stream, |
|
56 * not the callee. |
|
57 * |
|
58 * @return |
|
59 * The MIME content type of this message (such as "application/xml"). |
|
60 * This information is often ncessary by transport. |
|
61 * |
|
62 * @throws IOException |
|
63 * if a {@link OutputStream} throws {@link IOException}. |
|
64 */ |
|
65 ContentType writeTo( OutputStream out ) throws IOException; |
|
66 |
|
67 /** |
|
68 * Passes configuration information to this message to ensure the proper |
|
69 * wire format is created. (from <soap:Envelope> to </soap:Envelope>). |
|
70 * |
|
71 * @param mtomFeature |
|
72 * The standard <code>WebServicesFeature</code> for specifying |
|
73 * the MTOM enablement and possibly threshold for the endpoint. |
|
74 * This value may be <code>null</code>. |
|
75 */ |
|
76 void setMTOMConfiguration(final MTOMFeature mtomFeature); |
|
77 } |