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
|
/*
* 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.jws;
// $Id: WebParam.java 2897 2007-04-23 06:12:12Z thomas.diesler@jboss.com $
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Customizes the mapping of an individual parameter to a Web Service message part and XML element.
*
* @author thomas.diesler@jboss.org
* @since 26-Apr-2005
*/
@Retention(value = RetentionPolicy.RUNTIME)
@Target(value = { ElementType.PARAMETER })
public @interface WebParam
{
/**
* The direction in which the parameter flows
*/
public enum Mode
{
IN, OUT, INOUT
};
/**
* Name of the parameter.
*
* If the operation is rpc style and @WebParam.partName has not been specified, this is name of the wsdl:part representing the parameter.
* If the operation is document style or the parameter maps to a header, this is the local name of the XML element representing the parameter.
*
* A name MUST be specified if the operation is document style, the parameter style is BARE, and the mode is OUT or INOUT.
*
* Specification Default:
* If the operation is document style and the parameter style is BARE, @WebMethod.operationName.
* Otherwise, argN, where N represents the index of the parameter in the method signature (starting at arg0).
*/
String name() default "";
/**
* The name of the wsdl:part representing this return value.
* This is only used if the operation is rpc style, or if the operation is document style and the parameter style is BARE.
*/
String partName() default "";
/**
* The XML namespace for the parameter.
*
* Only used if the operation is document style or the paramater maps to a header. If the target namespace is set to “”, this represents the empty namespace.
*
* Specification Default:
* If the operation is document style, the parameter style is WRAPPED, and the parameter does not map to a header, the empty namespace.
* Otherwise, the targetNamespace for the Web Service.
*/
String targetNamespace() default "";
/**
* The direction in which the parameter is flowing. One of IN, OUT, or INOUT. The OUT and INOUT modes may only be
* specified for parameter types that conform to the JAX-RPC definition of Holder types. See JAX-RPC 1.1, section
* 4.3.5. OUT and INOUT modes are only supported for RPC bindings or for parameters that map to headers.
*/
Mode mode() default Mode.IN;
/**
* If true, the parameter is pulled from a message header rather then the message body.
*/
boolean header() default false;
};
|
