Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/ws/api/handler/MessageHandlerContext.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/com/sun/xml/internal/ws/api/handler/MessageHandlerContext.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 368
- 0989ad8c0860
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2012, 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 com.sun.xml.internal.ws.api.handler; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import com.sun.istack.internal.Nullable; |
| aoqi@0 | 29 | import com.sun.xml.internal.ws.api.WSBinding; |
| aoqi@0 | 30 | import com.sun.xml.internal.ws.api.message.Message; |
| aoqi@0 | 31 | import com.sun.xml.internal.ws.api.model.SEIModel; |
| aoqi@0 | 32 | import com.sun.xml.internal.ws.api.model.wsdl.WSDLPort; |
| aoqi@0 | 33 | |
| aoqi@0 | 34 | import javax.xml.ws.handler.MessageContext; |
| aoqi@0 | 35 | import java.util.Set; |
| aoqi@0 | 36 | |
| aoqi@0 | 37 | /** |
| aoqi@0 | 38 | * The <code>MessageHandlerContext</code> interface extends |
| aoqi@0 | 39 | * <code>MessageContext</code> to provide easy access to the contained message. |
| aoqi@0 | 40 | * |
| aoqi@0 | 41 | * This context provides access to RI's <code>Message</code> model for efficient access |
| aoqi@0 | 42 | * to various things like accessing headers etc. It also provides access to |
| aoqi@0 | 43 | * binding information as <code>WSBinding</code>. |
| aoqi@0 | 44 | * |
| aoqi@0 | 45 | * @author Rama Pulavarthi |
| aoqi@0 | 46 | * @since JAX-WS 2.1.3 |
| aoqi@0 | 47 | */ |
| aoqi@0 | 48 | public interface MessageHandlerContext extends MessageContext { |
| aoqi@0 | 49 | /** |
| aoqi@0 | 50 | * Gets the message from this message context |
| aoqi@0 | 51 | * |
| aoqi@0 | 52 | * @return The contained message; returns <code>null</code> if no |
| aoqi@0 | 53 | * message is present in this message context |
| aoqi@0 | 54 | */ |
| aoqi@0 | 55 | public Message getMessage(); |
| aoqi@0 | 56 | |
| aoqi@0 | 57 | |
| aoqi@0 | 58 | /** |
| aoqi@0 | 59 | * Sets the message in this message context |
| aoqi@0 | 60 | */ |
| aoqi@0 | 61 | public void setMessage(Message message); |
| aoqi@0 | 62 | |
| aoqi@0 | 63 | /** |
| aoqi@0 | 64 | * @see javax.xml.ws.handler.soap.SOAPMessageContext#getRoles() |
| aoqi@0 | 65 | */ |
| aoqi@0 | 66 | public Set<String> getRoles(); |
| aoqi@0 | 67 | |
| aoqi@0 | 68 | |
| aoqi@0 | 69 | /** |
| aoqi@0 | 70 | * Provides access to <code>WSBinding</code> which can be used in various ways. |
| aoqi@0 | 71 | * for example: <code>WSBinding#getSOAPVersion</code> to get SOAP version of the binding. |
| aoqi@0 | 72 | * <code>WSBinding#isFeatureEnabled(AddressingFeature)</code> to check if addressing is enabled |
| aoqi@0 | 73 | */ |
| aoqi@0 | 74 | public WSBinding getWSBinding(); |
| aoqi@0 | 75 | |
| aoqi@0 | 76 | /** |
| aoqi@0 | 77 | * Provides access to <code>SEIModel</code>. |
| aoqi@0 | 78 | */ |
| aoqi@0 | 79 | public @Nullable SEIModel getSEIModel(); |
| aoqi@0 | 80 | |
| aoqi@0 | 81 | /** |
| aoqi@0 | 82 | * Gets the {@link WSDLPort} that represents the port. |
| aoqi@0 | 83 | * @return |
| aoqi@0 | 84 | * returns the WSDLModel of the port that the client/endpoint binds to. |
| aoqi@0 | 85 | * null when the Service is not configured with WSDL information. |
| aoqi@0 | 86 | */ |
| aoqi@0 | 87 | public @Nullable WSDLPort getPort(); |
| aoqi@0 | 88 | |
| aoqi@0 | 89 | } |
