You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
108 lines
4.5 KiB
108 lines
4.5 KiB
5 years ago
|
/*
|
||
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
|
||
|
|
*
|
||
|
|
* Copyright (c) 2005-2017 Oracle and/or its affiliates. All rights reserved.
|
||
|
|
*
|
||
|
|
* The contents of this file are subject to the terms of either the GNU
|
||
|
|
* General Public License Version 2 only ("GPL") or the Common Development
|
||
|
|
* and Distribution License("CDDL") (collectively, the "License"). You
|
||
|
|
* may not use this file except in compliance with the License. You can
|
||
|
|
* obtain a copy of the License at
|
||
|
|
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
|
||
|
|
* or LICENSE.txt. See the License for the specific
|
||
|
|
* language governing permissions and limitations under the License.
|
||
|
|
*
|
||
|
|
* When distributing the software, include this License Header Notice in each
|
||
|
|
* file and include the License file at LICENSE.txt.
|
||
|
|
*
|
||
|
|
* GPL Classpath Exception:
|
||
|
|
* Oracle designates this particular file as subject to the "Classpath"
|
||
|
|
* exception as provided by Oracle in the GPL Version 2 section of the License
|
||
|
|
* file that accompanied this code.
|
||
|
|
*
|
||
|
|
* Modifications:
|
||
|
|
* If applicable, add the following below the License Header, with the fields
|
||
|
|
* enclosed by brackets [] replaced by your own identifying information:
|
||
|
|
* "Portions Copyright [year] [name of copyright owner]"
|
||
|
|
*
|
||
|
|
* Contributor(s):
|
||
|
|
* If you wish your version of this file to be governed by only the CDDL or
|
||
|
|
* only the GPL Version 2, indicate your decision by adding "[Contributor]
|
||
|
|
* elects to include this software in this distribution under the [CDDL or GPL
|
||
|
|
* Version 2] license." If you don't indicate a single choice of license, a
|
||
|
|
* recipient has the option to distribute your version of this file under
|
||
|
|
* either the CDDL, the GPL Version 2 or to extend the choice of license to
|
||
|
|
* its licensees as provided above. However, if you add GPL Version 2 code
|
||
|
|
* and therefore, elected the GPL Version 2 license, then the option applies
|
||
|
|
* only if the new code is made subject to such option by the copyright
|
||
|
|
* holder.
|
||
|
|
*/
|
||
|
|
|
||
|
|
package javax.xml.ws;
|
||
|
|
|
||
|
|
import javax.xml.transform.Source;
|
||
|
|
import javax.xml.bind.JAXBContext;
|
||
|
|
|
||
|
|
/** The {@code LogicalMessage} interface represents a
|
||
|
|
* protocol agnostic XML message and contains methods that
|
||
|
|
* provide access to the payload of the message.
|
||
|
|
*
|
||
|
|
* @since 1.6, JAX-WS 2.0
|
||
|
|
**/
|
||
|
|
public interface LogicalMessage {
|
||
|
|
|
||
|
|
/** Gets the message payload as an XML source, may be called
|
||
|
|
* multiple times on the same LogicalMessage instance, always
|
||
|
|
* returns a new {@code Source} that may be used to retrieve the entire
|
||
|
|
* message payload.
|
||
|
|
*
|
||
|
|
* <p>If the returned {@code Source} is an instance of
|
||
|
|
* {@code DOMSource}, then
|
||
|
|
* modifications to the encapsulated DOM tree change the message
|
||
|
|
* payload in-place, there is no need to susequently call
|
||
|
|
* {@code setPayload}. Other types of {@code Source} provide only
|
||
|
|
* read access to the message payload.
|
||
|
|
*
|
||
|
|
* @return The contained message payload; returns {@code null} if no
|
||
|
|
* payload is present in this message.
|
||
|
|
**/
|
||
|
|
public Source getPayload();
|
||
|
|
|
||
|
|
/** Sets the message payload
|
||
|
|
*
|
||
|
|
* @param payload message payload
|
||
|
|
* @throws WebServiceException If any error during the setting
|
||
|
|
* of the payload in this message
|
||
|
|
* @throws java.lang.UnsupportedOperationException If this
|
||
|
|
* operation is not supported
|
||
|
|
**/
|
||
|
|
public void setPayload(Source payload);
|
||
|
|
|
||
|
|
/** Gets the message payload as a JAXB object. Note that there is no
|
||
|
|
* connection between the returned object and the message payload,
|
||
|
|
* changes to the payload require calling {@code setPayload}.
|
||
|
|
*
|
||
|
|
* @param context The JAXBContext that should be used to unmarshall
|
||
|
|
* the message payload
|
||
|
|
* @return The contained message payload; returns {@code null} if no
|
||
|
|
* payload is present in this message
|
||
|
|
* @throws WebServiceException If an error occurs when using a supplied
|
||
|
|
* JAXBContext to unmarshall the payload. The cause of
|
||
|
|
* the WebServiceException is the original JAXBException.
|
||
|
|
**/
|
||
|
|
public Object getPayload(JAXBContext context);
|
||
|
|
|
||
|
|
/** Sets the message payload
|
||
|
|
*
|
||
|
|
* @param payload message payload
|
||
|
|
* @param context The JAXBContext that should be used to marshall
|
||
|
|
* the payload
|
||
|
|
* @throws java.lang.UnsupportedOperationException If this
|
||
|
|
* operation is not supported
|
||
|
|
* @throws WebServiceException If an error occurs when using the supplied
|
||
|
|
* JAXBContext to marshall the payload. The cause of
|
||
|
|
* the WebServiceException is the original JAXBException.
|
||
|
|
**/
|
||
|
|
public void setPayload(Object payload, JAXBContext context);
|
||
|
|
}
|