Taller de Sistemas de Información 2. Web Services

Transcripción

1 Taller de Sistemas de Información 2 Web Services

2 Web Service Es un mecanismo para que aplicaciones cliente y servidor se comuniquen a través de los protocolos de la web (HTTP/HTTPS) Permite que diversas aplicaciones en múltiples tipos de plataformas y frameworks puedan interoperar

3 Tipos de web services Big Web Services Utilizan mensajes XML que siguen el protocolo SOAP (Simple Object Access Protocol) SOAP define la estructura y formato de los mensajes intercambiados Generalmente proveen un documento que permite describir las funciones provistas por el web service (WSDL) Pueden soportar diversos aspectos no funcionales, como ser transaccionalidad, seguridad, confianza, coordinación, etc. Pueden soportar invocaciones y procesamiento asincrono

4 Tipos de web services RESTful Web Services REST es el estilo arquitectónico sobre el que esta basado la web Es apto para mecanismo ad-hoc de integración No requieren el uso de WSDL, SOAP o XML Están muy integrados con el protocolo HTTP Soportan el uso de cache, provisto por las tecnologías de la web Ambas partes deben acordar el contexto y contenido del material intercambiado

5 Tipos de web services JAX-WS Implementación de web services basados en SOAP Permiten cumplir con requisitos de QoS, que generalmente solemos encontrar en ambientes empresariales Permite soportar mas fácilmente que JAX-RS el uso de WS-* JAX-WS Implementación de web services basados en REST Facilitan la integración de soluciones en escenarios simples No caen en el overhead impuesto por los servicios SOAP

6 JAX-WS En JAX-WS una invocación de una operación esta representada en base a un protocolo basado en XML (SOAP) SOAP define la estructura y las convenciones usadas para intercambiar mensajes entre las partes Las llamadas y respuestas son transmitidos como mensajes SOAP, codificados en formato XML Si bien SOAP es complejo, la complejidad de este es abstraída por el uso del API provista en JAX-WS

7

8

9 JAX-WS Esquema de comunicación

10 Requisitos Debemos tener una clase Java anotada Esto define que la clase es el endpoint de un servicio web SEI Service Endpoint Interface Service Endpoint Implementation Declara los métodos que un cliente puede invocar en un servicio El uso de una interfaz Java no es requerido (pero si recomendable) para definición del endpoint Podemos declarar explícitamente una interfaz usando el atributo endpointinterface de la

11 Pasos para crear el web service Servidor Implementamos la clase del servicio Compilamos y empaquetamos en un WAR/JAR según el tipo de implementación Deployeamos el modulo en el servidor web para brindar la funcionalidad Cliente Implementamos la clase del cliente Usamos alguna herramienta para generar los proxies automáticamente (por ejemplo, wsimport de Java) Anexamos las clases generadas al classpath y ejecutamos el codigo

12 Requisitos para el endpoint La clase debe estar anotada La clase puede referenciar explícitamente una SEI a través del atributo endpointinterface de la anotación anterior. Si no se utiliza endpointinterface, se genera una SEI automáticamente a partir de la clase de implementación Los métodos de negocio que se expondrán, deben ser públicos, y no pueden ser static o final Los métodos expuestos al cliente, pueden estar anotados

13 Requisitos para el endpoint Los métodos de negocio que son expuestos al cliente, deben tener tipos JAXB compatibles La clase no puede ser declarada final o abstract La clase debe tener un constructor por defecto La clase no puede implementar el método finalize La clase puede definir los métodos del ciclo de (javax.annotation.postconstruct) (javax.annotation.predestroy)

14 JAXB: Java API for XML Binding

15 JAXB

16 JAXB Si bien el intercambio de información entre el consumidor y proveedor se hace en base a XML, el código Java no tiene porque interactuar con esto directamente JAXB provee un estándar para trabajar con representaciones Java de documentos XML y viceversa Permite que el código Java se abstraiga de la complejidad de validar y manipular documentos XML, junto con su correspondiente representación Java

17

18 Documento XML

19 Schema XML

20

21 Ejemplo Clase de implementación para un servicio de saludos. Cumple con los requisitos antes planteados

22 @WebService Esta anotación también puede ser aplicada sobre la propia interfaz, para hacer que la misma sea la endpointinterface del servicio

23 @WebMethod Por defecto, todos los métodos públicos del web service (o de su interfaz) son incluidos dentro de lo que se expone al exterior Para customizar la forma en como se hace esto (por ejemplo para cambiar el nombre del método), usamos la aplicada sobre el método a modificar Por ejemplo...

24

25 @WebResult Opera en conjunto con la anotación anterior Permite customizar el nombre del mensaje devuelto como resultado de la operación

26 @WebParam Permite customizar los parámetros que son enviados al servicio Podemos cambiar el nombre y el tipo de parámetro

27 @OneWay Es una anotación que permite indicar que un método, no retorna valores Por ejemplo, los métodos que retornan void Esto permite que el container realice optimizaciones con los métodos de este tipo, por ejemplo, usando Asynchronous (solo en EJB)

28 Errores SOAP informa los errores a los consumidores a través de SOAP Faults Son una forma estándar de manejar errores (similares a las excepciones) En el caso de que se produzca una excepción en el servidor, se genera una Fault utilizando el nombre completo de la excepción como mensaje

29 Excepciones También se indica que el error se produce por causa del servidor

30 @WebFault

31 @WebFault

32 Fault obtenida

33 SOAPFactory

34 Ciclo de vida El ciclo de vida de los web services es similar al de los stateless session beans No mantienen ningún estado, simplemente existen o no existen Como en el caso de los stateless, podemos usar las En el caso de un web service implementado como EJB, se pueden utilizar interceptors

35 Ciclo de vida

36 Web Service Context Como en el caso de los EJBs, el web service tiene un contexto que permite obtener información útil del ambiente de ejecución del servicio Se inyecta como en el caso de los EJB,

37 Web Service Context GetMessageContext Permite acceder al mensaje SOAP, por ejemplo para obtener los headers GetUserPrincipal Identifica a traves del Principal al emisor del mensaje IsUserInRole Determina si un usuario autenticado esta presente en un rol determinado

38 Invocando un web service JAX-WS

39 Invocación programática Si estamos fuera del container, podemos invocar programáticamente

40 Invocación programática Requiere que se hayan generado los artefactos Java a partir del WSDL del servicio web Podemos usar la herramienta wsimport provista por Java estándar wsimport <URL al WSDL del servicio> Los artefactos Java generados (clases) deben ser incluidas en el classpath del proyecto

41 Invocación con inyección

42 RESTful Services Son servicios desacoplados, livianos, aptos para crear APIs simples para acceder a las funcionalidades de una aplicación REST es un estilo arquitectónico basado en la idea de la transferencia de representaciones de recursos entre un cliente y un servidor, a través de request/response HTTP REST se basa en una serie de principios generales Identificación de recursos con URIs Interfaz uniforme Mensajes autodescriptivos Interacciones stateful con links

43 Recursos y URIs Los recursos tienen un rol central en REST Un recurso es cualquier cosa con la cual un cliente quiera interactuar, y que sea identificable a través de un hipervínculo Un libro, un perfil, un resultado de una busqueda, etc. Puede almacenarse en cualquier lado Archivo, base de datos, etc.

44 Recursos y URIs Un recurso se identifica por una URI (Uniform Resource Identifier) Una URI es un identificador único para un recurso Esta formada por un nombre y una dirección estructurada en donde localizar dicho recurso

45 Recursos y URIs Algunos ejemplos de URIs

46 URIs Una URI debe ser lo mas descriptiva posible y apuntar a un único recurso El formato estándar de una URI es el siguiente: Un ejemplo: al&time=morning

47 Representaciones Cuando un cliente interactúa con un recurso, siempre lo hace a través de representaciones del mismo El recurso SIEMPRE existe en el servidor Una representación es cualquier información acerca del estado de un recurso

48 Representaciones Un recurso puede tener múltiples representaciones Existen dos formas de seleccionar la representación que queremos A través de una URL especifica A través de negociación de contenido

49 Direccionalidad El objetivo de esta propiedad es que los web services REST deben hacer que la aplicación sea lo mas direccionable posible Esto es, cada pieza de información útil que queramos exponer, debe ser un recurso y a su vez debe tener una URI asociada La URI es la única pieza de información a publicar para que el servicio pueda ser usado

50 Conectividad Si dos recursos se encuentran fuertemente relacionados (a nivel conceptual), entonces debe existir un enlace (link) entre estos Los web services REST deben aprovechar esta facilidad de los hyperlinks, para informar a los clientes que hay disponible mas información y como debe hacerse para acceder a esta

51 Conectividad Por ejemplo, si obtenemos la información de un CD, podemos a su vez acceder a información relacionada

52 Interfaz uniforme El protocolo de facto es el HTTP La interfaz esta compuesta por los métodos HTTP GET, POST, PUT y DELETE El destinatario de las acciones es la URI del recurso con el que se quiere interactúa Facilita enormemente la interoperabilidad entre sistemas

53 Estado En REST se diferencia generalmente entre el estado del recurso y el estado de la aplicación El estado del recurso, se mantiene en el servidor, siendo compartido por todos El estado de la aplicación es mantenido en el cliente, siendo de su única propiedad y responsabilidad Tiene múltiples ventajas en el manejo de la performance de la aplicación

54 HTTP Es el protocolo base de la web Esta orientado a documentos, en base a un protocolo textual

55 HTTP Request Elementos importantes El método HTTP: GET La ruta (path): /java?limit=all&mode=list Una serie de headers: User-Agent

56 HTTP Response

57 HTTP Response Aspectos importantes El código de respuesta: 200 OK Múltiples headers: Date, Server, Content-Type Representación (o entidad body): Es el cuerpo de la respuesta Generalmente en un browser se recibe el texto HTML de la pagina que queremos ver

58 Headers

59 Métodos HTTP GET Equivalente a un READ POST Equivalente a un INSERT PUT Equivalente a un UPDATE DELETE Equivalente a un.. DELETE!

60 Métodos HTTP Algunos aspectos importantes GET debe ser seguro, esto es, no debe cambiar el estado del recurso GET debe ser idempotente, debiendo retornar el mismo resultado si se lo llama una o N veces (si no cambia en el medio de las llamadas) DELETE es idempotente, pero no es seguro PUT y POST no son seguros

61 Negociación de contenido Consiste en elegir la mejor representación cuando para un mismo recurso existen múltiples representaciones disponibles Esta basada en los siguientes headers del request: Accept, Accept-Charset Accept-Encoding, Accept-Language User-Agent

62 Negociación de contenido Por ejemplo, si utilizamos la siguiente URI para acceder a información sobre libros de Java Podemos indicar En Accept el media type text/csv, para indicar que queremos una representación CSV de los datos Podemos usar Accept-Language para indicar en, para a su vez pedir el CSV en ingles

63 Content Types HTTP utiliza los Internet Media Types (también conocidos como MIME Types) Se especifican en los headers Content-Type y Accept Se dividen en 5 categorías top-level text, image, audio, video y application Estas se dividen en subtipos text/html, text/plain, image/gif, application/json

64 Códigos de estado Permiten devolver al cliente información de la solicitud, tanto en caso de éxito como de fallo 1xx: Informativos 2xx: Éxito 3xx: Dirección 4xx: Error del cliente 5xx: Error del servidor

65 Códigos de estado Códigos 1xx : Mensajes Conexión rechazada Códigos 2xx: Operación realizada con éxito 200 OK Información no oficial 204 Sin Contenido 205 Contenido para recargar 206 Contenido parcial

66 Códigos de estado Códigos 3xx: Redirección 301 Mudado permanentemente 302 Encontrado 303 Vea otros 304 No modificado 305 Utilice un proxy 307 Redirección temporal

67 Códigos de estado Códigos 4xx: Error por parte del cliente 400 Solicitud incorrecta 402 Pago requerido 403 Prohibido 404 No encontrado 409 Conflicto 410 Ya no disponible 412 Falló precondición

68 Códigos de estado Códigos 5xx: Error del servidor 500 Error interno 501 No implementado 502 Pasarela incorrecta 503 Servicio no disponible 504 Tiempo de espera de la pasarela agotado 505 Versión de HTTP no soportada

69 JAX RS Para escribir un servicio web que utilice REST, solo se necesita un cliente y un servidor que soporte HTTP Como en el caso de SOAP, a fin de eliminar el trabajo con protocolos de bajo nivel, aparece el API JAX-RS La implementación de referencia de esta API, se denomina Jersey (es un proyecto open source)

70 JAX RS Si bien los conceptos anteriores pueden hacer pensar que tenemos que manipular la información a bajo nivel usando los protocolos anteriores, esto no es asi JAX-RS es un API bastante elegante que permite especificar un recurso, en base a un POJO Usamos la sobre una clase Java que representa un recurso

71

72 JAX RS En el ejemplo anterior, el recurso BookResource esta publicado en la URI /book El método getbooktitle() queda asociado al método GET HTTP, produciendo un contenido de tipo text/plain Para acceder al recurso, solo debemos usar un browser con la dirección

73 JAX RS El servicio REST no implementa ninguna interfaz ni extiende ninguna clase Debemos usar la Si queremos usar un EJB, entonces solo podemos La clase debe ser public, y no abstract ni final Debe contener un constructor por defecto La clase no debe incluir el método finalize()

74

75 Interfaz de acceso al recurso JAX-RS define una serie de anotaciones, para indicar que método HTTP se utilizara para acceder a un recurso Estas anotaciones corresponden a los métodos Solo los métodos públicos de una clase pueden exponerse como métodos de recurso

76

77 Interfaz de acceso al recurso Cuando un método de recurso es invocado Los parámetros para los cuales hay un extractor, son cargados con dicho valor Los valores de parámetros no anotados, llamados entity parameters, es mapeado del cuerpo del request, a traves de un entity provider Los métodos pueden devolver void, un tipo Java o un Response Response es usado cuando es necesario devolver mas información (metadatos) en la respuesta

78 Información contextual Cuando un request es atendido, el recurso puede necesitar para llevar adelante su tarea, acceder a información de contexto La es usada para inyectar una referencia a objetos de tipo: HttpHeaders, UriInfo, Request, SecurityContext, y Providers

79

80 Manejo de excepciones En un método de recurso, en cualquier momento podemos propagar una excepción al exterior del recurso Esta excepción debe ser del tipo WebApplicationException, o una subclase de esta La excepción será capturada por el runtime de JAX-RS, convirtiéndola en una HTTP Response apropiada

81 Manejo de excepciones El error por defecto es un error 500 con un mensaje en blanco La clase WebApplicationException ofrece varios constructores que permiten modificar esto El enumerado javax.ws.rs.core.response.status contiene valores que podemos utilizar al momento de construir una excepción

82

83 Providers Para simplificar el manejo de excepciones, podemos usar un Provider Este permite mapear Excepciones en Responses

84 Ciclo de vida

85 HelloWorld Creamos una web application Para exponer recursos REST, necesitamos una implementación de REST (JAX-RS) En el caso de EAP/Wildfly, utilizamos RESTEasy Esta es una implementación que ya viene incorporada en el servidor Necesitamos que el web.xml sea versión 3.0

86 web.xml <web-app version="3.0" xmlns=" xmlns:xsi=" xsi:schemalocation=" </web-app>

87 HelloWorldResource

88 HelloWorld Luego de creado el recurso, deployeamos y ejecutamos la aplicacion web Accedemos al recurso, a traves de la URL Deberiamos obtener Hello World!!

89 PathParam Permite extraer pedazos de la URL package ejemplos; import public class public String helloworld(@pathparam("name") final String name) { return "Hi!, how are you " + name; } }

90 PathParam Como antes, se deployea y ejecuta la aplicacion Debemos entrar a la URL: Deberiamos obtener: Hi!, how are you Pablo

91 Intercambio de XML Podemos intercambiar objetos XML, tanto para el resultado como para los parametros Para esto debemos usar providers JAXB (idem SOAP), que se encarguen de mapear instancias en documentos XML Por ejemplo, vamos a intercambiar objetos Java, Items

92

93 ItemResource package ejemplo; import public class ItemResource @Produces({ "application/xml" }) public Item getitem() { Item item = new Item("IPhone5", 1500); return item; }

94 ItemResource Si ejecutamos la aplicacion, al especificar application/xml, se utilizara el provider adecuado para obtener este XML <item> <description>iphone5</description> <price>1500</price> </item>

95 @FormParam Esta anotacion sirve para extraer informacion de un formulario <html> <body> <form method="post" action="login"> Address: <input type="text" name=" "><br> Password: <input type="text" name="password"><br> <br> <input type="submit"> </form> </body> </html>

96 @FormParam package ejemplos; import javax.ws.rs.formparam; import javax.ws.rs.post; import public class LoginResource public String String String password) { return "Ingreso con el " + + " y el password " + password; }

97 @QueryParam Es muy similar al anterior, solo que al usarlo, se trata de extraer el valor el query parameter con el nombre public String String idvalue) { return "Id es " + idvalue; } de proyecto>/login?id=12345

98 Consumo y producción de tipos JAX-RS define una serie de tipos Java que pueden representar diferentes tipos de recursos Por ejemplo: String, InputStream y beans anotados con se aplican a recursos que pueden tener diferentes tipos de representaciones

99 Consumo y producción de tipos Estas anotaciones definen los media types intercambiados entre el cliente y el servidor JAX-RS utiliza como abstracción de un media type la clase: javax.ws.rs.core.mediatype Esta tiene una serie de constantes que definen los media types producidos y consumidos por un recurso para un determinado método

100

101 Podemos aplicar las anotaciones a nivel del recurso o de un método especifico

102 Tipos retornados Un servicio REST puede retornar Cualquier tipo Java estándar Un bean JAXB Cualquier cosa que tenga una representación textual que pueda ser enviada por HTTP En el ultimo caso, el runtime determina el media type de lo que se devuelve, invocando el Entity Provider apropiado (para obtener su representación textual)

103 Tipos retornados El runtime determina el código de retorno apropiado para devolver al cliente 204 No content, si el método devuelve null o void 200 Ok, si el método devuelve una respuesta no nula Sin embargo, hay veces en que necesitamos un control mas fino de lo que se devuelve En esos casos, usamos la Response API

104

105 Response API Provee un API para construir una respuesta (HTTP Response) como retorno de un método del recurso Permite controlar el tipo de entidad devuelto, así como headers y banderas de control que forman el paquete de respuesta Es la forma recomendada de retornar información de un método de un recurso

106

107 Response API Response.ok().build(); Response.ok().cookie(new NewCookie( "SessionID", "5G79GDIFY09") ).build(); Response.ok("Plain Text").expires( new Date()).build(); Response.ok( new Customer ("John", "Smith"), MediaType.APPLICATION_JSON ).build();

108 Response API Response.noContent().build(); Response.accepted( new Customer("John", "Smith", " ") ).build(); Response.notModified().header( "User-Agent", "Mozilla ).build();

109 Construcción de URIs JAX-RS provee la clase javax.ws.rs.core.uribuilder como medio para la construcción de URIs Provee una serie de métodos que permiten construir una URI a un recurso en forma segura, incluyendo parámetros enviados al recurso

110 Construcción de URIs

111 Entity Providers El rol de un Entity Provider es el de proveer un mapeo entre las representaciones y tipos Java esperados y devueltos por los recursos Por ejemplo, JAXB mapea objetos Java en XML y viceversa Si lo provisto por defecto no es suficiente, podemos provee un mapeo por customizado, a través de un entity provider

112 Entity Providers Un entity provider customizado, provee una forma de leer y escribir el formato customizado, hacia y desde un tipo Java especifico Tenemos dos tipos de Entity Providers MessageBodyReader MessageBodyWriter

113

114

115 Entity Providers Una vez definidos ambos providers, podemos utilizar el formato customizado en los recursos o métodos del mismo

116 Client API Antes de JAX-RS 2.0 no existía una forma estándar de invocar servicios web REST Esta API permite realizar invocaciones a servicios REST a través de HTTP en forma simple Las clases necesarias para construir un cliente REST se encuentran en el package javax.ws.rs.client

117 Client API Clases e interfaces necesarias para construir un cliente

118 Client Es la interfaz de entrada al API Esta permite gestionar y configurar conexiones HTTP Permite crear WebTargets para recursos y enlaces Usamos el objeto ClientBuilder para crear una instancia de Client Client client = ClientBuilder.newClient();

119 Client Por ejemplo, podemos crear un cliente y asociarle un provider definido convertir tipos específicos Client client = ClientBuilder.newClient(); client.configuration().register(customcustomerreader.class).setproperty("myproperty", 1234);

120 Targets e invocaciones Con el cliente podemos crear WebTargets Estos representa una URI contra la cual podemos enviar requests y recibir responses Por ejemplos WebTarget target = client.target(" URI uri = new URI(" "); WebTarget target = client.target(uri);

121 Targets e invocaciones Con el WebTarget creado, podemos crear una invocación Esta permite enviar solicitudes utilizando un método especifico Invocation invocation = target.request().buildget() Según el tipo de interacción, podemos crear solicitudes mas complejas

122 Targets e invocaciones

123 Invocaciones Una vez que tenemos la invocación, debemos realizar la llamada Ejecutamos el método invoke, obteniendo como respuesta un objeto de tipo Response Por ejemplo: Response response = invocation.invoke();

124 Poniendo todo junto

125 Responses Permite obtener la información enviada desde el servicio REST Podemos obtener Headers Cookies Status HTTP Message Body (Entidad)

126 Responses Utilizando un MessageBodyReader podemos obtener la entidad, convertida al tipo Java que el reader mapee Por ejemplo, si especificamos que queremos un String, JAX-RS utilizara un StringReader String body = response.readentity(string.class); Pero si por ejemplo, recibimos un Book en formato XML, podemos hacer: Book book = response.readentity(book.class);