src/share/jaxws_classes/com/sun/xml/internal/ws/api/model/wsdl/WSDLOperation.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 408
b0610cd08440
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
alanb@368 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package com.sun.xml.internal.ws.api.model.wsdl;
ohair@286 27
ohair@286 28 import com.sun.xml.internal.ws.api.model.wsdl.WSDLExtensible;
ohair@286 29 import com.sun.istack.internal.NotNull;
ohair@286 30 import com.sun.istack.internal.Nullable;
ohair@286 31
ohair@286 32 import javax.xml.namespace.QName;
ohair@286 33
ohair@286 34 /**
ohair@286 35 * Provides abstraction of wsdl:portType/wsdl:operation.
ohair@286 36 *
ohair@286 37 * @author Vivek Pandey
ohair@286 38 */
ohair@286 39 public interface WSDLOperation extends WSDLObject, WSDLExtensible {
ohair@286 40 /**
ohair@286 41 * Gets the name of the wsdl:portType/wsdl:operation@name attribute value as local name and wsdl:definitions@targetNamespace
ohair@286 42 * as the namespace uri.
ohair@286 43 */
ohair@286 44 @NotNull QName getName();
ohair@286 45
ohair@286 46 /**
ohair@286 47 * Gets the wsdl:input of this operation
ohair@286 48 */
ohair@286 49 @NotNull WSDLInput getInput();
ohair@286 50
ohair@286 51 /**
ohair@286 52 * Gets the wsdl:output of this operation.
ohair@286 53 *
ohair@286 54 * @return
ohair@286 55 * null if this is an one-way operation.
ohair@286 56 */
ohair@286 57 @Nullable WSDLOutput getOutput();
ohair@286 58
ohair@286 59
ohair@286 60
ohair@286 61 /**
ohair@286 62 * Returns true if this operation is an one-way operation.
ohair@286 63 */
ohair@286 64 boolean isOneWay();
ohair@286 65
ohair@286 66 /**
ohair@286 67 * Gets the {@link WSDLFault} corresponding to wsdl:fault of this operation.
ohair@286 68 */
ohair@286 69 Iterable<? extends WSDLFault> getFaults();
ohair@286 70
ohair@286 71 /**
ohair@286 72 * Gives {@link WSDLFault} for the given soap fault detail value.
ohair@286 73 *
ohair@286 74 * <pre>
ohair@286 75 *
ohair@286 76 * Given a wsdl fault:
ohair@286 77 *
ohair@286 78 * &lt;wsdl:message nae="faultMessage">
ohair@286 79 * &lt;wsdl:part name="fault" element="<b>ns:myException</b>/>
ohair@286 80 * &lt;/wsdl:message>
ohair@286 81 *
ohair@286 82 * &lt;wsdl:portType>
ohair@286 83 * &lt;wsdl:operation ...>
ohair@286 84 * &lt;wsdl:fault name="aFault" message="faultMessage"/>
ohair@286 85 * &lt;/wsdl:operation>
ohair@286 86 * &lt;wsdl:portType>
ohair@286 87 *
ohair@286 88 *
ohair@286 89 * For example given a soap 11 soap message:
ohair@286 90 *
ohair@286 91 * &lt;soapenv:Fault>
ohair@286 92 * ...
ohair@286 93 * &lt;soapenv:detail>
ohair@286 94 * &lt;<b>ns:myException</b>>
ohair@286 95 * ...
ohair@286 96 * &lt;/ns:myException>
ohair@286 97 * &lt;/soapenv:detail>
ohair@286 98 *
ohair@286 99 * QName faultQName = new QName(ns, "myException");
ohair@286 100 * WSDLFault wsdlFault = getFault(faultQName);
ohair@286 101 *
ohair@286 102 * The above call will return a WSDLFault that abstracts wsdl:portType/wsdl:operation/wsdl:fault.
ohair@286 103 *
ohair@286 104 * </pre>
ohair@286 105 *
ohair@286 106 * @param faultDetailName tag name of the element inside soaenv:Fault/detail/, must be non-null.
ohair@286 107 * @return returns null if a wsdl fault corresponding to the detail entry name not found.
ohair@286 108 */
ohair@286 109 @Nullable WSDLFault getFault(QName faultDetailName);
ohair@286 110
ohair@286 111 /**
ohair@286 112 * Gives the enclosing wsdl:portType@name attribute value.
ohair@286 113 */
ohair@286 114 @NotNull QName getPortTypeName();
ohair@286 115 }

mercurial