Arquitectura del Software

Transcripción

1 Tema 7 El Entorno de Programación Restlet sergio.saugar@urjc.es 5 o Ingeniería Informática Univ. Rey Juan Carlos Curso

2 El Entorno de Programación Restlet 1 Introducción Características Arquitectura del Entorno Restlet 2 3 4

3 El Entorno de Programación Restlet 1 Introducción Características Arquitectura del Entorno Restlet 2 3 4

4 El Entorno de Programación Restlet 1 Introducción Características Arquitectura del Entorno Restlet 2 3 4

5 El Entorno de Programación Restlet 1 Introducción Características Arquitectura del Entorno Restlet 2 3 4

6 Características Arquitectura del Entorno Restlet Outline 1 Introducción Características Arquitectura del Entorno Restlet 2 3 4

7 Características Arquitectura del Entorno Restlet Introducción Descripción Creado por Jerome Louvel (Noelios Technologies) Restlet es un framework Desarrollado en Java Software libre Provee un buen mapeo de los principios de REST

8 Características Arquitectura del Entorno Restlet Introducción Desarrollado como respuesta a: Necesidad de un framework simple para construir aplicaciones web RESTful Limitaciones de los Servlets (Greg Wilkins) No existe una clara separación entre aspectos del protocolo y de la aplicación No aprovechan características propias de HTTP, a no ser que lo contemplen los diseñadores de aplicaciones

9 Características Arquitectura del Entorno Restlet Introducción Nota: Estas transparencias han sido desarrolladas en base a: Restlet First Steps y Restlet Tutorial (1.1) [Noelios Technologies(2011)] Charla S.Landis de Overstock.com [Landis(2007)] Ejemplo: Correo Interno Facebook (Tema 6)

10 Características Arquitectura del Entorno Restlet Outline 1 Introducción Características Arquitectura del Entorno Restlet 2 3 4

11 Características Arquitectura del Entorno Restlet Introducción Características[Noelios Technologies(2011)] Los conceptos principales de la arquitectura REST tienen sus correspondientes clases Java (UniformInterface, Resource, Representation, Connector...) Se pueden implementar clientes y servidores de una aplicación utilizando la misma API

12 Características Arquitectura del Entorno Restlet Introducción Características Ofrece un mecanismo de Templates para realizar un enrutamiento sencillo entre los distintos elementos de nuestra aplicación. Los parámetros de las plantillas son codificados en la solicitud como atributos Ofrece un servicio de Tunneling que permite, entre otras cosas, que los browsers puedan emitir cualquier método HTTP encapsulándolo dentro de un método POST. Transparente de cara a la aplicación

13 Características Arquitectura del Entorno Restlet Introducción Características Ofrece la funcionalidad completa de un servidor web Provee varios conectores (Apache HTTP, HTTPS, JDBC...) Soporta distintas representaciones (XML, HTML,...) Maneja distintos esquemas de seguridad (Basic, Digest, Amazon S3, OAuth...)

14 Características Arquitectura del Entorno Restlet Outline 1 Introducción Características Arquitectura del Entorno Restlet 2 3 4

15 Características Arquitectura del Entorno Restlet Arquitectura del Entorno Restlet Arquitectura del Framework - API Genérica (Restlet API) - Plugin de soporte para implentaciones alternativas (SPI) - Implementación de Referencia (Noelios Engine) - Integración con tecnologías externas (JDBC, JSON, gestores plantillas...) - Aplicaciones

16 Outline 1 Introducción Características Arquitectura del Entorno Restlet 2 3 4

17 Programación de Objetos del Dominio Diseño Diseñaremos/Programaremos los objetos propios del dominio de nuestra aplicación (a gusto del consumidor) Seguiremos el ejemplo del Correo Interno de Facebook En nuestro ejemplo, el diseño es trivial y no será comentado Programaremos los objetos del dominio en Java

18 Programación de Objetos del Dominio Ejemplo: Correo Interno Facebook Usuarios Mailbox Folders Ofrecidas por el sistema: Recibidos, Enviados, Borradores s Almacenamiento externo Además, necesitaremos almacenamiento: Storage

19 Programación de los Objetos del Dominio Ejemplo: Correo Interno Facebook

20 Outline Introducción 1 Introducción Características Arquitectura del Entorno Restlet 2 3 4

21 Clase Restlet Provee el interfaz uniforme para todas las subclases Get, Put, Post, Delete Ofrece el contexto software (atributos, logger, parámetros,...) Implementa el ciclo de vida Sus subclases implementan cómo se deben procesar concretamente las peticiones

22 Jerarquía de Clases

23 Clase Resource Es el último manejador dentro del pipeline Es el lugar dónde se integran los objetos del dominio de la aplicación Web Bases de datos, beans, agentes, interacciones, otros servicios, etc. Típicamente es creado por un Finder Selecciona/Negocia las posibles variantes de una representación Puede ser compartido entre diversas llamadas; por lo tanto, habrá que tener cuidado si tenemos multithread

24 Clase Resource Permitir los métodos que se vayan a utilizar: allow*() Sólo GET está activo por defecto Programar tratamiento a los métodos: Reutilizando negociación de contenido: represent(variant) (GET) acceptrepresentation(representation) (POST), storerepresentation(representation) (PUT), removerepresentation() (DELETE), Implementando una negociación de contenido propia handle*()

25 Clase Resource Las llamadas se despachan dinámicamente a los métodos handle*() mediante introspección Dar soporte a un nuevo método (MOVE): Permitir allowmove() Añadir handlemove()

26 Correo Interno Facebook Ejemplo: Diagrama de Clases

27 Correo Interno Facebook Ejemplo: BaseResource public Representation represent (Variant variant ) throws ResourceException { Representation rep = null ; BaseEntity resource = getstorage(). getentity (getrequest().getresourceref(). tostring ()); if ( resource!= null ) { // Obtiene la representación XML de la entidad String stringrep = resource. serializar (); // Genera una representación adecuada a la variante // seleccionada. if ( variant.getmediatype().equals(mediatype.text_xml)) { // Envia la representación XML directamente rep = new StringRepresentation(stringRep, MediaType.TEXT_XML);

28 Correo Interno Facebook Ejemplo: BaseResource else if ( variant.getmediatype().equals(mediatype.text_html)) { // Aplicar la transformación XML > XHTML // StringWriter output = new StringWriter(); // TransformerFactory tfactory = // TransformerFactory.newInstance(); //... // rep = new StringRepresentation(output. tostring (), // MediaType.APPLICATION_XHTML_XML); else { // No es una de las representaciones que puedo ofrecer, // debió existir un error en la negociación de contenido. throw new ResourceException(Status.CLIENT_ERROR_UNSUPPORTED_MEDIA_TYPE);

29 Correo Interno Facebook Ejemplo: BaseResource else { // El objeto no está en el almacenamiento throw new ResourceException(Status.CLIENT_ERROR_NOT_FOUND); return rep ;

30 Correo Interno Facebook Ejemplo: UsersResource public boolean allowpost() { return true ; public void acceptrepresentation(representation entity ) throws ResourceException { // Capturar la información. Viene formateada como un formulario, // pares atributo valor try { Form form = new Form(entity); String nombreusuario = form.getfirstvalue("name"); Users users = (Users) getstorage (). getentity (getrequest().getresourceref(). tostring ()); Mailbox mailbox = users.adduser(nombreusuario);

31 Correo Interno Facebook Ejemplo: UsersResource // Si todo va bien, envía : (201 Created) getresponse(). setstatus (Status.SUCCESS_CREATED); // Location header: getresponse().setlocationref(mailbox. geturi ()); catch (Exception e) { getresponse(). setstatus (Status.CLIENT_ERROR_BAD_REQUEST);

32 Correo Interno Facebook Ejemplo: MailboxResource Metodo Contenido Repres. Acción Codigo GET Lista de folders XML, HTML Devuelve una lista de los folders OK, Not Acceptable definidos por el usuario {userid POST Representación del Folder XML, HTML Crea un folder de correo con nombre determinado Created + Location, Forbidden PUT n/a Method Not Allowed DELETE n/a Method Not Allowed

33 Correo Interno Facebook Ejemplo: MailboxResource public void acceptrepresentation(representation entity ) throws ResourceException { try { // Creamos una nueva carpeta, con el nombre que viene especificado // en el POST Form form = new Form(entity); String nombr box = form.getfirstvalue("name"); Mailbox mailbox = (Mailbox) getstorage(). getentity (getrequest().getresourceref(). tostring (). tostring ()); Folder folder = mailbox.addfolder(nombr box); // Si todo va bien, envía : (201 Created) getresponse(). setstatus (Status.SUCCESS_CREATED); // Location header: getresponse().setlocationref( folder. geturi ()); (...)

34 Correo Interno Facebook Ejemplo: FolderResource Metodo Contenido Repres. Acción Codigo GET Lista mensajes XML, HTML Devuelve una lista de OK, Not los mensajes contenidos Acceptable en el folder {folde- rid POST Mensaje XML, HTML Si {folderid es Enviados se envía el mensaje al usuario indicado en el campo destinatario. Se crea mensaje en enviados Created + Location, Forbidden PUT n/a Method Not Allowed DELETE Elimina el folder {folderid del usuario {userid sólo si fue creado por el usuario y no tiene mensajes OK, Forbidden

35 Correo Interno Facebook Ejemplo: FolderResource public void acceptrepresentation(representation entity ) throws ResourceException { Folder folder = (Folder) getstorage (). getentity (getrequest().getresourceref().getbaseref(). tostring ()); try { // Se obtiene de las " plantillas " del router String remitente = (String) getrequest(). getattributes (). get("userid"); // Hay que leer el correo que nos envía, viene como pares atributo valor. Form form = new Form(entity); String destinatario = form.getfirstvalue (" destinatario "); String asunto = form.getfirstvalue ("asunto"); String cuerpo = form.getfirstvalue ("cuerpo");

36 Correo Interno Facebook Ejemplo: FolderResource = new (folder, remitente, folder.add ( ); destinatario, asunto, cuerpo); if ( folder.getname().equals(users.enviados)) { Folder destinatariofolder = (Folder) Storage. getinstance (). getentity (getrequest().getresourceref().getbaseref(). tostring (). replace (remitente, destinatario ). replace (Users.ENVIADOS, Users.RECIBIDOS)); destinatariofolder.add (new ( destinatariofolder, remitente, destinatario, asunto, cuerpo));

37 Correo Interno Facebook Ejemplo: FolderResource // Si todo va bien, envía : (201 Created) getresponse(). setstatus (Status.SUCCESS_CREATED); // Location header: getresponse().setlocationref( . geturi ()); catch (Exception e) { // Si saltan excepciones porque el destinatario no existe, // entonces: getresponse(). setstatus (Status.CLIENT_ERROR_BAD_REQUEST); public boolean allowdelete () { return true ;

38 Correo Interno Facebook Ejemplo: FolderResource public void removerepresentations() throws ResourceException { Folder folder = (Folder) getstorage (). getentity (getrequest().getresourceref().getbaseref(). tostring ()); if (!( folder.getname().equals(users.borradores) folder.getname().equals(users.enviados) folder.getname(). equals(users.recibidos))) { if ( folder.isempty()) { Mailbox mailbox = (Mailbox) getstorage(). getentity ( folder.getmailbox ()); mailbox. delfolder ( folder ); getstorage (). delentity ( folder. geturi ()); getresponse(). setstatus (Status.SUCCESS_NO_CONTENT); else { getresponse(). setstatus (Status.CLIENT_ERROR_BAD_REQUEST); (...)

39 Correo Interno Facebook Ejemplo: Resource Metodo Contenido Repres. Acción Codigo GET Representacion del correo XML, HTML Devuelve una representación OK, del Not Acceptable correo {mailid POST n/a Method Not Allowed PUT Representacion del correo XML,HTML Actualiza el correo, OK, sólo si es bo- Bad Request rrador DELETE Elimina el correo OK, {mailid de la Forbidden carpeta {folderid del usuario {userid

40 Correo Interno Facebook Ejemplo: Resource public boolean allowput() { return true ; public void storerepresentation (Representation entity ) throws ResourceException { = ( ) getstorage (). getentity (getrequest().getresourceref().getbaseref(). tostring ()); if ( . getfolder (). endswith(users.borradores)) { // Sólo dejamos modificar los correos que están almacenados como borrador // Hay que leer el correo que nos envía, viene como pares atributo valor. Form form = new Form(entity); String destinatario = form.getfirstvalue (" destinatario "); String asunto = form.getfirstvalue ("asunto"); String cuerpo = form.getfirstvalue ("cuerpo");

41 Correo Interno Facebook Ejemplo: Resource . setdestinatario ( destinatario ); .setasunto(asunto); .setcuerpo(cuerpo); // Notifica que la solicitud ha sido realizada. No necesita enviarse // ningún contenido. getresponse(). setstatus (Status.SUCCESS_OK); else { getresponse(). setstatus (Status.CLIENT_ERROR_BAD_REQUEST);

42 Correo Interno Facebook Ejemplo: Resource public void removerepresentations() throws ResourceException { = ( ) getstorage (). getentity (getrequest().getresourceref().getbaseref(). tostring ()); Folder folder = (Folder) getstorage (). getentity ( . getfolder ()); folder. del ( ); getstorage (). delentity ( . geturi ()); // Notifica que la solicitud ha sido realizada. No necesita enviarse // ningún contenido. getresponse(). setstatus (Status.SUCCESS_NO_CONTENT);

43 Clase Representation

44 Correo Interno Facebook Ejemplo: Representaciones XML Una manera cómoda de trabajar con Representaciones XML en JAVA es utilizando JAXB Permite anotar las clases Genera esquemas a partir de anotaciones / clases anotadas a partir de esquemas Serializa/Deserializa objetos JAVA a XML

45 Correo Interno Facebook Ejemplo: Representaciones XML

46 Correo Interno Facebook Ejemplo: Representaciones = " ") public class extends BaseEntity { private String folder ; private String remitente ; private String destinatario ; private String asunto; private String public String getremitente() public String getdestinatario () public String getasunto() {... (...)

47 Correo Interno Facebook Ejemplo: Representaciones XML public String serializar () { try { JAXBContext jc = JAXBContext.newInstance("urjc.arqsoftware.examples.webmail.data"); Marshaller m = jc. createmarshaller (); m.setproperty( Marshaller.JAXB_FORMATTED_OUTPUT, true); ByteArrayOutputStream output = new ByteArrayOutputStream(); m.marshal(this, output); return output. tostring (); catch (JAXBException e) { (...)

48 Clases más relevantes Correo Interno Facebook Ejemplo: Representaciones XML public static Object deserializar ( String s) { Object obj = null ; try { JAXBContext jc = JAXBContext.newInstance("urjc.arqsoftware.examples.webmail.data"); Unmarshaller u = jc. createunmarshaller (); obj = u.unmarshal(new ByteArrayInputStream(s.getBytes())); catch (JAXBException e) { (...) return obj ;

49 Clase Router Restlet para enrutamiento de llamadas hacia alguno de los recursos enlazados (normalmente otro Restlet) attach(pattern, Restlet) Crea una ruta basándose en el patrón de una URI. Se busca la concordancia desde el principio de la referencia al recurso

50 Clase Router: Patrones de URI Especificación de una template (plantilla)sobre la URI Ejemplos de patrones: /users /users/{user_id/mail /users/{user_id/mail/{folder_id /users/{user_id/mail/{folder_id/{ _d

51 Correo Interno Facebook Ejemplo de Router

52 Clase Router Se asigna una puntuación a cada ruta por cada llamada, dependiendo de varios factores. Varios modos de enrutado soportados: Best match (default) Round Robin Random match First, Last and Custom match

53 Ejemplo de enrutado Custom... protected Route getcustom(request request,response response) { // A new router is created Router router = new Router(this.getContext ()); Source source = null ; if (! this.getroutes().isempty()) { // Local Routes ( if any) are served first RouteList list = this.getroutes(); for (Route r : list ) { // Select the first route that matches if (r.gettemplate().match(request.getresourceref(). getrelativeref (). tostring ())!= 1) { return r ;

54 Ejemplo de enrutado Custom (cont.) switch (source) { case INTERACTION: router. attachdefault( RestInteraction. class ); break; case AGENT: router. attachdefault(restagent.class ); break; case RESOURCE: router. attachdefault(restresource. class ); break; case ACTION: router. attachdefault(restaction. class ); break; case EVENTCH: router. attachdefault(resteventchannel.class ); break; default : break; // Return the router with the default route filled. return new Route(router);

55 Clase Application Contiene la lógica de cada aplicación Tiene un Restlet raiz que gestiona las peticiones (Root) Ofrece diversos servicios, que pueden ser redefinidos: connectorservice: para gestionar los conectores cliente-servidor converterservice: para convertir las entidades de los mensajes en objetos de más alto nivel decoderservice: para decodificar o descomprimir las entidades de las peticiones automáticamente

56 Clase Application metadataservice: acceso al servicio de metadatos statusservice: provee representaciones comunes para los códigos de estado tunnelservice: permite encapsular preferencias de representaciones, o métodos HTTP en los parámetros de una solicitud

57 Correo Interno Facebook Ejemplo: Application detalle createroot() public synchronized Restlet createroot() { // En nuestro caso, devolveremos un router que redirigirá las peticiones // a los otros restlets. Router router = new Router(getContext().createChildContext ()); // Define una ruta para el recurso users router.attach("/users", UsersResource. class ); // Define una ruta para el recurso mailbox router. attach("/users/{userid/mail", MailboxResource. class ); // Define una ruta para el recurso folder router.attach("/users/{userid/mail/{ folderid ", FolderResource. class ); // Define una ruta para el recurso router.attach("/users/{userid/mail/{ folderid /{ id", Resource. class ); return router ;

58 Correo Interno Facebook Ejemplo: Detalle aplicación

59 Clase Directory Finder para recursos del sistema de ficheros Negociación automática de contenido similar al servidor Apache Selecciona la mejor representación dependiendo de: variantes disponibles capacidades y preferencias del cliente

60 Ejemplo de Aplicación: Servidor Web Estático (...) component.getclients (). add(protocol.file); Application application = new Application(component.getContext()) public Restlet createroot() { Directory directory = new Directory(getContext(), " file ://" + ROOT); directory. setlistingallowed (true ); directory. setdeeplyaccessible (true ); return directory ; (...)

61 Correo Interno Facebook Ejemplo: Añadiendo directorio para imágenes

62 Clase Filter Impone semántica Antes/Después Permite tratar/modificar la solicitud y reenviarla a otro Restlet Usos: Enrutamiento (Router) Seguridad (Guard) Tratamiento previo de los datos, conversión entre formatos del cuerpo de la petición,...

63 Correo Interno Facebook Ejemplo: Restringiendo el acceso

64 Despliegue Una vez Encapsulada la aplicación como un contenedor (jar o war), se puede ejecutar: Como aplicación de cualquier contenedor estándar de Servlets Tomcat, Jetty Como una aplicación stand-alone Como un servicio nativo utilizando Java Service Wrapper

65 Clase VirtualHost Enruta llamadas desde los conectores Servidor a distintos Restlets (aplicaciones) Se definen en base a: hostref de la solicitud resourceref de la solicitud Mantiene varias aplicaciones sobre el mismo servidor: Misma dirección IP compartida por distintos nombres de dominio Mismo nombre de dominio con balanceo de carga entre distintas direcciones IP

66 Clase Component Permite lanzar nuestra aplicación como stand-alone Gestiona VirtualHosts y Aplicaciones Contiene un default host Permite construir un sistema por capas

67 Correo Interno Facebook Ejemplo: Componente

68 Correo Interno Facebook Ejemplo: Configuración del Componente // Creamos un nuevo componente (servidor web) Component component = new Component(); component.getclients (). add(protocol.http); component.getservers().add(protocol.http, "localhost", 9090); this.setcontext(component.getcontext().createchildcontext ()); // Añadimos esta aplicación al componente dentro del Host por defecto component.getdefaulthost().attach( this ); // Intentamos lanzar el servidor web de esta aplicación try { Storage. getinstance (). addentity(new Users(" localhost :9090" )); component.start (); catch (Exception e) { System.err. println ("ERROR!!! El servidor no ha podido ser lanzado."); e. printstacktrace (System.err ); System.exit( 1);

69 Outline 1 Introducción Características Arquitectura del Entorno Restlet 2 3 4

70 Extensiones Algunas extensiones: Varios conectores: HTTPS, Apache HTTP Client, SMTP, JDBC, FILE... Múltiples representaciones: DOM, SAX, XPath, XSLT Template Engine: Velocity, FreeMarker NIO, Apache Upload Facilidad de integración con: Struts, Spring, JSON, Hibernate, DB4O, GWT...

71

72 S. Landis. Restlet: Lightweight rest framework for java /15/2007, (link revised on March 2011). Noelios Technologies. Restlet - lightweight rest framework for java

73 Tema 7 El Entorno de Programación Restlet sergio.saugar@urjc.es 5 o Ingeniería Informática Univ. Rey Juan Carlos Curso