001 /*
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
003 *
004 * This code is free software; you can redistribute it and/or modify it
005 * under the terms of the GNU General Public License version 2 only, as
006 * published by the Free Software Foundation. Sun designates this
007 * particular file as subject to the "Classpath" exception as provided
008 * by Sun in the LICENSE file that accompanied this code.
009 *
010 * This code is distributed in the hope that it will be useful, but WITHOUT
011 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
012 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
013 * version 2 for more details (a copy is included in the LICENSE file that
014 * accompanied this code).
015 *
016 * You should have received a copy of the GNU General Public License version
017 * 2 along with this work; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
019 *
020 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
021 * CA 95054 USA or visit www.sun.com if you need additional information or
022 * have any questions.
023 */
024
025 /*
026 * Copyright (c) 2004 by BEA Systems, Inc. All Rights Reserved.
027 */
028
029 package javax.jws;
030
031 import java.lang.annotation.Target;
032 import java.lang.annotation.Retention;
033 import java.lang.annotation.RetentionPolicy;
034 import java.lang.annotation.ElementType;
035
036 /**
037 * Marks a Java class as implementing a Web Service, or a Java interface as defining a Web Service interface.
038 *
039 * @author Copyright (c) 2004 by BEA Systems, Inc. All Rights Reserved.
040 */
041 @Retention(value=RetentionPolicy.RUNTIME)
042 @Target(value={ElementType.TYPE})
043 public @interface WebService {
044
045 /**
046 * The name of the Web Service.
047 * <p>
048 * Used as the name of the wsdl:portType when mapped to WSDL 1.1.
049 *
050 * @specdefault The simple name of the Java class or interface.
051 */
052 String name() default "";
053
054 /**
055 * If the @WebService.targetNamespace annotation is on a service endpoint interface, the targetNamespace is used
056 * for the namespace for the wsdl:portType (and associated XML elements).
057 * <p>
058 * If the @WebService.targetNamespace annotation is on a service implementation bean that does NOT reference a
059 * service endpoint interface (through the endpointInterface attribute), the targetNamespace is used for both the
060 * wsdl:portType and the wsdl:service (and associated XML elements).
061 * <p>
062 * If the @WebService.targetNamespace annotation is on a service implementation bean that does reference a service
063 * endpoint interface (through the endpointInterface attribute), the targetNamespace is used for only the
064 * wsdl:service (and associated XML elements).
065 *
066 * @specdefault Implementation-defined, as described in JAX-WS 2.0 [5], section 3.2.
067 */
068 String targetNamespace() default "";
069
070 /**
071 * The service name of the Web Service.
072 * <p>
073 * Used as the name of the wsdl:service when mapped to WSDL 1.1.
074 * <p>
075 * <i>This member-value is not allowed on endpoint interfaces.</i>
076 *
077 * @specdefault The simple name of the Java class + "Service".
078 */
079 String serviceName() default "";
080
081 /**
082 * The port name of the Web Service.
083 * <p>
084 * Used as the name of the wsdl:port when mapped to WSDL 1.1.
085 * <p>
086 * <i>This member-value is not allowed on endpoint interfaces.</i>
087 *
088 * @specdefault {@code @WebService.name}+"Port".
089 *
090 * @since 2.0
091 */
092 String portName() default "";
093
094 /**
095 * The location of a pre-defined WSDL describing the service.
096 * <p>
097 * The wsdlLocation is a URL (relative or absolute) that refers to a pre-existing WSDL file. The presence of a
098 * wsdlLocation value indicates that the service implementation bean is implementing a pre-defined WSDL contract.
099 * 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 };
|