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