|
1 /* |
|
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
3 * |
|
4 * This code is free software; you can redistribute it and/or modify it |
|
5 * under the terms of the GNU General Public License version 2 only, as |
|
6 * published by the Free Software Foundation. Sun designates this |
|
7 * particular file as subject to the "Classpath" exception as provided |
|
8 * by Sun in the LICENSE file that accompanied this code. |
|
9 * |
|
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.Target; |
|
32 import java.lang.annotation.Retention; |
|
33 import java.lang.annotation.RetentionPolicy; |
|
34 import java.lang.annotation.ElementType; |
|
35 |
|
36 /** |
|
37 * Marks a Java class as implementing a Web Service, or a Java interface as defining a Web Service interface. |
|
38 * |
|
39 * @author Copyright (c) 2004 by BEA Systems, Inc. All Rights Reserved. |
|
40 */ |
|
41 @Retention(value = RetentionPolicy.RUNTIME) |
|
42 @Target(value = {ElementType.TYPE}) |
|
43 public @interface WebService { |
|
44 |
|
45 /** |
|
46 * The name of the Web Service. |
|
47 * <p> |
|
48 * Used as the name of the wsdl:portType when mapped to WSDL 1.1. |
|
49 * |
|
50 * @specdefault The simple name of the Java class or interface. |
|
51 */ |
|
52 String name() default ""; |
|
53 |
|
54 /** |
|
55 * If the @WebService.targetNamespace annotation is on a service endpoint interface, the targetNamespace is used |
|
56 * for the namespace for the wsdl:portType (and associated XML elements). |
|
57 * <p> |
|
58 * If the @WebService.targetNamespace annotation is on a service implementation bean that does NOT reference a |
|
59 * service endpoint interface (through the endpointInterface attribute), the targetNamespace is used for both the |
|
60 * wsdl:portType and the wsdl:service (and associated XML elements). |
|
61 * <p> |
|
62 * If the @WebService.targetNamespace annotation is on a service implementation bean that does reference a service |
|
63 * endpoint interface (through the endpointInterface attribute), the targetNamespace is used for only the |
|
64 * wsdl:service (and associated XML elements). |
|
65 * |
|
66 * @specdefault Implementation-defined, as described in JAX-WS 2.0 [5], section 3.2. |
|
67 */ |
|
68 String targetNamespace() default ""; |
|
69 |
|
70 /** |
|
71 * The service name of the Web Service. |
|
72 * <p> |
|
73 * Used as the name of the wsdl:service when mapped to WSDL 1.1. |
|
74 * <p> |
|
75 * <i>This member-value is not allowed on endpoint interfaces.</i> |
|
76 * |
|
77 * @specdefault The simple name of the Java class + "Service". |
|
78 */ |
|
79 String serviceName() default ""; |
|
80 |
|
81 /** |
|
82 * The port name of the Web Service. |
|
83 * <p> |
|
84 * Used as the name of the wsdl:port when mapped to WSDL 1.1. |
|
85 * <p> |
|
86 * <i>This member-value is not allowed on endpoint interfaces.</i> |
|
87 * |
|
88 * @specdefault {@code @WebService.name}+"Port". |
|
89 * |
|
90 * @since 2.0 |
|
91 */ |
|
92 String portName() default ""; |
|
93 |
|
94 /** |
|
95 * The location of a pre-defined WSDL describing the service. |
|
96 * <p> |
|
97 * The wsdlLocation is a URL (relative or absolute) that refers to a pre-existing WSDL file. The presence of a |
|
98 * wsdlLocation value indicates that the service implementation bean is implementing a pre-defined WSDL contract. |
|
99 * The JSR-181 tool MUST provide feedback if the service implementation bean is inconsistent with the portType and |
|
100 * bindings declared in this WSDL. Note that a single WSDL file might contain multiple portTypes and multiple |
|
101 * bindings. The annotations on the service implementation bean determine the specific portType and bindings that |
|
102 * correspond to the Web Service. |
|
103 */ |
|
104 String wsdlLocation() default ""; |
|
105 |
|
106 /** |
|
107 * The complete name of the service endpoint interface defining the service's abstract Web Service contract. |
|
108 * <p> |
|
109 * This annotation allows the developer to separate the interface contract from the implementation. If this |
|
110 * annotation is present, the service endpoint interface is used to determine the abstract WSDL contract (portType |
|
111 * and bindings). The service endpoint interface MAY include JSR-181 annotations to customize the mapping from |
|
112 * Java to WSDL. |
|
113 * <br> |
|
114 * The service implementation bean MAY implement the service endpoint interface, but is not REQUIRED to do so. |
|
115 * <br> |
|
116 * If this member-value is not present, the Web Service contract is generated from annotations on the service |
|
117 * implementation bean. If a service endpoint interface is required by the target environment, it will be |
|
118 * generated into an implementation-defined package with an implementation- defined name |
|
119 * <p> |
|
120 * <i>This member-value is not allowed on endpoint interfaces.</i> |
|
121 */ |
|
122 String endpointInterface() default ""; |
|
123 }; |