Generación de código de cliente de ejemplo para un recurso a JAX-RS 2.0

Puede generar código de cliente de ejemplo para un recurso Java™ API for RESTful Web Services (JAX-RS) a partir de una dirección de proyectos REST.

Antes de empezar

Importante: Aplicable a Liberty
Lleve a cabo la siguiente configuración para WebSphere Application Server Developer Tools for Eclipse:
  • Añada el tiempo de ejecución de Liberty a las preferencias.
  • Cree un servidor de Liberty en la vista Servidores.
  • Cree un proyecto web con uno o varios servicios REST que se han definido en el proyecto. De lo contrario, si no define ningún servicio, el nodo REST no tendrá hijos.

Procedimiento

  1. Expanda su_proyecto_REST > Servicios > REST.
  2. Pulse el botón derecho del ratón en uno de sus hijos y seleccione Generar > Cliente de JAX-RS. Se visualiza el diálogo Cliente de JAX-RS 2.0.
    1. En el campo Origen de datos, acepte el valor predeterminado o especifique la carpeta de destino del cliente generado.
    2. En el campo Nombre, acepte el valor predeterminado o especifique el nombre de clase Java del cliente.
    3. En el campo Paquete, acepte el valor predeterminado o especifique el nombre del paquete Java del cliente.
    4. Seleccione los recursos que desee utilizar para generar el código del cliente.
    5. Genere una clase de filtro nueva.
      1. Seleccione Generar filtro de cliente JAX-RS.
      2. Acepte el valor predeterminado o especifique el nombre de la clase de filtro.

      Esta opción crea una clase de básica (bare-bones) que implementa las interfaces ClientRequestFilter y ClientResponseFilter a partir del paquete javax.ws.rs.client de JAX-RS 2.0. Puede completar los detalles de implementación para los métodos de interfaz tras generar la nueva clase de filtro.

  3. Opcional: Para generar clases JAXB y el cliente en el mismo proyecto, seleccione Utilizar esquema XML para la generación de JAXB.

    El método de recursos del servicio JAX-RS puede tener clases JAXB como argumentos de método o tipos de retorno. Si no dispone de la fuente JAXB, pero sí dispone del esquema XML, puede generar las clases JAXB de forma que el código cliente pueda acceder a las mismas.

    1. Pulse Siguiente.

      Se visualiza el diálogo Cliente de JAX-RS con JAXB.

    2. Opcional: En el campo Paquete Java de destino de JAXB, proporcione el paquete Java que desee utilizar para las clases JAXB generadas.

      Este valor se pasa al compilador de enlaces o a la herramienta Arquitectura Java para XJC (XML Binding Compiler) con la opción -p.

    3. Pulse Examinar... para ir hasta el archivo XSD desde donde desee generar la clase JAXB.

      También puede especificar el archivo XSD en el Esquema XML. Este valor pasa al compilador de enlaces o a la herramienta XJC con la opción -b.

    4. Opcional: Para proporcionar archivos de enlace JAXB definidos por el usuario, seleccione Especificar archivos de enlace JAXB.

      Si selecciona esta opción, puede pulsar Añadir para añadir los archivos de declaración de enlaces personalizados. También puede eliminar los archivos resaltándolos y seleccionando a continuación Eliminar.

    5. Opcional: Para permitir las extensiones de proveedor, seleccione Permitir extensiones de proveedor.

      Esta opción podría ser necesaria para procesar algunos documentos de esquema XML. Este valor pasa al compilador de enlaces, o la herramienta XJC, con la opción -extension.

  4. Pulse Finalizar.

Resultados

Ha generado código de cliente de ejemplo para un recurso JAX-RS.

Si ha completado el paso opcional para generar clases JAXB, también ha generado las clases JAXB en el mismo proyecto que su cliente JAX-RS.

También ha generado un archivo de clases Java nuevo utilizando la API de cliente JAX-RS 2.0 que se puede utilizar para acceder al servicio JAX-RS. Cada método anotado del servicio JAX-RS tiene su respectivo método cliente JAX-RS, que se genera a partir de las anotaciones en los métodos de servicio JAX-RS. Los métodos de servicio JAX-RS incluyen @PathParam; @QueryParam; @Consumes; @Produces; @Path; y los métodos de recurso como, por ejemplo, @GET, @PUT o @POST.

Restricción: Todas las clases que se ven afectadas por el algoritmo de generación de cliente JAX-RS deben adherirse a las siguientes restricciones:
  • Estas clases deben ser una serie, un primitivo, una clase de API JAX-RS o una clase de usuario que se anota mediante Java Architecture for XML Binding (JAXB). Estas clases no pueden ser binarios.
  • Todas las clases deben hallarse en formato origen para que el algoritmo las localice. Si las clases no se hallan en el mismo proyecto que el servicio JAX-RS, no se podrá generar el cliente JAX-RS.

Qué hacer a continuación

Añada código al ejemplo para que funcione el código de cliente y cumpla las necesidades de código de cliente JAX-RS 2.0. Para probar el ejemplo, añada el código de cliente a un JSP o a un servlet. Su código de cliente debe hallarse en un contenedor de servlet porque no hay soporte para aplicaciones Java autónomas. Tras trabajar con el código cliente de JAX-RS 2.0, utilice el código cliente para iniciar el servicio de JAX-RS 2.0.
Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: t_jaxrs_scc_jaxrs.html