Utilización de anotaciones para crear servicios web

Con la API de Java™ para servicios web basados en XML, puede utilizar anotaciones en el código Java para simplificar la creación de servicios web.

El estándar de programación de la API de Java para servicios web basados en XML (JAX-WS) se basa en el uso de anotaciones para especificar los metadatos que están asociados con las implementaciones de servicio web. El estándar también se basa en las anotaciones para simplificar el desarrollo de servicios web. Las anotaciones describen dos aspectos de los servicios web: cómo se accede a una implementación de servicio del lado del servidor como un servicio web y cómo accede una clase Java del lado del cliente a los servicios web.

El estándar de programación JAX-WS da soporte a la anotación de clases Java con los metadatos que se utilizan para definir una aplicación de punto final de servicio como un servicio web y especificar cómo puede acceder un cliente al servicio. El estándar JAX-WS da soporte al uso de anotaciones que se basan en varias solicitudes de especificación Java (JSR): Utilizando las anotaciones del estándar JSR 181, puede anotar una clase de implementación de servicio o una interfaz de servicio. A continuación, puede generar un servicio web con un asistente o publicando la aplicación en un servidor. El uso de anotaciones en el código fuente de Java y las clases Java simplifica el desarrollo de servicios web. Si utiliza anotaciones de esta forma, define más información de la que generalmente se obtiene de los archivos de descriptor de despliegue, los archivos WSDL (lenguaje de descripción de servicios web) o correlacionando los metadatos de XML y WSDL con los artefactos de origen.

Puede utilizar las anotaciones para configurar enlaces y cadenas de manejadores, así como para establecer nombres de tipo de puerto, servicio y otros parámetros WSDL. También puede utilizar las anotaciones en el tiempo de compilación para correlacionar Java con WSDL y el esquema, y en el tiempo de ejecución para controlar cómo se procesa el tiempo de ejecución de JAX-WS y responde a las invocaciones de servicios web.

El producto utiliza anotaciones en los clientes que crea mediante el asistente de cliente de servicios web. El asistente genera un proxy de cliente y una clase de servicio estática con las anotaciones. Estas anotaciones especifican cómo accede el cliente al servicio web.

Para obtener información detallada sobre las anotaciones que puede utilizar, consulte la referencia relacionada.

Escenarios soportados de servicios web basados en anotaciones

Los siguientes escenarios de servicios web están soportados por las herramientas y los entornos de ejecución de WebSphere:

Tabla 1. Entornos de ejecución soportados. Escenarios de entornos de ejecución soportados por servicios web basados en anotaciones.
Escenario Entorno de ejecución Comentarios
Bean Java ascendente WebSphere Application Server v7.0 y posteriores Puede ejecutarse utilizando únicamente anotaciones o en combinación con los asistentes de servicios web. Si el bean ya tiene una anotación @javax.jws.WebService, muchos de los campos del asistente estarán inhabilitados porque el asistente no necesita generar un bean delegado. Sólo podrá seleccionar la generación de un archivo WSDL. Si sólo ha añadido @javax.jws.WebService al bean Java y desea habilitar otras opciones como, por ejemplo, un enlace SOAP 1.2 o MTOM, salga del asistente y eliminar la anotación, o continuar para crear el servicio web utilizando la documentación de las anotaciones. El asistente no permite añadir nuevas anotaciones a un bean anotado parcialmente existente.
EJB 2.x ascendente Ninguno No está soportado utilizando anotaciones.
EJB 3.0 ascendente WebSphere Application Server v7.0 y posteriores No puede utilizar una combinación de anotaciones y el asistente de servicios web. Debe utilizar las anotaciones y desplegar el bean EJB en el servidor de aplicaciones.
Bean Java medio WebSphere Application Server v7.0 y posteriores Este escenario permite correlacionar un bean Java anotado por un servicio web con un documento WSDL utilizando el atributo wsdlLocation.
Nota: si desea utilizar SOAP 1.2:
@javax.xml.ws.BindingType (value=javax.xml.ws.soap.SOAPBinding.SOAP12HTTP_BINDING) 
debe especificar el atributo wsdlLocation de la anotación @WebService, como en el ejemplo siguiente:
@javax.jws.WebService (targetNamespace="http://p/", ..., wsdlLocation="WEB-INF/wsdl/EchoService.wsdl")
No puede utilizar el archivo WSDL generado dinámicamente por WebSphere Application Server, sino que debe tener un archivo WSDL creado previamente. De manera alternativa, puede utilizar el asistente de servicios web, que genera un archivo WSDL automáticamente si selecciona utilizar SOAP 1.2 cuando genera un servicio web a partir de un bean Java.

Para obtener más información, consulte Creación de un servicio web a partir de un bean Java y un archivo WSDL.

EJB 3.0 medio WebSphere Application Server v7.0 y posteriores Este escenario permite correlacionar un bean EJB anotado por un servicio web con un documento WSDL utilizando el atributo wsdlLocation.

Para obtener más información, consulte Creación de un servicio web a partir de un bean EJB y un archivo WSDL.

Ejemplo

Por ejemplo, puede incorporar un código @WebService en el origen Java para exponer un bean como un servicio web.
@WebService 

public class QuoteBean implements StockQuote {

       public float getQuote(String sym) { ... }

}

La anotación @WebService indica al entorno de ejecución del servidor que exponga todos los métodos públicos en el bean como un servicio web. Puede controlar más niveles de granularidad añadiendo otras anotaciones en métodos o parámetros individuales. La utilización de anotaciones facilita la exposición de artefactos Java como servicios web. Asimismo, como crea los artefactos utilizando algunas de las herramientas de correlación en sentido descendente que se inician desde un archivo WSDL, las anotaciones se incluyen en el origen y las clases Java como una forma de capturar los metadatos junto con los archivos de origen.

Icono que indica el tipo de tema Tema de conceptos
Términos y condiciones para centros de información | Comentarios

Icono de indicación de fecha y hora Última actualización: 22 de abril de 2014

Nombre de archivo: cwsandoc001.html