Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/ws/api/model/wsdl/WSDLOperation.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/com/sun/xml/internal/ws/api/model/wsdl/WSDLOperation.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 408
- b0610cd08440
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2013, 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.model.wsdl; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import com.sun.xml.internal.ws.api.model.wsdl.WSDLExtensible; |
| aoqi@0 | 29 | import com.sun.istack.internal.NotNull; |
| aoqi@0 | 30 | import com.sun.istack.internal.Nullable; |
| aoqi@0 | 31 | |
| aoqi@0 | 32 | import javax.xml.namespace.QName; |
| aoqi@0 | 33 | |
| aoqi@0 | 34 | /** |
| aoqi@0 | 35 | * Provides abstraction of wsdl:portType/wsdl:operation. |
| aoqi@0 | 36 | * |
| aoqi@0 | 37 | * @author Vivek Pandey |
| aoqi@0 | 38 | */ |
| aoqi@0 | 39 | public interface WSDLOperation extends WSDLObject, WSDLExtensible { |
| aoqi@0 | 40 | /** |
| aoqi@0 | 41 | * Gets the name of the wsdl:portType/wsdl:operation@name attribute value as local name and wsdl:definitions@targetNamespace |
| aoqi@0 | 42 | * as the namespace uri. |
| aoqi@0 | 43 | */ |
| aoqi@0 | 44 | @NotNull QName getName(); |
| aoqi@0 | 45 | |
| aoqi@0 | 46 | /** |
| aoqi@0 | 47 | * Gets the wsdl:input of this operation |
| aoqi@0 | 48 | */ |
| aoqi@0 | 49 | @NotNull WSDLInput getInput(); |
| aoqi@0 | 50 | |
| aoqi@0 | 51 | /** |
| aoqi@0 | 52 | * Gets the wsdl:output of this operation. |
| aoqi@0 | 53 | * |
| aoqi@0 | 54 | * @return |
| aoqi@0 | 55 | * null if this is an one-way operation. |
| aoqi@0 | 56 | */ |
| aoqi@0 | 57 | @Nullable WSDLOutput getOutput(); |
| aoqi@0 | 58 | |
| aoqi@0 | 59 | /** |
| aoqi@0 | 60 | * Returns true if this operation is an one-way operation. |
| aoqi@0 | 61 | */ |
| aoqi@0 | 62 | boolean isOneWay(); |
| aoqi@0 | 63 | |
| aoqi@0 | 64 | /** |
| aoqi@0 | 65 | * Gets the {@link WSDLFault} corresponding to wsdl:fault of this operation. |
| aoqi@0 | 66 | */ |
| aoqi@0 | 67 | Iterable<? extends WSDLFault> getFaults(); |
| aoqi@0 | 68 | |
| aoqi@0 | 69 | /** |
| aoqi@0 | 70 | * Gives {@link WSDLFault} for the given soap fault detail value. |
| aoqi@0 | 71 | * |
| aoqi@0 | 72 | * <pre> |
| aoqi@0 | 73 | * |
| aoqi@0 | 74 | * Given a wsdl fault: |
| aoqi@0 | 75 | * |
| aoqi@0 | 76 | * <wsdl:message nae="faultMessage"> |
| aoqi@0 | 77 | * <wsdl:part name="fault" element="<b>ns:myException</b>/> |
| aoqi@0 | 78 | * </wsdl:message> |
| aoqi@0 | 79 | * |
| aoqi@0 | 80 | * <wsdl:portType> |
| aoqi@0 | 81 | * <wsdl:operation ...> |
| aoqi@0 | 82 | * <wsdl:fault name="aFault" message="faultMessage"/> |
| aoqi@0 | 83 | * </wsdl:operation> |
| aoqi@0 | 84 | * <wsdl:portType> |
| aoqi@0 | 85 | * |
| aoqi@0 | 86 | * |
| aoqi@0 | 87 | * For example given a soap 11 soap message: |
| aoqi@0 | 88 | * |
| aoqi@0 | 89 | * <soapenv:Fault> |
| aoqi@0 | 90 | * ... |
| aoqi@0 | 91 | * <soapenv:detail> |
| aoqi@0 | 92 | * <<b>ns:myException</b>> |
| aoqi@0 | 93 | * ... |
| aoqi@0 | 94 | * </ns:myException> |
| aoqi@0 | 95 | * </soapenv:detail> |
| aoqi@0 | 96 | * |
| aoqi@0 | 97 | * QName faultQName = new QName(ns, "myException"); |
| aoqi@0 | 98 | * WSDLFault wsdlFault = getFault(faultQName); |
| aoqi@0 | 99 | * |
| aoqi@0 | 100 | * The above call will return a WSDLFault that abstracts wsdl:portType/wsdl:operation/wsdl:fault. |
| aoqi@0 | 101 | * |
| aoqi@0 | 102 | * </pre> |
| aoqi@0 | 103 | * |
| aoqi@0 | 104 | * @param faultDetailName tag name of the element inside soaenv:Fault/detail/, must be non-null. |
| aoqi@0 | 105 | * @return returns null if a wsdl fault corresponding to the detail entry name not found. |
| aoqi@0 | 106 | */ |
| aoqi@0 | 107 | @Nullable WSDLFault getFault(QName faultDetailName); |
| aoqi@0 | 108 | |
| aoqi@0 | 109 | /** |
| aoqi@0 | 110 | * Gives the enclosing wsdl:portType@name attribute value. |
| aoqi@0 | 111 | */ |
| aoqi@0 | 112 | @NotNull QName getPortTypeName(); |
| aoqi@0 | 113 | |
| aoqi@0 | 114 | /** |
| aoqi@0 | 115 | * Returns parameter order |
| aoqi@0 | 116 | * @return Parameter order |
| aoqi@0 | 117 | */ |
| aoqi@0 | 118 | public String getParameterOrder(); |
| aoqi@0 | 119 | } |
