Package jakarta.xml.ws

Annotation Type WebServiceRef

  • @Target({TYPE,METHOD,FIELD})
@Retention(RUNTIME)
@Documented
@Repeatable(WebServiceRefs.class)
public @interface WebServiceRef
    The WebServiceRef annotation is used to define a reference to a web service and (optionally) an injection target for it. It can be used to inject both service and proxy instances. These injected references are not thread safe. If the references are accessed by multiple threads, usual synchronization techinques can be used to support multiple threads.

    Web service references are resources in the Jakarta EE sense. The annotations (for example, Addressing) annotated with meta-annotation WebServiceFeatureAnnotation can be used in conjunction with WebServiceRef. The created reference MUST be configured with annotation's web service feature.

    For example, in the code below, the injected StockQuoteProvider proxy MUST have WS-Addressing enabled as specifed by the Addressing annotation. 

    
    public class MyClient {
       @Addressing
       @WebServiceRef(StockQuoteService.class)
       private StockQuoteProvider stockQuoteProvider;
       ...
    }

    If a Jakarta XML Web Services implementation encounters an unsupported or unrecognized annotation annotated with the WebServiceFeatureAnnotation that is specified with WebServiceRef, an ERROR MUST be given.

    Since:
    1.6, JAX-WS 2.0
    See Also:
    "jakarta.annotation.Resource", WebServiceFeatureAnnotation

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String lookup
      A portable JNDI lookup name that resolves to the target web service reference.
      String mappedName
      A product specific name that this resource should be mapped to.
      String name
      The JNDI name of the resource.
      Class<?> type
      The Java type of the resource.
      Class<? extends Service> value
      The service class, always a type extending jakarta.xml.ws.Service.
      String wsdlLocation
      A URL pointing to the WSDL document for the web service.

    • Element Detail

      • name

        String name
        The JNDI name of the resource. For field annotations, the default is the field name. For method annotations, the default is the JavaBeans property name corresponding to the method. For class annotations, there is no default and this MUST be specified. The JNDI name can be absolute(with any logical namespace) or relative to JNDI java:comp/env namespace.
        Returns:
        absolute or relative JNDI name
        Default:
        ""

      • type

        Class<?> type
        The Java type of the resource. For field annotations, the default is the type of the field. For method annotations, the default is the type of the JavaBeans property. For class annotations, there is no default and this MUST be specified.
        Returns:
        type of the resource
        Default:
        java.lang.Object.class

      • mappedName

        String mappedName
        A product specific name that this resource should be mapped to. The name of this resource, as defined by the name element or defaulted, is a name that is local to the application component using the resource. (When a relative JNDI name is specified, then it's a name in the JNDI java:comp/env namespace.) Many application servers provide a way to map these local names to names of resources known to the application server. This mapped name is often a global JNDI name, but may be a name of any form.

        Application servers are not required to support any particular form or type of mapped name, nor the ability to use mapped names. The mapped name is product-dependent and often installation-dependent. No use of a mapped name is portable.

        Returns:
        product specific resource name
        Default:
        ""

      • value

        Class<? extends Service> value
        The service class, always a type extending jakarta.xml.ws.Service. This element MUST be specified whenever the type of the reference is a service endpoint interface.
        Returns:
        the service class extending jakarta.xml.ws.Service
        Default:
        jakarta.xml.ws.Service.class

      • wsdlLocation

        String wsdlLocation
        A URL pointing to the WSDL document for the web service. If not specified, the WSDL location specified by annotations on the resource type is used instead.
        Returns:
        a URL pointing to the WSDL document
        Default:
        ""

      • lookup

        String lookup
        A portable JNDI lookup name that resolves to the target web service reference.
        Returns:
        portable JNDI lookup name
        Since:
        1.7, JAX-WS 2.2
        Default:
        ""