SCWCD - El descriptor de despliegue web.xml

El archivo web.xml proporciona la configuración y el despliegue de información para los componentes web que conforman una aplicación.

Este archivo debe residir en el directorio WEB-INF dentro del contexto de la jerarquía de directorios que existen para una aplicación Web. Por ejemplo, si la aplicación esta empaquetada en el archivo WAR "dukechile.war", el archivo web.xml se debe colocar en el directorio “dukechile/ WEB-INF”.

Como todos los archivos de configuración xml, este contiene un esquema que describe el contenido del fichero xml y la descripción de las propiedades que va a utilizar. Dentro de este archivo definiremos la configuración de la aplicación web que estemos desarrollando.

Los elementos del web.xml son:

<web-app>: Es el elemento raíz del fichero xml.

<icon>: Define la ruta para las imágenes asociadas a los iconos pequeño y grande que representan a la aplicación.

<display-name>: Es el nombre que representará a la aplicación dentro de las herramientas del servidor de aplicaciones, no es un nombre funcional.

<description>: Texto descriptivo de la aplicación, que al igual que las dos anteriores propiedades, sólo es representativo.

<context-param>: Permite configurar parámetros de inicialización del contexto de nuestra aplicación web.

<br /><context-param><br /> <param-name>nombrehost</param-name><br /> <param-value>localhost</param-value><br /> <description> Nombre del host en cual se esta ejecutando la aplicacion</description> </context-param> <br />

<filter>: Permite definir un filtro en la aplicación.

<br /><filter><br /> <filter-name>LogSolicitudes</filter-name><br /> <filter-class>cl.bee.dukechile.LogSolicitudes</filter-class><br /> <init-param><br /> <param-name>nombrearchivo</param-name><br /> <param-value>registrolog</param-value><br /> </init-param><br /> </filter><br />

<filter-mapping>: Define un mapeo para aplicar las reglas de un determinado filtro a una URL.

<br /><filter-mapping><br /> <filter-name> LogSolicitudes </filter-name><br /> <url-pattern>/cl/jug/dukechile/*</url-pattern><br /> </filter-mapping><br />

<listener>: Permite definir una clase oyente, la que puede escuchar eventos relacionados al clico de vida de la aplicación o modificaciones de un objeto.

<br /><listener><br /> <listener-class>cl.jug.dukechile.ListenerDeContexto</listener-class><br /></listener><br />

<servlet>: Permite definir la configuración de nuestros servlets.

<br /><servlet><br /> <servlet-name>DukeChile</servlet-name><br /> <servlet-class>cl.jug.dukechile.MiServlet</servlet-class><br /> <init-param><br /> <param-name>configuracion</param-name><br /> <param-value>/WEB-INF/dukechile-config.xml</param-value><br /> </init-param><br /> <load-on-startup>1</load-on-startup><br /></servlet><br />

<servlet-mapping>: Permite relacionar los servlets que hemos declarado con las URL que van a escuchar.

<br /><servlet-mapping><br /> <servlet-name>DukeChile</servlet-name><br /> <url-pattern>*.jsp</url-pattern><br /></servlet-mapping><br />

<session-config>: Permite definir el timeout de la sesión en minutos.

<br /><session-config><br /> <session-timeout>10</session-timeout><br /></session-config><br />

<mime-mapping>: Permite definir una relación entre las extensiones y los tipos mime.

<br /><mime-mapping><br /> <extension>doc</extension><br /> <mime-type>application/vnd.ms-word</mime-type><br /></mime-mapping><br /><br /><mime-mapping><br /> <extension>dsp</extension><br /> <mime-type>text/html</mime-type><br /></mime-mapping><br />

<welcome-file-list>: Permite definir los ficheros de bienvenida de la aplicacion.

<br /><welcome-file-list><br /> <welcome-file>index.jsp</welcome-file><br /> <welcome-file>index.html</welcome-file><br /></welcome-file-list><br />

<tag-lib>: Permite definir las librerías de etiquetas de los ficheros JSP.

<br /><jsp-config><br /> <taglib><br /> <taglib-uri>/tags/struts-bean</taglib-uri><br /> <taglib-location>/WEB-INF/struts-bean.tld</taglib-location><br /> </taglib><br /></jsp-config><br />

<jsp-property-group<: Permite definir propiedades para un conjunto de JSP que cumplan un patrón.

<br /><jsp-config><br /> <jsp-property-group><br /> <url-pattern>*.jsp</url-pattern><br /> <include-prelude>/cabecera.jsp</include-prelude><br /> <include-coda>/pie.jsp</include-coda><br /> </jsp-property-group><br /></jsp-config><br />

<error-page<: Permite asociar errores HTML y excepciones lanzadas por nuestra aplicación a páginas de error personalizadas para la aplicación.

<br /><error-page><br /> <error-code>404</error-code><br /> <location>/noEncontrado.jsp</location><br /></error-page><br /><br /><error-page><br /> <exception-type>java.lang.Throwable</exception-type><br /> <location>/error.jsp</location><br /></error-page><br />

<resource-ref<: Permite declarar recursos externos que nuestra aplicación va a utilizar. Por ejemplo, una conexión a una base de datos.

<br /><resource-ref><br /> <description>Conexion BD</description><br /> <res-ref-name>jdbc/ConexionMySQL</res-ref-name><br /> <res-type>javax.sql.DataSource</res-type><br /> <res-auth>Container</res-auth><br /></resource-ref> <br />

<resource-env-ref<: Permite declarar recursos externos que nuestra aplicación va a utilizar. Este elemento es una nueva variación del elemento añadido en Servlet 2.4 que es más simple de configurar para recursos que no necesitan información de autenticación.

<br /><resource-env-ref><br /> <resource-env-ref-name>jms/StockQueue</resource-env-ref-name><br /> <resource-env-ref-type>javax.jms.Queue</resource-env-ref-type><br /></resource-env-ref><br />

<security-constraint<: Permite proteger áreas de la aplicación (o la aplicación completa), asociándolas a roles que deben tener los usuarios para poder acceder. Estos usuarios y roles son los declarados en tomcat-users.xml (para el caso de Tomcat).

<br /><security-constraint><br /> <web-resource-collection><br /> <web-resource-name>Seguridad Duke Chile</web-resource-name><br /> <url-pattern>/*</url-pattern><br /> </web-resource-collection><br /> <auth-constraint><br /> <role-name>duke</role-name><br /> </auth-constraint><br /></security-constraint><br />

<login-config<: Permite configurar el tipo de login que se requerirá al entrar en un área protegida previamente declarada.

<br /><login-config><br /> <auth-method>FORM</auth-method><br /> <realm-name>Login por formulario</realm-name><br /> <form-login-config><br /> <form-login-page>/login.jsp</form-login-page><br /> <form-error-page>/error.jsp</form-error-page><br /> </form-login-config><br /></login-config><br />

<security-role<: Permite definir los roles de usuarios que se van a utilizar en la aplicación.

<br /><security-role><br /> <role-name>duke</role-name><br /></security-role><br />

<env-entry<: Permite declarar una posible entrada al entorno (environment) de la aplicación.

<br /><env-entry><br /> <description>Mensaje de bienvenida</description><br /> <env-entry-name>bienvenida</env-entry-name><br /> <env-entry-type>java.lang.String</env-entry-type><br /> <env-entry-value>Bienvenido al sistema DukeChile</env-entry-value><br /></env-entry><br />

<ejb-ref<: Permite definir una referencia a un EJB.

<br /><ejb-ref><br /> <description>EJB DukeChile</description><br /> <ejb-ref-name>ejb/DukeChileHome</ejb-ref-name><br /> <ejb-ref-type>Entity</ejb-ref-type><br /> <home>cl.jug.dukechile.DukeChileHome</home><br /> <remote>cl.jug.dukechile.DukeChile</remote><br /></ejb-ref><br />

<ejb-local-ref<: Permite definir una referencia a un EJB Local.

<br /><ejb-local-ref><br /> <ejb-ref-name>ejb/DukeChile</ejb-ref-name><br /> <ejb-ref-type>Session</ejb-ref-type><br /> <local-home> cl.jug.dukechile.DukeChileHome</local-home><br /> <local>cl.jug.dukechile.DukeChile</local><br /> <ejb-link>DukeChile</ejb-link><br /></ejb-local-ref><br />

<distributable<: Permite definir que la aplicación puede correr en un ambiente cluster.

<br /><web-app><br /> <distributable/><br /></web-app><br />