jakarta.xml.ws.WebEndpoint Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package jakarta.xml.ws;

import java.lang.annotation.Documented;
import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import java.lang.annotation.ElementType;
import java.lang.annotation.RetentionPolicy;

/**
 *  Used to annotate the getPortName()
 *  methods of a generated service interface.
 *
 *  The information specified in this annotation is sufficient
 *  to uniquely identify a {@code wsdl:port} element
 *  inside a {@code wsdl:service}. The latter is
 *  determined based on the value of the {@code WebServiceClient}
 *  annotation on the generated service interface itself.
 *
 *  @since 1.6, JAX-WS 2.0
 *
 *  @see jakarta.xml.ws.WebServiceClient
**/
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface WebEndpoint {
  /**
   *  The local name of the endpoint.
   *
   * @return ocal name of the endpoint
  **/
  String name() default "";
}