325N/A/*
325N/A * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage javax.xml.ws;
325N/A
325N/Aimport javax.xml.transform.Source;
325N/Aimport javax.xml.bind.JAXBContext;
325N/A
325N/A/** The <code>LogicalMessage</code> interface represents a
325N/A * protocol agnostic XML message and contains methods that
325N/A * provide access to the payload of the message.
325N/A *
325N/A * @since JAX-WS 2.0
325N/A**/
325N/Apublic interface LogicalMessage {
325N/A
325N/A /** Gets the message payload as an XML source, may be called
325N/A * multiple times on the same LogicalMessage instance, always
325N/A * returns a new <code>Source</code> that may be used to retrieve the entire
325N/A * message payload.
325N/A *
325N/A * <p>If the returned <code>Source</code> is an instance of
325N/A * <code>DOMSource</code>, then
325N/A * modifications to the encapsulated DOM tree change the message
325N/A * payload in-place, there is no need to susequently call
325N/A * <code>setPayload</code>. Other types of <code>Source</code> provide only
325N/A * read access to the message payload.
325N/A *
325N/A * @return The contained message payload; returns <code>null</code> if no
325N/A * payload is present in this message.
325N/A **/
325N/A public Source getPayload();
325N/A
325N/A /** Sets the message payload
325N/A *
325N/A * @param payload message payload
325N/A * @throws WebServiceException If any error during the setting
325N/A * of the payload in this message
325N/A * @throws java.lang.UnsupportedOperationException If this
325N/A * operation is not supported
325N/A **/
325N/A public void setPayload(Source payload);
325N/A
325N/A /** Gets the message payload as a JAXB object. Note that there is no
325N/A * connection between the returned object and the message payload,
325N/A * changes to the payload require calling <code>setPayload</code>.
325N/A *
325N/A * @param context The JAXBContext that should be used to unmarshall
325N/A * the message payload
325N/A * @return The contained message payload; returns <code>null</code> if no
325N/A * payload is present in this message
325N/A * @throws WebServiceException If an error occurs when using a supplied
325N/A * JAXBContext to unmarshall the payload. The cause of
325N/A * the WebServiceException is the original JAXBException.
325N/A **/
325N/A public Object getPayload(JAXBContext context);
325N/A
325N/A /** Sets the message payload
325N/A *
325N/A * @param payload message payload
325N/A * @param context The JAXBContext that should be used to marshall
325N/A * the payload
325N/A * @throws java.lang.UnsupportedOperationException If this
325N/A * operation is not supported
325N/A * @throws WebServiceException If an error occurs when using the supplied
325N/A * JAXBContext to marshall the payload. The cause of
325N/A * the WebServiceException is the original JAXBException.
325N/A **/
325N/A public void setPayload(Object payload, JAXBContext context);
325N/A}