API-INTERFAZ DE PROGRAMACIÓN Y GENERACIÓN DE COMPONENTES PARA SWB CURSO: CURSO API

Transcripción

1 API-INTERFAZ DE PROGRAMACIÓN Y GENERACIÓN DE COMPONENTES PARA SWB CURSO: CURSO API

2

3 API-INTERFAZ DE PROGRAMACIÓN Y GENERACIÓN DE COMPONENTES PARA SWB Curso: Curso API

4 Fondo de Información y Documentación para la Industria Av. San Fernando #37 Col. Toriello Guerra Del. Tlalpan México DF

5 El Copyright y las Marcas registradas INFOTEC WebBuilder, SemanticWebBuilder, el personaje Semius y demás logotipos, emblemas y características distintivas, así como elementos relacionados son propiedad de INFOTEC Fondo de Información y Documentación para la Industria, Centro de Investigación CONACYT. Reservados todos los derechos. Queda estrictamente prohibido bajo las sanciones establecidas en las leyes, la reproducción parcial o total de esta obra por cualquier medio o procedimiento de alquiler o préstamos públicos de ejemplares de la misma, sin la autorización escrita de INFOTEC Fondo de Información y Documentación para la Industria, Centro de Investigación CONACYT.

6 Prologo SemanticWebBuilder (SWB) es una plataforma tecnológica desarrollada en INFOTEC, un Centro de Investigación y Desarrollo Tecnológico del CONACYT, por lo que es un producto hecho en México y por mexicanos que tiene como propósito principal el brindar los elementos y utilerías necesarias para permitir una construcción rápida y simple de Sitios y Portales Web Semánticos, así como desarrollo de aplicaciones con características semánticas. La idea principal de aplicar Semántica a los Sitios y Portales Web o mejor dicho incorporarle Semántica a Internet, es permitir que la información pueda ser definida con un significado específico, de forma que conforme se le van incorporando descripciones y propiedades a cada elemento de información este pueda tener más aspectos que lo distingan de los demás y lo puedan identificar mejor, logrando con ello que pueda ser fácilmente consultado, interpretado y procesado ya sea por personas o incluso por otras aplicaciones y sistemas, es decir por maquinas. Esta característica de la semántica que hace que la información tenga un mayor significado y en consecuencia sea fácilmente consultada por personas o sistemas, implica que el intercambio e integración de información sea de forma más natural sin importar el lugar físico donde se encuentre la información o la forma en que haya sido procesada originalmente. Esto implica que podremos realizar una consulta de información y la respuesta será más completa y adecuada a nuestro criterio de búsqueda, pues la fuente de consulta podrá ser leída, interpretada e integrada a partir de la información publicada por diferentes organizaciones, a múltiples niveles técnicos y/o humanos, permitiendo con ello obtener información más completa y adecuada a los requerimientos específicos de cada usuario en la red. INFOTEC CONACYT FIDEICOMISO. i

7 INFOTEC CONACYT FIDEICOMISO. ii

8 Índice de Contenidos Prologo... i Índice de Contenidos... iii Acerca de este manual... v Objetivos... v Convenciones usadas en este manual... vi Acerca del administrador de SemanticWebBuilder... viii Comenzando a trabajar... xi SEMANTICWEBBUILDER... 1 SUITE DE HERRAMIENTAS DE SEMANTICWEBBUILDER... 1 SemWB Portal... 1 SemWB End Point... 2 SemWB Platform... 2 AppServer... 2 SemWB Triple Store... 2 SemWB Base... 2 ARQUITECTURA DE SEMANTICWEBBUILDER... 4 Componentes... 8 SWBPortal... 8 SWBForms... 8 SWBModel... 8 SWBPlatform... 9 Cache y Sincronización... 9 SWBTripleStore... 9 SWBBase... 9 Servidor de Aplicaciones... 9 INTRODUCCIÓN AL API DE PROGRAMACIÓN DE RECURSOS DE SEMANTICWEBBUILDER RECURSO CICLO DE VIDA DE UN RECURSO MODOS DE UN RECURSO TIPOS DE RECURSOS MÉTODOS DE LLAMADA API INFOTEC CONACYT FIDEICOMISO. iii

9 INTERFAZ SWBResource Método init() Método render() Método processaction() Método setresourcebase() Método getresourcebase() Método install() Método uninstall() Método destroy() GENERIC RESOURCE INCORPORACIÓN DE UN RECURSO A SEMANTICWEBBUILDER INCORPORACIÓN DE LOS OBJETOS RESOURCE, WEB PAGE, USER, SWBRESOURCEURL QUE INTERACTÚAN CON LA CLASE GENERIC RESOURCE Objeto Resource Objeto WebPage Objeto User OBJETO SWBResourceURL INCORPORACIÓN DE MODOS PERSONALIZADOS DE UN RECURSO A SEMANTICWEBBUILDER INCORPORACIÓN DEL MÉTODO DE LLAMADA DIRECT A SEMANTICWEBBUILDER INCLUSION DE SERVLET/JSP INTERNACIONALIZACIÓN DE UN RECURSO ANEXOS CAMBIOS DE WB3 A SWB SEMANTICWEBBUILDER BASE INFOTEC CONACYT FIDEICOMISO. iv

10 Acerca de este manual Este manual fue realizado con el objetivo de poder crear recursos personalizados para extender la funcionalidad de SemanticWebBuilder. El API cuenta con una serie de clases e interfaces que impulsan el esquema Open Source para que los desarrolladores contribuyan a la competitividad del gobierno y de las pymes, para lograr el uso estratégico de SWB e impulsar la transición de México hacia la sociedad de la información y conocimiento En él se muestra la creación de recursos básicos, utilizando las clases e interfaces principales que auxiliaran en la creación de recursos más complejos. Objetivos General: Al finalizar el curso el alumno podrá crear sus propios recursos utilizando las clases e interfaces del API de SemanticWebBuilder. Obtendrá un conocimiento general de la plataforma que le ayudara a resolver sus necesidades de manejo y manipulación de información como desarrollador. Específicos: Al finalizar el curso el alumno creara recursos que podrán visualizarse y administrarse desde la plataforma de SemanticWebBuilder. INFOTEC CONACYT FIDEICOMISO. v

11 Convenciones usadas en este manual Las siguientes convenciones son utilizadas en este manual para representar diferentes elementos de capacitación y recursos alternativos de aprendizaje: Iconos Sabias Que Indica comentarios al margen en los que se extenderá el tema expuesto mediante recomendaciones o tips que mejoren el aprovechamiento de la herramienta Consideraciones Importantes Exponen puntos importantes que deben tenerse en cuenta para la correcta operación de las utilerías. Nota Indica Información adicional que puede ayudarle a aprovechar mejor la funcionalidad expuesta. Referencia Indica la necesidad de consultar otro documento o dirección Web en donde se encontrara mayor información sobre el tema expuesto. Procedimiento Guiado Indica que se comenzara la descripción paso a paso de la operación de un proceso. Ejercicio Guiado A partir de este punto se comenzara la ejecución de un ejercicio que deberá realizar el usuario de manera guiada paso a paso con el manual. Resultado Expone el efecto final correcto de una operación o procedimiento. Diagnostico Por características de la tecnología involucrada, se generan resultados no deseados. Aquí se indicara como resolverlo. Improcedente Indica situaciones tecnológicas en las que no es posible realizar una operación o que requiere de algún proceso alterno para obtener el resultado deseado. Cuidado Indica que existe alguna información restringida o con derechos reservados. INFOTEC CONACYT FIDEICOMISO. vi

12 Convenciones Tipográficas Arial 26 Negrita, es utilizada como titulo de tema Calibri 14 color Azul Énfasis Negrita, es utilizada para los títulos de tema Calibri 12 color Azul Énfasis 1 negrita, es utilizada para destacar subtemas Arial 11, es utilizada como fuente principal para el cuerpo del texto <Times New Roman 11> es utilizada para descripción de configuraciones o código Arial 10 negrita color azul con recuadro y sombreado azul indica temas a resaltar y/o puntos importante en los que el lector debe prestar especial atención Arial 10 en color azul con recuadro azul y sombreado azul, se utiliza para denotar puntos importantes en los que el lector debe prestar atención especial INFOTEC CONACYT FIDEICOMISO. vii

13 Acerca del administrador de SemanticWebBuilder Para accesar a la administración de SemanticWebBuilder (SWB) es necesario que en el URL agregue al final swbadmin, como se muestra a continuación: Portal Publico Administración del sitio Nota: El contexto swb indicado aquí puede ser opcional y cambiar de una instancia de SWB a otra dependiendo de la configuración especifica establecida en cada caso. A continuación se mostrará la ventana de identificación (login) de SemanticWebBuilder, en donde deberá proporcionar su usuario, su contraseña, para después presionar el botón entrar: El administrador de SemanticWebBuilder (SWB) tiene diferentes zonas o áreas de trabajo en las cuales se presentan los elementos y componentes mediante los cuales es posible incorporar los diferentes recursos de configuración y administración con los que puede desarrollar y dar mantenimiento a su Sitio Web. Las diferentes Zonas que se localizan en el sitio Administrador de SemanticWebBuilder se detallan en las imágenes siguientes: INFOTEC CONACYT FIDEICOMISO. viii

14 Barra de Menús Acordeone s de Estructura Zona de Trabajo Descripción En esta barra se contienen las opciones generales de la administración de la herramienta En esta zona se mostraran en pestañas expandibles (Acordeones) diversos elementos de configuración de la estructura de los sitios generados en la herramienta, así como herramientas y funcionalidades de operación general. Área en la que se despliega el detalle de la información, elementos de configuración y administración de los elementos de SWB INFOTEC CONACYT FIDEICOMISO. ix

15 Catálogos de Estructura Zona de Información Pestañas de Elementos Pestañas de Configuración de Elemento Barra Emergente de Estatus Zona de Trabajo y Configuración Descripción Se denomina Catalogo de Estructura de a cada uno de los acordeones, donde se localizaran diversos catálogos de elementos que permiten la administración especifica de los diferentes recursos de SWB Esta zona mostrara la información básica del componente o recurso seleccionado en los acordeones de estructura. También se le conoce como la zona de metadatos del elemento. En esta zona se mostraran las pestañas de administración de cada uno de los componentes que sean abiertos dentro de SWB de forma que se pueda pasar de uno a otro sin perder la información o cambios que se hubieran efectuado en otro componente. A segundo nivel en la zona de Pestañas de Elementos se muestran las pestañas de administración especifica del componente seleccionado, permitiendo la configuración a detalle de cada componente en el SWB Esta barra se mostrara de manera emergente en la parte inferior de la pantalla de Administración de SWB y mostrara mensajes sobre el éxito o no de la operación realizada Muestra el detalle de cada aspecto de configuración de las Pestañas de Configuración de Elementos, de forma que pueda trabajar con cada recurso y lo configure de acuerdo a sus requerimientos. INFOTEC CONACYT FIDEICOMISO. x

16 Comenzando a trabajar API INTERFAZ DE PROGRAMACIÓN Y GENERACIÓN DE COMPONENTES PARA SWB INFOTEC CONACYT FIDEICOMISO. xi

17 SEMANTICWEBBUILDER SemanticWebBuilder (SWB) es una plataforma para el desarrollo de aplicaciones y portales semánticos. El uso de la tecnología semántica permite generar contextos de información y definirles un significado, de esta forma la información es interpretada y procesada por personas y/o sistemas. Establecer un significado a la información expuesta en un portal, permite una mejor clasificación, integración y búsqueda de la información. SWB cuenta con una suite de herramientas y con una estructura operacional descrita en su arquitectura. A continuación se describirán estas dos áreas. SUITE DE HERRAMIENTAS DE SEMANTICWEBBUILDER La Suite de herramientas de SemanticWebBuilder permitirá la evolución de los sitios web convencionales (sin significado) hacia portales que cumplan con la visión de la web semántica (con significado), permitiendo exponer en formatos estándar como RDF todo el conocimiento generado, además de contar con un modelo (Ontología) que permita el intercambio de esta información entre los diferentes sistemas. La suite del SemanticWebBuilder está formada por los siguientes productos: SemWB Portal SemWB Portal es una plataforma para el desarrollo de portales semánticos, en donde la información o contenido a desplegar se define de forma que pueda ser interpretada y procesada por personas y/o sistemas. Este producto se enfoca en la representación del conocimiento de las organizaciones a través de la identificación de la semántica en la información a publicar. INFOTEC CONACYT FIDEICOMISO. 1

18 SemWB End Point Herramienta que permite tener acceso a la información de una organización por medio de RDF y SPARQL. SemWB Platform Plataforma para el desarrollo de productos semánticos. Es la base para el desarrollo de la plataforma de desarrollo de portales (SemWB Portal). AppServer Servidor de aplicaciones donde se ejecuta SWB. SemWB Triple Store Herramienta para almacenar y hacer búsquedas sobre los triples de RDF. El objetivo es integrar un triple store existente OS, utilizando JENA. SemWB Base SemanticWebBuilder Base (Midas), es un conjunto de estándares abiertos, componentes, metodologías, librerías, utilerías, convenciones y buenas prácticas que sirven de base en el desarrollo de aplicaciones, contemplando las siguientes premisas: La reutilización de código El desarrollo acelerado Estandarización Seguridad Escalabilidad Disponibilidad Interoperabilidad Algunos de los productos que integran la suite de SemanticWebBuilder constan de herramientas que facilitan su funcionamiento, en seguida se muestra un esquema: INFOTEC CONACYT FIDEICOMISO. 2

19 SemWB Portal Servidor de Portales Administración de Contenidos Administración de Contextos de Información Administración de Usuarios SemWB Platform Plataforma Semántica Punto de Acceso para Consultas Semánticas (SPARQL) Integración de Información (Fuentes externas) Persistencia de Datos (RDF) Generación de Código Basado en Ontologías SemWB Ontology Editor Modelado de Información (Definición de Significados) Editor de Ontologías (OWL) Los productos Platform y Portal tienen interacción directamente con el creador del portal. En Platform se lleva a cabo la generación de código dada por una ontología definida, la cual determina la estructura de la información; la arquitectura de los objetos, sus dependencias y su representación gráfica; incluyendo el guardado de información en una base de datos semántica en forma persistente. Platform es el punto de acceso para realizar consultas semánticas, es decir, la información es expuesta para ser consultada por sistemas externos como WS o SPARQL. Portal se encarga de la interfaz gráfica del sitio web que incluye una arquitectura de información la cual define el diseño estructural de los datos. Una serie de componentes que son requeridos para la interfaz como banners, chats, publicación de documentos, redes sociales, blogs, entre otros. Y finalmente la presentación del sitio web en diferentes idiomas y dispositivos (PC, PDA o teléfono móvil). La siguiente figura esquematiza estos conceptos: INFOTEC CONACYT FIDEICOMISO. 3

20 Niveles de Objetos para el producto SemWBPlatform La plataforma semántica maneja una organización jerárquica de objetos, este nivel jerárquico esta hecho en base a la función que desempeñan. A continuación se listan estos objetos: SemWB Base: Este objeto es la base de SWB y se encarga de manejar las utilerías e I/O; control de errores en Logs, manejo XML (Extensible Markup Language), Connection Pool. RDF Library: Es el segundo nivel y contiene las librerías RDF (Resource Description Framework) el cual es un modelo de datos que representa recursos y relaciones que se puedan establecer entre ellos. SemWB Triple Store: Es el tercer nivel, es una herramienta que almacena y realiza búsquedas sobre triplas RDF usando el framework de JENA SemWB Platform: Es el cuarto nivel, y se encarga de la construcción de modelos semánticos. La unión entre el objeto SemWB Triple Store y SemWB Platform la realizan la Sincronización de aplicaciones y el mantenimiento en memoria cache de SWB INFOTEC CONACYT FIDEICOMISO. 4

21 Core Model: Es el quinto nivel y mantiene las ontologías que definen a SWB. Se modela una Ontología, se genera código y finalmente se personaliza código. Core Model mantiene el código generado Niveles (Core Model) Ontología Código Autogenerado Código Personalizado SemWB Platform Cache, Sincronización SemWB Triple Store RDF Library SemWB Base Niveles de Objetos para el producto SemWBPortal La jerarquía de objetos para el producto SemWBPortal consta de los mismos niveles que para el producto SemWBPlatform con dos objetos adicionales, a continuación se muestra la jerarquía: SemWB Base RDF Library SemWB Triple Store SemWB Platform Core Model SWBForms: Este nivel, mantiene las tecnologías para implementar los formularios como AJAX, DOJO y XForms SWBPortal: Este nivel se encarga de la administración de usuarios, reportes, monitoreos, reglas, grupos, roles, componentes, plantillas, lenguajes, dispositivos, campañas, entre otros. Componentes: Este nivel muestra los recursos en el sitio web INFOTEC CONACYT FIDEICOMISO. 5

22 INFOTEC CONACYT FIDEICOMISO. 6

23 ARQUITECTURA DE SEMANTICWEBBUILDER La arquitectura de SWB define el diseño conceptual y la estructura operacional de SemanticWebBuilder. La arquitectura consta de los siguientes elementos: SWBPortal, SWBForms, SWBModel, SWBPlatform, SWBTripleStore, SWBBase, Servidor de Aplicaciones y Cache Sincronización. INFOTEC CONACYT FIDEICOMISO. 7

24 Los Componentes La capa de componentes muestra los elementos que se pueden incrustar dentro de una página web con la finalidad de darle presentación, funcionalidad e interactividad. Esta capa es la visualización de la plataforma de SemanticWebBuilder que permite la creación de portales. SWB ofrece: SWBPortal Recursos (componentes) tal como Banners, Survey, Search, Comments, Blogs, entre otros. Administración de comunidades Implementación de Portlets Externos y Gadges. Implementación de estándares JSR-168 y JSR-288 y el API Open Social Administración de recursos en el sitio a través de su manejador de recursos (Resource Manager). Administración de recursos en memoria, Resource Cache. Seguimiento de recursos empleando el Resource Trace. Extensión de recursos estándar utilizando el API para el desarrollo de Componentes a través de SWBPortal Este elemento tiene las siguientes funciones: Administración de reportes, monitoreo, reglas, grupos, roles, usuarios, componentes, plantillas, lenguajes, dispositivos, campañas, DNS s, contenidos, sitios, alarmas, paginas, flujos de publicación, entre otros. Manejo de Web Services (interfaz en xml), el cual permite generar interfaces con otro software para intercambiar datos. El web service determina el proceso de ligado con otras aplicaciones en tiempo de ejecución. Manejo de documentos Semántico (JSR-170). Seguridad JAAS. Manejo del repositorio de Usuarios. Administración y seguimiento de usuarios. SWBForms Este elemento es un manejador de formularios. Estos formularios utilizan algunas tecnologías para implementarse tal como: SWBModel AJAX (Asynchronous JavaScript And XML) DOJO Page Flow XForms Este elemento consta de las ontologías que definen a SemanticWebBuilder, las ontologías son las siguientes: Ontología Office, define el esquema para la publicación con Office. INFOTEC CONACYT FIDEICOMISO. 8

25 Ontología del Repositorio de Documentos (JSR-170) que define la estructura para el manejo de documentos. Ontología Base SemanticWebBuilder, la cual define las clases e interfaces que sirven como base para SWB. SWBPlatform Este elemento se encarga de desarrollar la construcción de modelos semánticos. Generador de Código RESTful Web Services, conocido como Rest(Representation state transfer), es un modelo de servicios web basados en HTTP; donde los recursos son accedidos por una URI Bridge (Semántica-Java), técnica que desacopla una abstracción de su implementación. OWL (Ontology Web Language), ontología que define el vocabulario de SWB Cache y Sincronización Este elemento permite mantener en cache a SWB y la sincronización entre aplicaciones. SWBTripleStore Este elemento permite: SWBBase Realizar Búsquedas (SPARQL) Almacenar en forma Semántica (SDB, TDB) Persistencia RDF, DB, FS Este elemento es la base para SWB, es un conjunto de estándares abiertos, componentes, metodologías, librerías, utilerías, convenciones y buenas prácticas. Manejo de XML Manejo de Logs Connection Pool Utilerías I/O Servidor de Aplicaciones Este elemento es el servidor en el que está montado SWB. INFOTEC CONACYT FIDEICOMISO. 9

26 INTRODUCCIÓN AL API DE PROGRAMACIÓN DE RECURSOS DE SEMANTICWEBBUILDER RECURSO Un recurso es un componente dentro de un sitio o portal web que permite la interacción, cercanía, retroalimentación y usabilidad con el usuario, ejemplos de recursos en SemanticWebBuilder son los chats, foros, banners, comentarios, registro de usuarios, buscadores, menús, encuestas, entre otros. Un recurso permite la comunicación entre el usuario y el sitio. El recurso tiene un ciclo de vida y cuenta con modos que definen las tareas que ejecutara. Se clasifica de acuerdo a su ubicación dentro del sitio web, ya sea en la plantilla o en el contenido. La forma de extender de SemanticWebBuilder es a través de la interface SWBResource que pertenece al API, esta interfaz se encarga de definir los métodos para implementar y administrar un recurso. A continuación se muestra un diagrama de flujo de las relaciones: Install Init setresourcebase HandleRequest Destroy Unistall CONTENT STRATEGY DIRECT View Admin Edit Help XML Index Admhlp MÉTODOS DE LLAMADA CICLO DE VIDA MODOS RECURSO TIPOS DE PETICIÓN TIPOS API ProcessAction Render Contenido Estrategia Sistema Interfaz SWBResource Clase GenericResource INFOTEC CONACYT FIDEICOMISO. 10

27 CICLO DE VIDA DE UN RECURSO El ciclo de vida de un recurso es: Install: Este método es llamado una sola vez, cuando el recurso es agregado al catálogo de recursos. Init: Este método inicializa el recurso y lo agrega al servicio, adicionalmente es llamado cada vez que inicia SWB o bien cuando el recurso es recargado utilizando carga dinámica de recursos. setresourcebase: Es llamado cada vez que se modifica alguno de los atributos del recurso a través de la administración del recurso. Handle requests: Procesa las acciones Action y renderrequest. Destroy: Este método es llamado cuando el recurso es eliminado del servicio. Uninstall: Este método es convocado cuando el recurso es eliminado del catálogo de recurso. MODOS DE UN RECURSO Los modos de un recurso indican la función que el recurso atenderá. Usualmente los recursos ejecutan diferentes tareas y crean diferente contenido, dependiendo de la función que ejecutan. Los modos del recurso avisan al recurso que tarea realizará y cual contenido debe generar. Cuando se invoca un recurso SemanticWebBuilder indica al recurso cual modo se ejecutará. El recurso puede cambiar programáticamente su modo cuando se está ejecutando el método processaction. Los modos por defecto son View, Admin, Edit, Help, XML, Index, Admhlp; un recurso debe soportar al menos el modo View. El modo Admin es usado para modificar los atributos de configuración del recurso y es invocado utilizando la administración de SemanticWebBuilder. El modo View es utilizado para visualizar el recurso en el sitio web. El programador del recurso puede agregar modos adicionales dependiendo de la lógica del recurso. TIPOS DE RECURSOS Los recursos están clasificados en 3 tipos que son: Contenido, Estrategia y Sistema, la diferencia radica básicamente en la ubicación en la que son llamados y presentados dentro del administrador de SemanticWebBuilder y dentro de los Templates. Recurso tipo Contenido: Estos recursos pueden ser creados tanto por el administrador Web como por el administrador.net en la sección de contenidos y son presentador por el tag <content/> dentro de los templates. INFOTEC CONACYT FIDEICOMISO. 11

28 Recurso tipo Estrategia: Estos recursos sólo pueden ser creador por el administrador.net en la sección de elementos publicitarios y son presentados por el tag <resource/> dentro de los templates. Recurso tipo Sistema: Estos recursos pueden ser utilizados como contenidos y/o estrategias, por lo que pueden crearse por los dos administradores y pueden presentarse con ambos tags <content/>, <resource/> dentro de los templates. Nota. Cuando un recurso es creado como contenido este queda asociado a la sección en donde fue creado. MÉTODOS DE LLAMADA Los métodos de llamada en SemanticWebBuilder para invocar un recurso son los siguientes: Content: Esta llamada invoca al recurso para mostrarse como contenido en una página web. Algunos ejemplos de contenido en una página web son elementos creados en Word, Excel, Power Point, HTML, documentos PDF, entre otros. Strategy: Este método invoca al recurso para visualizarlo como contenido base en una plantilla. Ejemplo de estos recursos son los banners, menús, textos estáticos, promos, entre otros recursos. Direct: Este método permite invocar un recurso sin pasar por la plantilla, de esta forma se puede regresar una imagen o un archivo binario con el comportamiento de un Web Service. Tiene el comportamiento de un servlet pero con las ventajas de seguridad, monitoreo, calendarización entre otras que proporciona un recurso. API El API de desarrollo de SemanticWebBuilder fue introducido por la versión 2.0 de la aplicación WebBuilder y, en la nueva versión semántica, su objetivo fundamental es proporcionar una serie de clases e interfaces que nos permitan extender la funcionalidad de SemanticWebBuilder de forma estándar. En la figura siguiente podemos observar la localización del API dentro de la arquitectura de SemanticWebBuilder. INFOTEC CONACYT FIDEICOMISO. 12

29 INFOTEC CONACYT FIDEICOMISO. 13

30 La base del API de desarrollo de SWB es la interfaz SWBResource, que es la que nos permite extender la funcionalidad de SemanticWebBuilder, así como las clases: GenericResource, SWBParamRequest, SWBActionResponse, SWBResourceURL, Resource, WebPage, User las cuales interactúan directamente con el recurso al momento de implementar la interfaz SWBResource. En la siguiente figura podemos ver la estructura de estas clases. Objeto Web Page Objeto Resource Objeto User WebSite ResourceType getwebsite getresourcetype WebPage Resource User getwebpage getresourcebase getwebpage getresourcebase getuser SWBParamRequest getuser getresourcebase SWBActionResponse getactionurl getrenderurl render processaction SWBResourceURL GenericResource Implementa SWBResource Extiende Nuevo Recurso Objeto SWBResourceURL INTERFAZ SWBResource Una interfaz en java, es un conjunto de métodos (sin implementaciones) y de valores constantes que indican que una clase tiene un comportamiento particular además del que hereda de sus superclases. La interfaz SWBResource es la que define los métodos que una clase debe implementar para poder ser considerado como un recurso que pueda ser administrado por SemanticWebBuilder. La estructura de la interfaz SWBResource es la siguiente: INFOTEC CONACYT FIDEICOMISO. 14

31 package org.semanticwb.portal.api; import javax.servlet.http.httpservletrequest; import javax.servlet.http.httpservletresponse; import org.semanticwb.model.resource; import org.semanticwb.model.resourcetype; public interface SWBResource public void setresourcebase(resource base) throws SWBResourceException; public void init() throws SWBResourceException; public Resource getresourcebase(); public void processaction(httpservletrequest request, SWBActionResponse actionresponse) throws SWBResourceException, java.io.ioexception; public void render(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, java.io.ioexception; public void install(resourcetype resourcetype) throws SWBResourceException; public void uninstall(resourcetype resourcetype) throws SWBResourceException; public void destroy(); La interfaz implementa los métodos setresourcebase, init, getresourcebase, processaction, render, install, uninstall y destroy. Estos métodos tienen la funcionalidad siguiente: Método init() Este método es llamado cuando es cargado el recurso en memoria (sólo es llamado una vez). Método render() Este es el método principal del recurso ya que es llamado en cada solicitud de despliegue del recurso por lo que se encarga de la presentación del recurso. Este método recibe los siguientes parámetros: Request: Este es el HttpServletRequest asociado con la petición, y nos permite tener acceso a los parámetros de la petición(mediante getparameter), el tipo de petición(get, POST, HEAD) y las cabeceras HTTP entrantes(cookies, Referer) INFOTEC CONACYT FIDEICOMISO. 15

32 Response: Este es el HttpServletResponse asociado con la respuesta al cliente. SWBParamRequest: Es el objeto que proporciona información sobre el estado del recurso. Adicionalmente permite acceder a objetos internos como User, WebPage y Action. User: Este objeto provee información acerca del usuario que visualiza el recurso. WebPage: Este objeto proporciona la sección del sitio en donde se encuentra el recurso. Adicionalmente se puede obtener las secciones relacionadas con dicha sección, padres, hijos o asociaciones. Action: Este objeto provee las acciones que puede llevar a cabo el recurso, tal como editar, añadir o eliminar. Excepción SWBResourceException: Se presenta en el momento en que ocurre un problema con la acción del recurso. Excepción IOException: Este objeto proporciona información si sucede algún problema I/O con el procesamiento de streams. Método processaction() Este método permite procesar una acción que fue solicitada al recurso. Típicamente es la respuesta a una solicitud de una acción. Este método es convocado si el llamado fue originado por un URL creado con el método SWBParamRequest.getActionURL(). El recurso actualiza su estado basado en la información enviada en el parámetro actionresponse. En esta acción el recurso puede: Enviar un redireccionamiento. Cambiar su estado de la ventana. Cambiar el modo del recurso. Asignar parámetros al render. La solicitud hacia un actionurl es enviada a un processaction y a un número de renders, los cuales dependen del número de recursos por cada sección. El procesamiento de la acción es finalizado antes que el request sea invocado. Este método recibe los siguientes parámetros: Request: Es el parámetro HttpServletRequest asociado con la petición, la cual nos permite tener acceso a los parámetros (mediante getparameter), el tipo de petición (GET,POST,HEAD, etc) y las cabeceras HTTP entrantes(cookies, Referer, etc). SWBActionResponse: Proporciona información referente al estado del recurso adicionalmente da acceso a objetos como User, WebPage y Params. INFOTEC CONACYT FIDEICOMISO. 16

33 User: Este objeto provee información acerca del usuario que visualiza el recurso. WebPage: Este objeto proporciona la sección del sitio en donde se encuentra el recurso. Adicionalmente se puede obtener las secciones relacionadas con dicha sección, padres, hijos o asociaciones. Action: Este objeto provee las acciones que puede llevar a cabo el recurso, tal como Editar, añadir o eliminar. Excepción SWBResourceException: Este objeto maneja los errores si ocurre un problema con el procesamiento de la acción. Excepción IOException: Este objeto proporciona información si sucede algún problema I/O con el procesamiento de streams. Método setresourcebase() Este método es llamado para proporcionar información del recurso que SemanticWebBuilder requiere para su administración. Adicionalmente es convocado cada vez que el recurso es modificado desde la administración de SemanticWebBuilder. Este método recibe un parámetro de objeto Resource que contiene información por defecto como id, titulo, descripción, tipo, subtipo, campaña, fecha de creación, entre otras propiedades. El método se encarga de guardar la referencia del objeto Resource para su posterior utilización. Método getresourcebase() Este método obtiene la información base o por defecto del recurso y devuelve la referencia al objeto Resource solicitado. Método install() Este método es llamado cuando se instala el recurso en SemanticWebBuilder. Es utilizado si el recurso requiere configuración específica, tal como la creación de un directorio de trabajo o alguna tabla adicional en la base de datos. Método uninstall() Este método es convocado cuando se desinstala el recurso en SemanticWebBuilder. Método destroy() Este método es llamado por el SWBServiceMgr para indicarle al recurso cuando va a ser retirado del servicio. INFOTEC CONACYT FIDEICOMISO. 17

34 GENERIC RESOURCE El API incluye la clase GenericResource que implementa la interface SWBResource y provee la funcionalidad por defecto del recurso. package org.semanticwb.portal.api; import javax.servlet.http.httpservletresponse; import javax.servlet.http.httpservletrequest; import java.io.ioexception; import java.util.locale; import org.semanticwb.swbutils; import org.semanticwb.model.resourcetype; import org.semanticwb.model.resource; import org.semanticwb.model.swbcontext; import org.semanticwb.model.website; public class GenericResource implements SWBResource, SWBResourceCache, SWBResourceWindow private Resource base; public GenericResource() public void destroy() public Resource getresourcebase() return base; public void init() throws SWBResourceException public void install(resourcetype recobj) throws SWBResourceException public void processaction(httpservletrequest request, SWBActionResponse response) throws SWBResourceException, IOException throw new SWBResourceException("method not implemented"); public void render(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException INFOTEC CONACYT FIDEICOMISO. 18

35 if(!paramrequest.winstate_minimized.equals(paramrequest.getwindowstate())) processrequest(request, response, paramrequest); public void processrequest(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException if(paramrequest.getmode().equals(paramrequest.mode_view)) doview(request,response,paramrequest); else if(paramrequest.getmode().equals(paramrequest.mode_edit)) doedit(request,response,paramrequest); else if(paramrequest.getmode().equals(paramrequest.mode_help)) dohelp(request,response,paramrequest); else if(paramrequest.getmode().equals(paramrequest.mode_admin)) doadmin(request,response,paramrequest); else if(paramrequest.getmode().equals(paramrequest.mode_admhlp)) doadminhlp(request,response,paramrequest); else if(paramrequest.getmode().equals(paramrequest.mode_index)) doindex(request,response,paramrequest); else if(paramrequest.getmode().equals(paramrequest.mode_xml)) else doxml(request,response,paramrequest); throw new SWBResourceException("method not implemented - Mode:("+paramRequest.getMode()+"), URL:("+request.getRequestURL()+"), Ref:("+request.getHeader("referer")+")"); public void doview(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException throw new SWBResourceException("method not implemented - doview"); public void doedit(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException throw new SWBResourceException("method not implemented - doedit"); INFOTEC CONACYT FIDEICOMISO. 19

36 public void dohelp(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException throw new SWBResourceException("method not implemented - dohelp"); public void doadmin(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException java.io.printwriter out = response.getwriter(); out.println("<div class=\"swbform\">"); out.println("<table width=\"100%\" border=\"0\" cellspacing=\"0\" cellpadding=\"5\">"); out.println("<tr>"); out.println("<td class=datos>"); out.println(swbutils.text.getlocalestring("org.semanticwb.portal.api.genericresou rce", "msgnotadmin",new Locale(paramRequest.getUser().getLanguage()))); out.println("</td>"); out.println("</tr>"); out.println("</table>"); out.println("</div>"); public void doadminhlp(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException throw new SWBResourceException("method not implemented - doadminhlp"); public void doindex(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException doview(request, response, paramrequest); public void doxml(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException throw new SWBResourceException("method not implemented - doxml"); public void setresourcebase(resource base) throws SWBResourceException this.base=base; public void uninstall(resourcetype recobj) throws SWBResourceException public String getresourcecacheid(httpservletrequest request, SWBParamRequest paramrequest) throws SWBResourceException if (request.getparameternames().hasmoreelements()) INFOTEC CONACYT FIDEICOMISO. 20

37 else return null; Resource base=paramrequest.getresourcebase(); return SWBResourceCachedMgr.getKey(base); public String[] getmodes(httpservletrequest request, SWBParamRequest paramrequest) throws SWBResourceException, java.io.ioexception WebSite tm=swbcontext.getadminwebsite(); if(tm!=null) if(paramrequest.getuser().hasusergroup(swbcontext.getadminrepository ().getusergroup("admin"))) return new String[]paramRequest.Mode_VIEW,paramRequest.Mode_ADMIN; return new String[]paramRequest.Mode_VIEW; public String gettitle(httpservletrequest request, SWBParamRequest paramrequest) throws SWBResourceException, java.io.ioexception return paramrequest.getwindowtitle(); public String[] getwindowstates(httpservletrequest request, SWBParamRequest paramrequest) throws SWBResourceException, java.io.ioexception return new String[]paramRequest.WinState_MINIMIZED, paramrequest.winstate_normal, paramrequest.winstate_maximized; public boolean windowsupport(httpservletrequest request, SWBParamRequest paramrequest) throws SWBResourceException, java.io.ioexception if(!paramrequest.getadmintopic().getwebsiteid().equals(swbcontext.website_a DMIN)) if(paramrequest.getresourcebase().isresourcewindow()) return false; return true; INFOTEC CONACYT FIDEICOMISO. 21

38 La clase GenericResource implementa el método render y luego invoca a su propio método processrequest el cual determina en base al modo de recurso cual es el método apropiado a invocar: doview para VIEW, doedit para EDIT, etc. INCORPORACIÓN DE UN RECURSO A SEMANTICWEBBUILDER Los requisitos para agregar un recurso en SemanticWebBuilder son: Extender de la clase GenericResource Implementar por lo menos el método View El siguiente ejercicio consiste en crear una clase llamada HolaMundo.java que extienda de GenericResource y que implemente el modo DoView, el cual es llamado cada vez que se despliega el recurso. La clase pertenecerá al paquete cursoswb. package cursoswb; import java.io.ioexception; import java.io.printwriter; import javax.servlet.http.httpservletrequest; import javax.servlet.http.httpservletresponse; import org.semanticwb.portal.api.genericresource; import org.semanticwb.portal.api.swbparamrequest; import org.semanticwb.portal.api.swbresourceexception; public class HolaMundo extends GenericResource public void doview(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramsrequest) throws SWBResourceException, IOException PrintWriter out = response.getwriter(); out.println("<pre>"); out.println("<font face=comic Sans MS,arial,verdana>"); out.println("<font size=6>"); out.println(" "); out.println("hola Mundo"); out.println("</font>"); out.println("</pre>"); Una vez creada y compilada la clase, copiar el archivo HolaMundo.class en la carpeta clases dentro del directorio WEB-INF en la ruta de instalación de SemanticWebBuilder. Un recurso puede ser agregado a SWB como componente de Contenido, de Estrategia o de Sistema, en este ejercicio se agregara como tipo Contenido. Dentro del administrador de SemanticWebBuilder, dar click con el botón derecho del mouse sobre la opción de Componentes de Contenido y elegir Agregar Tipo de Recurso como se muestra en la figura siguiente: INFOTEC CONACYT FIDEICOMISO. 22

39 Agregar los datos del recurso como título, tipo de recurso, identificador y nombre de la clase que lo implementa, incluyendo el paquete al que pertenece dicha clase. Editar la sección de Home y en la pestaña de Contenidos, seleccionar Agregar Nuevo, en la lista aparecerá el recurso que se implemento. Seleccionarlo y guardar. INFOTEC CONACYT FIDEICOMISO. 23

40 Asignar un nombre a la nueva instancia del componente, editar los componentes de descripción y activar el contenido. Al finalizar el procedimiento se debe visualizar la siguiente pantalla: Nota: Otra forma de agregar las clases compiladas es construyendo el archivo JAR y copiándolo a la carpeta lib que se encuentra en WEB-INF dentro de swb. INFOTEC CONACYT FIDEICOMISO. 24

41 INCORPORACIÓN DE LOS OBJETOS RESOURCE, WEB PAGE, USER, SWBRESOURCEURL QUE INTERACTÚAN CON LA CLASE GENERIC RESOURCE Objeto Resource El objeto Resource es un objeto que pertenece al paquete model de la librería SWBModel. Está encargado de proporcionar a los SWBResources (recursos de usuario) la información por defecto que requiere SemanticWebBuilder para administrar el recurso. A continuación se muestra el código de PropiedadesRecurso.java: package cursoswb; import java.io.ioexception; import java.io.printwriter; import javax.servlet.http.httpservletrequest; import javax.servlet.http.httpservletresponse; import org.semanticwb.swbplatform; import org.semanticwb.portal.api.genericresource; import org.semanticwb.portal.api.swbparamrequest; import org.semanticwb.portal.api.swbresourceexception; import org.semanticwb.model.resource; public class PropiedadesRecurso extends GenericResource public void doview(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramsrequest) throws SWBResourceException, IOException PrintWriter out=response.getwriter(); Resource base=paramsrequest.getresourcebase(); out.println("<pre>"); out.println("<font face=comic Sans MS size=5>propiedades de un Recurso</font><br>"); out.println("<b>id: </b>" + base.getid()); out.println("<b>titulo:</b> "+ base.gettitle()); out.println("<b>descripción:</b> "+base.getdescription()); out.println("<b>prioridad:</b> "+base.getpriority()); out.println("<b>tipo ID(ESTRATEGIA, CONTENIDO O SISTEMA):</b> " + base.getresourcetype().getresourcemode()); out.println("<b>tipo NAME:</b> " + base.getresourcetype().gettitle()); out.println("<b>xml:</b> " + base.getxml()); out.println("<b>xmlconf:</b> "+ base.getxmlconf()); out.println("<b>resourceworkpath:</b> "+base.getworkpath()); out.println("<b>ruta FISICA:</b> " + SWBPortal.getWorkPath()+base.getWorkPath()); out.println("<b>ruta WEB:</b> "+ SWBPlatform.getWebWorkPath()+base.getWorkPath()); out.println("<pre>"); INFOTEC CONACYT FIDEICOMISO. 25

42 Compilar la clase y copiarla a las clases de SWB. Dar de alta el recurso en el administrador de SemanticWebBuilder como se muestra a continuación: La visualización del recurso es la siguiente: Objeto WebPage Este objeto proporciona información de una sección dentro del sitio, así como la relación que tiene con las demás secciones (padres, hijos y secciones asociadas). Este objeto se puede utilizar para crear un recurso que implemente un menú o un índice temático. Recurso menú WebPage El siguiente ejercicio utiliza el objeto Web Page para implementar un menú con las secciones de un sitio web. Para visualizar el ejercicio, el sitio debe tener secciones hijas y nietas. A continuación se muestra el código que implementa este objeto: INFOTEC CONACYT FIDEICOMISO. 26

43 package cursoswb; import java.io.ioexception; import java.io.printwriter; import java.util.iterator; import javax.servlet.http.httpservletrequest; import javax.servlet.http.httpservletresponse; import org.semanticwb.model.user; import org.semanticwb.model.webpage; import org.semanticwb.portal.api.genericresource; import org.semanticwb.portal.api.swbparamrequest; import org.semanticwb.portal.api.swbresourceexception; public class Menu1 extends GenericResource public void doview(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException PrintWriter out = response.getwriter(); WebPage page = paramrequest.getwebpage(); User user = paramrequest.getuser(); out.println(paramrequest.getresourcebase().gettitle()); out.println("<ul>"); //Obtiene la url de la pagina web padre if(page.getparent()!=null) out.println("<li><a href=\""+ page.getparent().geturl()+ "\">"+page.getparent().getdisplayname(user.getlanguage())+"</a></li>"); out.println("<li><b>"+page.getdisplayname(user.getlanguage())+"</b></li>"); //Obtiene los hijos activos, ordenados y no borrados Iterator<WebPage> it = page.listvisiblechilds(user.getlanguage()); while(it.hasnext()) WebPage tp = it.next(); if(user.haveaccess(tp)) out.println("<li><a href=\""+ tp.geturl()+"\">"+ tp.getdisplayname(user.getlanguage())+"</a></li>"); out.println("</ul>"); La visualización de este ejercicio se muestra a continuación: INFOTEC CONACYT FIDEICOMISO. 27

44 Recurso menú WebPage con formato El siguiente recurso implementa un menú con formato (color, tamaño y tipo de letra). El formato lo obtiene a través de los argumentos que envía la solicitud. A continuación se muestra el código que implementa este formato: package cursoswb; import java.io.ioexception; import java.io.printwriter; import java.util.iterator; import javax.servlet.http.httpservletrequest; import javax.servlet.http.httpservletresponse; import org.semanticwb.model.user; import org.semanticwb.model.webpage; import org.semanticwb.portal.api.genericresource; import org.semanticwb.portal.api.swbparamrequest; import org.semanticwb.portal.api.swbresourceexception; public class Menu2 extends GenericResource public void doview(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException PrintWriter out = response.getwriter(); WebPage page = paramrequest.getwebpage(); User user = paramrequest.getuser(); String font="<font face=\""+ paramrequest.getargument("fontface", "Arial")+"\" size=\""+ paramrequest.getargument("fontsize", "4")+ "\"color=\""+ paramrequest.getargument("fontcolor", "#000000")+ "\">"; String fontc="</font>"; out.println(font+paramrequest.getresourcebase().gettitle()+fontc); out.println("<ul>"); if(page.getparent()!=null) out.println("<li>"+"<a href=\""+ page.getparent().geturl()+ "\">"+ font+page.getparent().getdisplayname(user.getlanguage())+fontc+"</a></li>"); out.println("<li>"+font+"<b>"+page.getdisplayname(user.getlanguage())+fontc+"</b> </li>"); Iterator<WebPage> it = page.listvisiblechilds(user.getlanguage()); while(it.hasnext()) WebPage tp = it.next(); if(user.haveaccess(tp)) out.println("<li>"+"<a href=\""+tp.geturl()+"\">"+font+ tp.getdisplayname(user.getlanguage())+fontc+"</a></li>"); out.println("</ul>"); En seguida se muestra como se vera el recurso en pantalla: INFOTEC CONACYT FIDEICOMISO. 28

45 El formato para el color de fondo y tipo, tamaño y color de letra, pueden ser modificados desde el Administrador de SWB, si han sido dados de alta como recursos de Estrategia, a través de la siguiente instrucción: Recurso menú WebPage administrable El siguiente recurso extiende de la clase GenericAdmResource que permite editar el formato de presentación del menú desde el Administrador de SemanticWebBuilder. Los cambios al formato son guardados en un archivo XML, los cuales son cargados cada vez que se edita el recurso. A continuación se muestra el código y el archivo XML: package cursoswb; import java.io.ioexception; import java.io.printwriter; import java.util.iterator; import javax.servlet.http.httpservletrequest; import javax.servlet.http.httpservletresponse; import org.semanticwb.model.user; import org.semanticwb.model.webpage; import org.semanticwb.portal.api.genericadmresource; import org.semanticwb.portal.api.swbparamrequest; import org.semanticwb.portal.api.swbresourceexception; public class Menu3 extends GenericAdmResource public void doview(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramsrequest) throws SWBResourceException, IOException PrintWriter out=response.getwriter(); WebPage page=paramsrequest.getwebpage(); User user = paramsrequest.getuser(); String bgcolor=paramsrequest.getresourcebase().getattribute("bgcolor",paramsrequest.getargument("bgcolor","#006699")); INFOTEC CONACYT FIDEICOMISO. 29

46 String fontface=paramsrequest.getresourcebase().getattribute( "fontface",paramsrequest.getargument("fontface","courier")); String fontcolor=paramsrequest.getresourcebase().getattribute( "fontcolor",paramsrequest.getargument("fontcolor","#c0c0c0")); String fontsize=paramsrequest.getresourcebase().getattribute( "fontsize",paramsrequest.getargument("fontsize","4")); String font="<font face=\""+fontface+"\" size=\""+fontsize+ "\"color=\""+fontcolor+"\">"; String fontc="</font>"; out.println("<font face=arial size=4>menú, implementación del modo Admin</font><br>"); "\">"); out.println("<table border=0 cellspacing='1' bgcolor=\""+bgcolor+ if(page.getparent()!=null) out.println("<tr><td colspan=2><a href=\""+ page.getparent().geturl()+"\">"+font +page.getparent().getdisplayname(user.getlanguage())+fontc+"</a></td></tr>"); out.println("<tr><td colspan=2>"+font+"<b> "+ page.getdisplayname(user.getlanguage())+"</b>"+fontc+"</td></tr>"); Iterator it=page.listvisiblechilds(user.getlanguage()); while(it.hasnext()) WebPage tp=(webpage)it.next(); out.println("<tr>"); out.println("<td width=15> </TD>"); out.println("<td><a href=\""+tp.geturl()+"\">"+font+ tp.getdisplayname(user.getlanguage())+fontc+"</a></td>"); out.println("</tr>"); out.println("</table>"); Archivo Menu3.xml: <?xml version="1.0" encoding="iso "?> <admresource xmlns:xsi=" <form name="frmadmin"> <fieldset> <input type="text" name="bgcolor" label="color de fondo:" /> <input type="text" name="fontface" label="nombre de la Fuente:" /> <input type="text" name="fontsize" label="tamaño de la Fuente:" jsvaltype="js_numbers" /> </fieldset> <fieldset> <input type="text" name="fontcolor" label="color de la Fuente:" /> INFOTEC CONACYT FIDEICOMISO. 30

47 <input type="submit" name="btnsave" value="guardar" /> <input type="reset" name="btnreset" value="cancelar" /> </fieldset> </form> </admresource> El código de XML se copia en la carpeta clases dentro del directorio WEB-INF en la ruta de instalación de SemanticWebBuilder, el nombre del archivo debe coincidir con el de la clase que implementa el recurso. El recurso puede ser editado desde el Administrador de SemanticWebBuilder como se muestra a continuación: El recurso se visualiza en pantalla como se muestra en la siguiente figura: Objeto User La función de este objeto es proporcionar información del usuario, adicionalmente provee información sobre el dispositivo e idioma que mantiene en la sesión. Se puede utilizar este objeto para crear un registro de usuario o para seleccionar el idioma de preferencia del usuario. A continuación se muestra el código TestUser.java: INFOTEC CONACYT FIDEICOMISO. 31

48 package cursoswb; import java.io.ioexception; import java.io.printwriter; import javax.servlet.http.httpservletrequest; import javax.servlet.http.httpservletresponse; import org.semanticwb.model.user; import org.semanticwb.portal.api.genericresource; import org.semanticwb.portal.api.swbparamrequest; import org.semanticwb.portal.api.swbresourceexception; public class TestUser extends GenericResource public void doview(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException PrintWriter out = response.getwriter(); User user = paramrequest.getuser(); out.println("<pre>"); out.println("<font face=comic Sans MS size=5>propiedades de un Objeto User</font><br>"); out.println("<b>login: </b>" + user.getlogin()); out.println("<b>nombre: </b>" +user.getname()); out.println("<b>correo: </b>" +user.get ()); out.println("<b>dispositivo: </b>" +user.getdevice().gettitle()); out.println("<b>lenguaje: </b>" +user.getlanguage()); out.println("<b>registrado: </b>" +user.isregistered()); out.println("<b>logeado: </b>" +user.issigned()); out.println("<b>id: </b>" +user.getid()); out.println("</pre>"); La visualización en pantalla de este recurso se muestra a continuación: INFOTEC CONACYT FIDEICOMISO. 32

49 OBJETO SWBResourceURL El objeto SWBResourceURL provee el URL para tener acceso a los diferentes modos, estados de la ventana o acciones del recurso. Esta Url invoca al método processaction. Este objeto puede ser obtenido por medio de los Objetos SWBParamRequest del método render (doview) y SWBActionResponse del método processaction. A continuación se muestra el código TestUrl.java que muestra el uso de los estados de la ventana y el modo doview utilizando el objeto SWBResourceUrl. package cursoswb; import java.io.ioexception; import java.io.printwriter; import javax.servlet.http.httpservletrequest; import javax.servlet.http.httpservletresponse; import org.semanticwb.portal.api.genericresource; import org.semanticwb.portal.api.swbparamrequest; import org.semanticwb.portal.api.swbresourceexception; import org.semanticwb.portal.api.swbresourceurl; public class TestUrl extends GenericResource public void doview(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException PrintWriter out = response.getwriter(); SWBResourceURL url = paramrequest.getrenderurl(); url.setmode(url.mode_edit); out.println("<b>redireccionamiento: URL</b><br>"); out.println("<a href=\"" +url +"\">Edit</a><br>"); out.println("<a href=\"" +paramrequest.getrenderurl().setwindowstate (SWBResourceURL.WinState_MAXIMIZED) +"\">Maximizado</a>"); out.println("<a href=\"" +paramrequest.getrenderurl().setwindowstate (SWBResourceURL.WinState_MINIMIZED) +"\">Minimizado</a>"); out.println("<a href=\""+paramrequest.getrenderurl().setwindowstate (SWBResourceURL.WinState_NORMAL)+"\">Normal</a>"); public void doedit(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException PrintWriter out = response.getwriter(); out.println("hola mundo... Edit"); SWBResourceURL url = paramrequest.getrenderurl(); url.setmode(url.mode_view); out.println("<a href=\""+url+"\">view</a>"); La visualización del ejercicio anterior se muestra a continuación: INFOTEC CONACYT FIDEICOMISO. 33

50 INCORPORACIÓN DE MODOS PERSONALIZADOS DE UN RECURSO A SEMANTICWEBBUILDER El recurso puede requerir el uso de modos adicionales a los preestablecidos, por lo que se pueden agregar sobrescribiendo el método processrequest de la siguiente forma: public void processrequest(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramsrequest) throws SWBResourceException, IOException if(paramsrequest.getmode().equals( gateway )) dogateway(request, response, paramsrequest); else super.processrequest(request, response, paramsrequest); En el ejemplo anterior se muestra como crear un nuevo modo gateway el cual está siendo redireccionado al método dogateway. INCORPORACIÓN DEL MÉTODO DE LLAMADA DIRECT A SEMANTICWEBBUILDER El método de llamada Direct invoca un recurso que no pasa por la plantilla. El siguiente ejercicio implementa la creación de un archivo XML como componente. A continuación se muestra el código del recurso TestXML.java: package cursoswb; import java.io.ioexception; import java.io.printwriter; import javax.servlet.http.httpservletrequest; import javax.servlet.http.httpservletresponse; import org.semanticwb.swbutils; import org.semanticwb.portal.api.genericresource; import org.semanticwb.portal.api.swbparamrequest; import org.semanticwb.portal.api.swbresourceexception; import org.semanticwb.portal.api.swbresourceurl; import org.w3c.dom.document; import org.w3c.dom.element; public class TestXML extends GenericResource public void doxml(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramsrequest) throws SWBResourceException, IOException PrintWriter out=response.getwriter(); response.setcontenttype("text/xml"); Document doc=null; try doc=swbutils.xml.getnewdocument(); INFOTEC CONACYT FIDEICOMISO. 34

51 Element root=doc.createelement("root"); doc.appendchild(root); Element child=doc.createelement("child"); root.appendchild(child); child.setattribute("nombrevalor", "Valor de Child"); Element nieto=doc.createelement("grandchild"); child.appendchild(nieto); nieto.settextcontent("contexto"); nieto.setattribute("nombrevalor", "Valor de GrandChild"); catch(exception e) throw new SWBResourceException("Error al generar Document TestXML.doXML()",e); String xml=swbutils.xml.domtoxml(doc); out.print(xml); public void doview(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramsrequest) throws SWBResourceException, IOException PrintWriter out=response.getwriter(); SWBResourceURL url=paramsrequest.getrenderurl(); url.setmode(url.mode_xml); url.setcallmethod(url.call_direct); out.println("<pre>"); out.println("<font face=comic Sans MS,arial,verdana size=6 ><p align='center'>método DE LLAMADA DIRECTO DEL RECURSO </p></font>"); out.println("<p align='center'><a href=\""+url+"\">test XML</a></p>"); out.println("</pre>"); La visualización de este recurso en pantalla se muestra a continuación: INCLUSION DE SERVLET/JSP Para soportar el patrón Model-View-Controller, el recurso soporta la inclusión de contenido generado por un Servlet o JSP, de este modo el recurso actual como controlador llena un objeto bean con los datos e incluye un JSP para procesar la vista de la página. La forma de hacer la inclusión es similar a la forma en la que un servlet hace esta misma tarea, ejemplo: INFOTEC CONACYT FIDEICOMISO. 35

52 RequestDispatcher dispatcher = request.getrequestdispatcher( /view.jsp ); Dispatcher.include(request, response); Si se requiere pasar atributos al JSP se puede hacer de la siguiente forma: request.setattribute( saldo, +saldo); request.setattribute( paramrequest, paramsrequest); Del lado del JSP se pueden obtener estos atributos como se muestra a continuación: <jsp:usebean id= paramrequest scope= request class= org.semanticwb.portal.api.swbparamrequest /> <jsp:usebean id= saldo scope= request class= java.lang.string /> A continuación se muestra un ejemplo de cómo direcciona el JavaBean al JSP, el paso de atributos al JSP y la obtención de atributos desde el JSP. El JavaBean se muestra enseguida: package cursoswb; import java.io.ioexception; import javax.servlet.requestdispatcher; import javax.servlet.http.httpservletrequest; import javax.servlet.http.httpservletresponse; import org.semanticwb.portal.api.genericresource; import org.semanticwb.portal.api.swbparamrequest; import org.semanticwb.portal.api.swbresourceexception; public class JspResource extends GenericResource public void processrequest(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException if(paramrequest.getmode().equals("facturar")) dofacturar(request,response,paramrequest); else super.processrequest(request, response, paramrequest); public void doview(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException, IOException try request.setattribute("paramrequest", paramrequest); RequestDispatcher rd = request.getrequestdispatcher("/curso/curso.jsp"); rd.include(request, response); catch(exception e) e.printstacktrace(); public void dofacturar(httpservletrequest request, HttpServletResponse response, SWBParamRequest paramrequest) throws SWBResourceException,IOException try request.setattribute("paramrequest", paramrequest); INFOTEC CONACYT FIDEICOMISO. 36

53 RequestDispatcher rd=request.getrequestdispatcher("/curso/fact.jsp"); rd.include(request, response); catch(exception e) e.printstacktrace(); Para los JSP, se debe crear una carpeta y llamarla curso, esta carpeta debe ser creada dentro de la carpeta Web Pages. El primer JSP debe llamarse curso, y se muestra su código a continuación: <jsp:usebean id="paramrequest" scope="request" type="org.semanticwb.portal.api.swbparamrequest"/> <%@page import="org.semanticwb.model.resource,org.semanticwb.model.user,org.semanticwb.mo del.webpage,org.semanticwb.portal.api.swbresourceurl" %> <% Resource base=paramrequest.getresourcebase(); User user=paramrequest.getuser(); WebPage wpage=paramrequest.getwebpage(); SWBResourceURL url=paramrequest.getrenderurl(); %> Recurso ID: <%=base.getid()%><br/> Recurso Título: <%=base.gettitle()%><br/> Usuario: <%=user.get ()%><br/> Usuario:<%=user.getFullName()%><br/> Página: <%=wpage.getdisplayname()%><br/> Redirigir: <a href="<%=url.setmode("facturar")%>">otro Jsp</a> El segundo JSP se debe llamar fact y su código se muestra en seguida: <jsp:usebean id="paramrequest" scope="request" type="org.semanticwb.portal.api.swbparamrequest"/> <%@page import="org.semanticwb.model.resource,org.semanticwb.model.user,org.semanticwb.mo del.webpage,org.semanticwb.portal.api.swbresourceurl" %> Facturando... <% SWBResourceURL url = paramrequest.getrenderurl(); %> <a href="<%=url.setmode(url.mode_view)%>">regresate a la vista</a> La visualización de este recurso se muestra a continuación: INFOTEC CONACYT FIDEICOMISO. 37

54 El recurso muestra el primer JSP con datos proporcionados por el JavaBeans. Los datos que obtiene del JavaBeans son de los objetos Resource, User y WebPage. La siguiente figura muestra el segundo JSP que se visualiza cuando se da click sobre la liga de Facturar: INTERNACIONALIZACIÓN DE UN RECURSO La internacionalización de los recursos está definida utilizando archivos de propiedades, los cuales se recomienda sean creados utilizando el mismo nombre y ruta de la clase del recurso. Ejemplo: cursoswb.holamundo.class cursoswb.holamundo.properties cursoswb.holamundo_es.properties cursoswb.holamundo_en.properties cursoswb.holamundo_pt.properties La forma de acceder a los textos de los archivos de propiedades es por medio del método getlocalstring() de los objetos SWBParamRequest y SWBActionResponse que pasados por parámetro en los métodos render y processaction respectivamente. paramrequest.getlocalstring( txtholamundo ); INFOTEC CONACYT FIDEICOMISO. 38