/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code 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 General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

/*

 * Copyright (c) 2004 by BEA Systems, Inc. All Rights Reserved.

 */

package javax.jws;

import java.lang.annotation.Target;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.ElementType;

/**

 * Marks a Java class as implementing a Web Service, or a Java interface as defining a Web Service interface.

 *

 * @author Copyright (c) 2004 by BEA Systems, Inc. All Rights Reserved.

 */

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = {ElementType.TYPE})

public @interface WebService {

    /**

     * The name of the Web Service.

     * <p>

     * Used as the name of the wsdl:portType when mapped to WSDL 1.1.

     *

     * @specdefault The simple name of the Java class or interface.

     */

    String name() default "";

    /**

     * If the @WebService.targetNamespace annotation is on a service endpoint interface, the targetNamespace is used

     * for the namespace for the wsdl:portType (and associated XML elements).

     * <p>

     * If the @WebService.targetNamespace annotation is on a service implementation bean that does NOT reference a

     * service endpoint interface (through the endpointInterface attribute), the targetNamespace is used for both the

     * wsdl:portType and the wsdl:service (and associated XML elements).

     * <p>

     * If the @WebService.targetNamespace annotation is on a service implementation bean that does reference a service

     * endpoint interface (through the endpointInterface attribute), the targetNamespace is used for only the

     * wsdl:service (and associated XML elements).

     *

     * @specdefault Implementation-defined, as described in JAX-WS 2.0 [5], section 3.2.

     */

    String targetNamespace() default "";

    /**

     * The service name of the Web Service.

     * <p>

     * Used as the name of the wsdl:service when mapped to WSDL 1.1.

     * <p>

     * <i>This member-value is not allowed on endpoint interfaces.</i>

     *

     * @specdefault The simple name of the Java class + "Service".

     */

    String serviceName() default "";

    /**

     * The port name of the Web Service.

     * <p>

     * Used as the name of the wsdl:port when mapped to WSDL 1.1.

     * <p>

     * <i>This member-value is not allowed on endpoint interfaces.</i>

     *

     * @specdefault {@code @WebService.name}+"Port".

     *

     * @since 2.0

     */

    String portName() default "";

    /**

     * The location of a pre-defined WSDL describing the service.

     * <p>

     * The wsdlLocation is a URL (relative or absolute) that refers to a pre-existing WSDL file.  The presence of a

     * wsdlLocation value indicates that the service implementation bean is implementing a pre-defined WSDL contract.

     * The JSR-181 tool MUST provide feedback if the service implementation bean is inconsistent with the portType and

     * bindings declared in this WSDL. Note that a single WSDL file might contain multiple portTypes and multiple

     * bindings.  The annotations on the service implementation bean determine the specific portType and bindings that

     * correspond to the Web Service.

     */

    String wsdlLocation() default "";

    /**

     * The complete name of the service endpoint interface defining the service's abstract Web Service contract.

     * <p>

     * This annotation allows the developer to separate the interface contract from the implementation.  If this

     * annotation is present, the service endpoint interface is used to determine the abstract WSDL contract (portType

     * and bindings). The service endpoint interface MAY include JSR-181 annotations to customize the mapping from

     * Java to WSDL.

     * <br>

     * The service implementation bean MAY implement the service endpoint interface, but is not REQUIRED to do so.

     * <br>

     * If this member-value is not present, the Web Service contract is generated from annotations on the service

     * implementation bean.  If a service endpoint interface is required by the target environment, it will be

     * generated into an implementation-defined package with an implementation- defined name

     * <p>

     * <i>This member-value is not allowed on endpoint interfaces.</i>

     */

    String endpointInterface() default "";

};