Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/ws/LogicalMessage.java@f453f4eaf8b4 (annotated)
src/share/jaxws_classes/javax/xml/ws/LogicalMessage.java
Tue, 07 Nov 2017 18:54:04 -0800
- author
- asaha
- date
- Tue, 07 Nov 2017 18:54:04 -0800
- changeset 1528
- f453f4eaf8b4
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
Added tag jdk8u162-b06 for changeset 6095742f8034
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2005, 2010, 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 javax.xml.ws; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import javax.xml.transform.Source; |
| aoqi@0 | 29 | import javax.xml.bind.JAXBContext; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | /** The <code>LogicalMessage</code> interface represents a |
| aoqi@0 | 32 | * protocol agnostic XML message and contains methods that |
| aoqi@0 | 33 | * provide access to the payload of the message. |
| aoqi@0 | 34 | * |
| aoqi@0 | 35 | * @since JAX-WS 2.0 |
| aoqi@0 | 36 | **/ |
| aoqi@0 | 37 | public interface LogicalMessage { |
| aoqi@0 | 38 | |
| aoqi@0 | 39 | /** Gets the message payload as an XML source, may be called |
| aoqi@0 | 40 | * multiple times on the same LogicalMessage instance, always |
| aoqi@0 | 41 | * returns a new <code>Source</code> that may be used to retrieve the entire |
| aoqi@0 | 42 | * message payload. |
| aoqi@0 | 43 | * |
| aoqi@0 | 44 | * <p>If the returned <code>Source</code> is an instance of |
| aoqi@0 | 45 | * <code>DOMSource</code>, then |
| aoqi@0 | 46 | * modifications to the encapsulated DOM tree change the message |
| aoqi@0 | 47 | * payload in-place, there is no need to susequently call |
| aoqi@0 | 48 | * <code>setPayload</code>. Other types of <code>Source</code> provide only |
| aoqi@0 | 49 | * read access to the message payload. |
| aoqi@0 | 50 | * |
| aoqi@0 | 51 | * @return The contained message payload; returns <code>null</code> if no |
| aoqi@0 | 52 | * payload is present in this message. |
| aoqi@0 | 53 | **/ |
| aoqi@0 | 54 | public Source getPayload(); |
| aoqi@0 | 55 | |
| aoqi@0 | 56 | /** Sets the message payload |
| aoqi@0 | 57 | * |
| aoqi@0 | 58 | * @param payload message payload |
| aoqi@0 | 59 | * @throws WebServiceException If any error during the setting |
| aoqi@0 | 60 | * of the payload in this message |
| aoqi@0 | 61 | * @throws java.lang.UnsupportedOperationException If this |
| aoqi@0 | 62 | * operation is not supported |
| aoqi@0 | 63 | **/ |
| aoqi@0 | 64 | public void setPayload(Source payload); |
| aoqi@0 | 65 | |
| aoqi@0 | 66 | /** Gets the message payload as a JAXB object. Note that there is no |
| aoqi@0 | 67 | * connection between the returned object and the message payload, |
| aoqi@0 | 68 | * changes to the payload require calling <code>setPayload</code>. |
| aoqi@0 | 69 | * |
| aoqi@0 | 70 | * @param context The JAXBContext that should be used to unmarshall |
| aoqi@0 | 71 | * the message payload |
| aoqi@0 | 72 | * @return The contained message payload; returns <code>null</code> if no |
| aoqi@0 | 73 | * payload is present in this message |
| aoqi@0 | 74 | * @throws WebServiceException If an error occurs when using a supplied |
| aoqi@0 | 75 | * JAXBContext to unmarshall the payload. The cause of |
| aoqi@0 | 76 | * the WebServiceException is the original JAXBException. |
| aoqi@0 | 77 | **/ |
| aoqi@0 | 78 | public Object getPayload(JAXBContext context); |
| aoqi@0 | 79 | |
| aoqi@0 | 80 | /** Sets the message payload |
| aoqi@0 | 81 | * |
| aoqi@0 | 82 | * @param payload message payload |
| aoqi@0 | 83 | * @param context The JAXBContext that should be used to marshall |
| aoqi@0 | 84 | * the payload |
| aoqi@0 | 85 | * @throws java.lang.UnsupportedOperationException If this |
| aoqi@0 | 86 | * operation is not supported |
| aoqi@0 | 87 | * @throws WebServiceException If an error occurs when using the supplied |
| aoqi@0 | 88 | * JAXBContext to marshall the payload. The cause of |
| aoqi@0 | 89 | * the WebServiceException is the original JAXBException. |
| aoqi@0 | 90 | **/ |
| aoqi@0 | 91 | public void setPayload(Object payload, JAXBContext context); |
| aoqi@0 | 92 | } |
