| JavaTM 2 Platform Std. Ed. v1.6.0
javax.jws
Annotation Type WebService
@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface WebService
Marks a Java class as implementing a Web Service, or a Java interface as defining a Web Service interface.
|
Optional Element Summary |
String |
endpointInterface
The complete name of the service endpoint interface defining the service's abstract Web Service contract. |
String |
name
The name of the Web Service. |
String |
portName
The port name of the Web Service. |
String |
serviceName
The service name of the Web Service. |
String |
targetNamespace
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). |
String |
wsdlLocation
The location of a pre-defined WSDL describing the service. |
name
public abstract String name
- The name of the Web Service.
Used as the name of the wsdl:portType when mapped to WSDL 1.1.
- Default:
- ""
targetNamespace
public abstract String targetNamespace
- 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).
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).
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).
- Default:
- ""
serviceName
public abstract String serviceName
- The service name of the Web Service.
Used as the name of the wsdl:service when mapped to WSDL 1.1.
This member-value is not allowed on endpoint interfaces.
- Default:
- ""
portName
public abstract String portName
- The port name of the Web Service.
Used as the name of the wsdl:port when mapped to WSDL 1.1.
This member-value is not allowed on endpoint interfaces.
- Since:
- 2.0
- Default:
- ""
wsdlLocation
public abstract String wsdlLocation
- The location of a pre-defined WSDL describing the service.
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.
- Default:
- ""
endpointInterface
public abstract String endpointInterface
- The complete name of the service endpoint interface defining the service's abstract Web Service contract.
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.
The service implementation bean MAY implement the service endpoint interface, but is not REQUIRED to do so.
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
This member-value is not allowed on endpoint interfaces.
- Default:
- ""
Copyright 2003 Sun Microsystems, Inc. All rights reserved
|