JAX-WS API 2.3.1 · javax.xml.ws.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 Java EE 5 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 JAX-WS implementation encounters an unsupported or unrecognized annotation annotated with the WebServiceFeatureAnnotation that is specified with WebServiceRef, an ERROR MUST be given.

Method Summary

Modifier and Type	Method and Description
public String	Returns: portable JNDI lookup name lookup() A portable JNDI lookup name that resolves to the target web service reference.
public String	Returns: product specific resource name mappedName() A product specific name that this resource should be mapped to.
public String	Returns: absolute or relative JNDI name name() The JNDI name of the resource.
public Class<?>	Returns: type of the resource type() The Java type of the resource.
public Class<? extends Service>	Returns: the service class extending `javax.xml.ws.Service` value() The service class, always a type extending `javax.xml.ws.Service`.
public String	Returns: a URL pointing to the WSDL document wsdlLocation() A URL pointing to the WSDL document for the web service.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

lookup	back to summary
public String lookup() A portable JNDI lookup name that resolves to the target web service reference. Returns:String portable JNDI lookup name Since 1.7, JAX-WS 2.2

lookup

back to summary

public String lookup()

A portable JNDI lookup name that resolves to the target web service reference.

Returns:String: portable JNDI lookup name
Since: 1.7, JAX-WS 2.2

mappedName back to summary

mappedName	back to summary
public 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:String product specific resource name

public 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:String: product specific resource name

name back to summary

name	back to summary
public 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:String absolute or relative JNDI name

public 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:String: absolute or relative JNDI name

type	back to summary
public 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:Class<?> type of the resource

type

back to summary

public 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:Class<?>: type of the resource

value back to summary

value	back to summary
public Class<? extends Service> value() The service class, always a type extending `javax.xml.ws.Service`. This element MUST be specified whenever the type of the reference is a service endpoint interface. Returns:Class<? extends Service> the service class extending `javax.xml.ws.Service`

public Class<? extends Service> value()

The service class, always a type extending javax.xml.ws.Service. This element MUST be specified whenever the type of the reference is a service endpoint interface.

Returns:Class<? extends Service>: the service class extending javax.xml.ws.Service

wsdlLocation	back to summary
public 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:String a URL pointing to the WSDL document

wsdlLocation

back to summary

public 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:String: a URL pointing to the WSDL document

public @Interface WebServiceRef

Method Summary

Method Detail