blob: 9978f0b151942c7d83caa91907cc59bd1c87a94d [file] [log] [blame]
Kelly O'Hairbc113af2012-03-06 16:09:35 -08001/*
Aleksei Efimov5e00da62017-06-18 23:07:25 +01002 * Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
Kelly O'Hairbc113af2012-03-06 16:09:35 -08003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.xml.ws;
27
28import java.lang.annotation.Documented;
29import java.lang.annotation.Target;
30import java.lang.annotation.Retention;
31import java.lang.annotation.ElementType;
32import java.lang.annotation.RetentionPolicy;
33
34/**
35 * Used to annotate the <code>get<em>PortName</em>()</code>
36 * methods of a generated service interface.
37 *
38 * <p>The information specified in this annotation is sufficient
Miroslav Kos48079762015-07-10 11:42:59 +020039 * to uniquely identify a {@code wsdl:port} element
40 * inside a {@code wsdl:service}. The latter is
41 * determined based on the value of the {@code WebServiceClient}
Kelly O'Hairbc113af2012-03-06 16:09:35 -080042 * annotation on the generated service interface itself.
43 *
Henry Jen10d82f22014-06-19 15:35:23 -070044 * @since 1.6, JAX-WS 2.0
Kelly O'Hairbc113af2012-03-06 16:09:35 -080045 *
46 * @see javax.xml.ws.WebServiceClient
47**/
48@Target({ElementType.METHOD})
49@Retention(RetentionPolicy.RUNTIME)
50@Documented
51public @interface WebEndpoint {
52 /**
53 * The local name of the endpoint.
Aleksei Efimov5e00da62017-06-18 23:07:25 +010054 *
55 * @return ocal name of the endpoint
Kelly O'Hairbc113af2012-03-06 16:09:35 -080056 **/
57 String name() default "";
58}