Web Services Metadata Annotations (JSR 181)
Using annotations from the JSR 181 specification, you can annotate a Web service implementation class or a Web service interface. Then you can generate a Web service with a wizard or by publishing the application to a server.
Note: The Java™ class that contains each annotation in the JSR 181 standard is named javax.jws.xxx, where xxx is the name of the annotation after the '@' character. For example, the Java class name that corresponds to @WebService is javax.jws.webservice.
| Name: | Description: | Properties: | Definitions: |
|---|---|---|---|
| @WebService | This annotation marks either a Java class
or a service endpoint interface (SEI) as implementing a Web service
interface.
Important: This annotation is applicable for a client or server SEI; or for a service endpoint implementation class for a JavaBeans™ endpoint. Three of the properties of the annotation can be used only with a service endpoint implementation class for a JavaBeans endpoint. These properties are serviceName, portName, and endpointInterface. If the annotation references an SEI through the endpointInterface attribute, then the SEI must also have the @WebService annotation. By default, all public methods in a class that specifies the @WebService annotation are exposed in the Web service. |
|
@Retention(value = RetentionPolicy.RUNTIME)
@Target({TYPE})
public @interface WebService{
String name() default “”;
String targetNamespace() default “”;
String serviceName() default “”’;
String wsdlLocation() default “”;
String endpointInterface() default “”;
String portName() default “”;
};
|
| @WebMethod | This annotation denotes a method that is a Web
service
operation.
You can apply this annotation to public methods in a client or server Service Endpoint Interface (SEI), or in a service endpoint implementation class for a JavaBeans endpoint. Important: The @WebMethod annotation is only supported on classes that have the @WebService annotation. |
|
@Retention(value = RetentionPolicy.RUNTIME)
@Target({TYPE})
public @interface WebMethod{
String operationName() default “”;
String action() default “”;
boolean exclude() default false;
};
|
| @Oneway | This annotation denotes a method as a one-way
operation
for a Web service. It has an input message but no output message.
This annotation
can be used only on methods that have no return value.
You can apply this annotation to public methods in a client or server Service Endpoint Interface (SEI), or in a service endpoint implementation class for a JavaBeans endpoint. |
|
@Retention(value = RetentionPolicy.RUNTIME)
@Target({TYPE})
public @interface OneWay{
};
|
| @WebParam | This annotation customizes the mapping of an
individual
parameter to a Web service message part and XML element.
You can apply this annotation to public methods in a client or server Service Endpoint Interface (SEI), or in a service endpoint implementation class for a JavaBeans endpoint. |
|
@Retention(value = RetentionPolicy.RUNTIME)
@Target({PARAMETER})
public @interface WebParam{
public enum Mode{
IN,
OUT,
INOUT
};
String name() default “”;
String partName() default "";
String targetNamespace() default “”;
Mode mode() default Mode.IN
boolean header() default false;
};
|
| @WebResult | This annotation customizes how a return value
maps to
a WSDL part or XML element.
You can apply this annotation to public methods in a client or server Service Endpoint Interface (SEI), or in a service endpoint implementation class for a JavaBeans endpoint. |
|
@Retention(value = RetentionPolicy.RUNTIME)
@Target({METHOD})
public @interface WebResult{
String name() default “return”;
String targetNamespace default() “”;
boolean header() default false;
String partName() default "";
};
|
| @HandlerChain | This annotation associates the Web service to
an externally-defined
handler chain. You can use this annotation if the handler configuration
must
be shared across multiple Web services, and embedding handler configuration
in the application source is inefficient.
Apply this annotation to a client or server Service Endpoint Interface (SEI), or to a service endpoint implementation class for a JavaBeans endpoint. |
|
@Retention(value = RetentionPolicy.RUNTIME)
@Target({TYPE})
public @interface HandlerChain{
String file();
String name();
};
|
| @SOAPBinding | This annotation specifies the mapping of the
Web service
onto the SOAP message protocol.
You can apply this annotation to a type or public methods in a client or server Service Endpoint Interface (SEI), or in a service endpoint implementation class for a Java beans endpoint. The method-level annotation is limited by what it can specify. Use the annotation only if the style property has the value DOCUMENT. If the method-level annotation is not specified, the @SOAPBinding behavior from the type is used. |
|
@Retention(value = RetentionPolicy.RUNTIME)
@Target({TYPE})
public @interface SOAPBinding{
public enum Style{
DOCUMENT,
RPC
};
public enum Use{
LITERAL,
};
public enum ParameterStyle{
BARE,
WRAPPED
};
Style style() default Style.DOCUMENT
Use use() default Use.LITERAL
ParameterStyle parameterStyle() default ParameterStyle.WRAPPED;
};
|
Related reference
Rules for methods in classes annotated with @WebService
Related information
JSR 181: Web Services Metadata for the Java Platform