01 /*
02 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
03 *
04 * This code is free software; you can redistribute it and/or modify it
05 * under the terms of the GNU General Public License version 2 only, as
06 * published by the Free Software Foundation. Sun designates this
07 * particular file as subject to the "Classpath" exception as provided
08 * by Sun in the LICENSE file that accompanied this code.
09 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
22 * have any questions.
23 */
24
25 /*
26 * Copyright (c) 2004 by BEA Systems, Inc. All Rights Reserved.
27 */
28
29 package javax.jws;
30
31 import java.lang.annotation.Retention;
32 import java.lang.annotation.RetentionPolicy;
33 import java.lang.annotation.Target;
34 import java.lang.annotation.ElementType;
35
36 /**
37 * Customizes the mapping of the return value to a WSDL part and XML element.
38 *
39 * @author Copyright (c) 2004 by BEA Systems, Inc. All Rights Reserved.
40 */
41 @Retention(value=RetentionPolicy.RUNTIME)
42 @Target(value={ElementType.METHOD})
43 public @interface WebResult {
44
45 /**
46 * Name of return value.
47 * <p>
48 * If the operation is rpc style and @WebResult.partName has not been specified, this is the name of the wsdl:part
49 * representing the return value.
50 * <br>
51 * If the operation is document style or the return value maps to a header, this is the local name of the XML
52 * element representing the return value.
53 *
54 * @specdefault
55 * If the operation is document style and the parameter style is BARE, {@code @WebParam.operationName}+"Response".<br>
56 * Otherwise, "return."
57 */
58 String name() default "";
59
60 /**
61 * The name of the wsdl:part representing this return value.
62 * <p>
63 * This is only used if the operation is rpc style, or if the operation is document style and the parameter style
64 * is BARE.
65 *
66 * @specdefault {@code @WebResult.name}
67 *
68 * @since 2.0
69 */
70 String partName() default "";
71
72 /**
73 * The XML namespace for the return value.
74 * <p>
75 * Only used if the operation is document style or the return value maps to a header.
76 * If the target namespace is set to "", this represents the empty namespace.
77 *
78 * @specdefault
79 * If the operation is document style, the parameter style is WRAPPED, and the return value does not map to a
80 * header, the empty namespace.<br>
81 * Otherwise, the targetNamespace for the Web Service.
82 */
83 String targetNamespace() default "";
84
85 /**
86 * If true, the result is pulled from a message header rather then the message body.
87 *
88 * @since 2.0
89 */
90 boolean header() default false;
91 }
|