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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package javax.xml.ws;
// $Id: Action.java 2897 2007-04-23 06:12:12Z thomas.diesler@jboss.com $
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* The <code>Action</code> annotation allows explicit association of <code>Action</code>
* message addressing property with <code>input</code>, <code>output</code>, and
* <code>fault</code> messages of the mapped WSDL operation.
* <p>
* This annotation can be specified on each method of a service endpoint interface.
* For such a method, the mapped operation in the generated WSDL
* contains explicit <code>wsaw:Action</code> attribute on the WSDL <code>input</code>,
* <code>output</code> and <code>fault</code> messages of the WSDL <code>operation</code>
* based upon which attributes of the <code>Action</code> annotation have been specified.
* <p>
* <b>Example 1</b>: Specify explicit values for <code>Action</code> message addressing property
* for <code>input</code> and <code>output</code> messages.
*
* <pre>
* @javax.jws.WebService
* public class AddNumbersImpl {
* @javax.xml.ws.Action(
* input="http://example.com/inputAction",
* output="http://example.com/outputAction")
* public int addNumbers(int number1, int number2) {
* return number1 + number2;
* }
* }
* </pre>
*
* The generated WSDL looks like:
* <pre>
* <definitions targetNamespace="http://example.com/numbers" ...>
* ...
* <portType name="AddNumbersPortType">
* <operation name="AddNumbers">
* <input message="tns:AddNumbersInput" name="Parameters"
* wsaw:Action="http://example.com/inputAction"/>
* <output message="tns:AddNumbersOutput" name="Result"
* wsaw:Action="http://example.com/outputAction"/>
* </operation>
* <portType>
* ...
* <definitions>
* </pre>
*
* <p>
* <b>Example 2</b>: Specify explicit value for <code>Action</code> message addressing property
* for only the <code>input</code> message. The default values are used for the
* <code>output</code> message.
*
* <pre>
* @javax.jws.WebService
* public class AddNumbersImpl {
* @javax.xml.ws.Action(input="http://example.com/inputAction")
* public int addNumbers(int number1, int number2) {
* return number1 + number2;
* }
* }
* </pre>
*
* The generated WSDL looks like:
*
* <pre>
* <definitions targetNamespace="http://example.com/numbers" ...>
* ...
* <portType name="AddNumbersPortType">
* <operation name="AddNumbers">
* <input message="tns:AddNumbersInput" name="Parameters"
* wsaw:Action="http://example.com/inputAction"/>
* <output message="tns:AddNumbersOutput" name="Result"/>
* </operation>
* <portType>
* ...
* <definitions>
* </pre>
*
* It is legitimate to specify an explicit value for <code>Action</code> message addressing property for
* <code>output</code> message only. In this case, a default value of <code>wsaw:Action</code> is used
* for the <code>input</code> message.
*
* <p>
* <b>Example 3</b>: See <a href="FaultAction.html">FaultAction</a> annotation for an example of
* how to specify an explicit value for <code>Action</code> message addressing property for the
* <code>fault</code> message.
*
* @see FaultAction
*
* @since JAX-WS 2.1
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Action {
/**
* Explicit value of <code>Action</code> message addressing property for the <code>input</code>
* message of the operation. If the value is "", then no <code>wsaw:Action</code>
* is generated.
*/
String input() default "";
/**
* Explicit value of <code>Action</code> message addressing property for the <code>output</code>
* message of the operation. If the value is "", then no <code>wsaw:Action</code>
* is generated.
*/
String output() default "";
/**
* Explicit value of <code>Action</code> message addressing property for the <code>fault</code>
* message(s) of the operation. Each exception that is mapped to a fault and requires explicit
* <code>Action</code> message addressing property, need to be specified as a value in this property
* using <a href="FaultAction.html">FaultAction</a> annotation.
*/
FaultAction[] fault() default {};
}
|
