01 /*
02 * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.xml.ws;
27
28 import javax.xml.transform.Source;
29 import javax.xml.bind.JAXBContext;
30
31 /** The <code>LogicalMessage</code> interface represents a
32 * protocol agnostic XML message and contains methods that
33 * provide access to the payload of the message.
34 *
35 * @since JAX-WS 2.0
36 **/
37 public interface LogicalMessage {
38
39 /** Gets the message payload as an XML source, may be called
40 * multiple times on the same LogicalMessage instance, always
41 * returns a new Source that may be used to retrieve the entire
42 * message payload.
43 *
44 * <p>If the returned Source is an instance of DOMSource, then
45 * modifications to the encapsulated DOM tree change the message
46 * payload in-place, there is no need to susequently call
47 * <code>setPayload</code>. Other types of Source provide only
48 * read access to the message payload.
49 *
50 * @return The contained message payload; returns null if no
51 * payload is present in this message.
52 **/
53 public Source getPayload();
54
55 /** Sets the message payload
56 *
57 * @param payload message payload
58 * @throws WebServiceException If any error during the setting
59 * of the payload in this message
60 * @throws java.lang.UnsupportedOperationException If this
61 * operation is not supported
62 **/
63 public void setPayload(Source payload);
64
65 /** Gets the message payload as a JAXB object. Note that there is no
66 * connection between the returned object and the message payload,
67 * changes to the payload require calling <code>setPayload</code>.
68 *
69 * @param context The JAXBContext that should be used to unmarshall
70 * the message payload
71 * @return The contained message payload; returns null if no
72 * payload is present in this message
73 * @throws WebServiceException If an error occurs when using a supplied
74 * JAXBContext to unmarshall the payload. The cause of
75 * the WebServiceException is the original JAXBException.
76 **/
77 public Object getPayload(JAXBContext context);
78
79 /** Sets the message payload
80 *
81 * @param payload message payload
82 * @param context The JAXBContext that should be used to marshall
83 * the payload
84 * @throws java.lang.UnsupportedOperationException If this
85 * operation is not supported
86 * @throws WebServiceException If an error occurs when using the supplied
87 * JAXBContext to marshall the payload. The cause of
88 * the WebServiceException is the original JAXBException.
89 **/
90 public void setPayload(Object payload, JAXBContext context);
91 }
|