Avanthotel Booking Engine
Copyright (C) 2005 Fundació IBIT

------------------------------------------------------------
Avanthotel ReadMe
------------------------------------------------------------

Este fichero contiene información importante sobre este programa. Por favor lea esta información detenidamente
antes de empezar a trabajar.

Avanthotel es un software de uso libre para todo el mundo que se distribuye bajo los términos de la licencia 
GNU AFFERO GENERAL PUBLIC LICENSE. Para más detalles sobre las condiciones de uso, 
leer los términos de la licencia que se pueden encontrar en el fichero "license.txt". 

------------------------------------------------------------
NOTAS SOBRE LA INSTALACIÓN
------------------------------------------------------------

Esta distribución incluye el código fuente de la aplicación así como un ejecutable (.ear) de prueba. 
El ejecutable es sólo una muestra del funcionamiento de la aplicación con datos de prueba (no sería válido para 
una explotación sin hacer adaptaciones en el código fuente).

--------------------
Software a instalar:
--------------------

- Base de datos: 

	* MySQL Server Version 5.0.41

- Para compilar la aplicación es necesario instalar el siguiente software:
  
  * J2sdk Version 1.4.2_04 
    Crear variable entorno JAVA_HOME que apunte al directorio del j2sdk p.e JAVA_HOME=D:\j2sdk1.4.2_04.
                     
	* Ant Version 1.6.1

- Para ejecutar la aplicación es necesario instalar el servidor de aplicaciones J2EE: 

	* jboss-3.2.2_jetty-4.2.11

		Es necesario configurar el JBoss de la siguiente manera:
		
		Modificar opciones del fichero de arranque del JBoss:

			En el fichero /jboss-3.2.2_jetty-4.2.11/bin/run.sh hay que comentar la linea:
			#JAVA_OPTS="-server" y sustituirla por JAVA_OPTS="-Djava.awt.headless=true -Duser.timezone=Europe/Madrid

		Librería mail: /jboss-3.2.2_jetty-4.2.11/server/default/deploy/lib/mail.jar

		Por último, una vez que esté funcionando la aplicación y ya en producción, y en función de la RAM del 
		servidor, se debe ajustar la memoria de arranque del JBoss.


NOTA: Se recomienda trabajar con estas versiones, sobre todo, en el caso del J2sdk y JBoss.


---------------------
Guía de  instalación:
---------------------

Hay dos formas de instalar la aplicación:

A) Copiar el ear que se proporciona en "/ejecutables/ears/avanthotel.ear" en 
	 /jboss-3.2.2_jetty-4.2.11/server/default/deploy.

B) Compilar el código fuente y copiar el ear generado en /jboss-3.2.2_jetty-4.2.11/server/default/deploy.

En cualquiera de los dos casos, previamente hay que hacer lo siguiente:

	1.- Crear la base de datos y cargar los datos básicos usando los scripts: createAvanthotelBD.sql y 
			dataAvanthotelBD.sql respectivamente. Estos scripts están en la carpeta "ejecutables\scripts BD".

	2.- Definir el Datasource en el servidor de aplicaciones e instalar los drivers.
  		
  		En el caso del JBOSS, y para instalar el driver de MySQL (mysql-connector-java-5.0.6-bin.jar),
  		hay que copiar dicho driver en la carpeta "server/default/lib" del JBoss.
  		
  		Para definir el Datasource en el JBoss, basta con añadir el siguiente códigio en el fichero "hsqldb-ds.xml",
  		que se proporciona en el directorio del JBoss "server/default/deploy":
  		
  		<local-tx-datasource>
     		<jndi-name>AvanthotelDS</jndi-name>
      	<connection-url>jdbc:mysql://localhost/avanthotel</connection-url>
     		<driver-class>org.gjt.mm.mysql.Driver</driver-class>
     		<user-name>db_user</user-name>
     		<password>pwd_user</password>
     		<check-valid-connection-sql>SELECT v_id FROM tava_languages where v_id = 1</check-valid-connection-sql>
			</local-tx-datasource>

			Este datasource (llamado AvanthotelDS) está preparado para configurar el acceso a una base de datos:
  		- MySQL.
  		- Local al servidor de aplicaciones (localhost).
  		- Que utiliza el driver antes mencionado.
  		- Que no utiliza autenticación.

	3.- Si en el punto 2 se ha cambiado el nombre del Datasource(AvanthotelDS), sustituir la propiedad "ds.name"
			del fichero "avanthotel.deploy.properties" del código fuente, por el nombre del datasource definido (en 
			este caso, es necesario compilar de nuevo la aplicación).

	4.- Configurar la seguridad del servidor de aplicaciones para que controle el acceso al offer y al admin de 
			avanthotel.	En el caso del JBOSS esto se hace añadiendo en el fichero "login-config.xml" del directorio 
  		server/default/conf el siguiente código(el dsJndiName tiene que coincidir con el definido en el punto 2):

    	<application-policy name="avanthotel.offer">
      	<authentication>
        	<login-module code="org.jboss.security.auth.spi.DatabaseServerLoginModule" flag="required">
          	<module-option name="dsJndiName">java:/AvanthotelDS</module-option>
            <module-option name="principalsQuery">select pwd passwd from tava_users where user_name=?</module-option>
            <module-option name="rolesQuery">select type userRoles,'Roles' from tava_users where user_name=?</module-option>
          </login-module>
       	</authentication>
    	</application-policy>
    	<application-policy name="avanthotel.admin">
       	<authentication>
        	<login-module code="org.jboss.security.auth.spi.DatabaseServerLoginModule" flag="required">
          	<module-option name="dsJndiName">java:/AvanthotelDS</module-option>
            <module-option name="principalsQuery">select pwd passwd from tava_users where user_name=?</module-option>
            <module-option name="rolesQuery">select type userRoles,'Roles' from tava_users where user_name=?</module-option>
        	</login-module>
       	</authentication>
    	</application-policy>

  		Si el JBOSS estaba en funcionamiento, estos cambios solo tendrán efecto después de reiniciarlo.

Para compilar  la aplicación se deben seguir los siguientes pasos:

	1.- Para construir el ear de la aplicación, se utiliza la herramienta Ant, y basta con situarse en el directorio
   		raiz del código y ejecutar:
  
  		ant [mode] avanthotel main

  		donde el parámetro [mode] hace que que varie la URL de la pasarela de pago y tiene uno de los
  		siguientes valores:
  		
  		dev.local: utiliza el valor de la propiedad "desenvolupament.pagament.url.local" del fichero 
  				  		 avanthotel.deploy.properties del código fuente.

  		dev.remote:utiliza el valor de la propiedad "desenvolupament.pagament.url.remote" del fichero 
  				  		 avanthotel.deploy.properties del código fuente.
  				  		 
  		prod:utiliza el valor de la propiedad "produccio.pagament.url" del fichero 
  				  		 avanthotel.deploy.properties del código fuente.

	2.- Sustituir el valor de la propiedad "deploy.dir", del fichero "build.properties" del código, por 
	    la ruta completa al directorio (local) de deploy del servidor de aplicaciones.


	3.- Para hacer el deploy del ear en el directorio(local) definido en el punto (5) usando el ant, una vez 
			hecho el ear y haber arrancado la BDD y el servidor de aplicaciones (JBoss), situarse en el directorio 
			raiz del código y ejecutar:
  
  		ant dev.local avanthotel deploy
  
Las URLs de acceso a los diferentes módulos de  Avanthotel son:
  		
  		END: http://www.urldereservas.com/End
  		OFFER: http://www.urldereservas.com/Offer
  		ADMIN: http://www.urldereservas.com/Admin
  		
  		donde el valor de "www.urldereservas.com", debe ser sustituido por una url real (por ejemplo en un 
  		localhost serían: http://localhost:8080/End, http://localhost:8080/Offer y http://localhost:8080/Admin 
  		respectivamente).
  		
  		Además, para que funcionen algunos enlaces, hay que modificar todos los parámetros del fichero 
  		"avanthotel.deploy.properties" cuyo valor sea "www.urldereservas.com", por el valor de la url real.
  		
  		El usuario de acceso al Admin y al Offer se puede consultar en la tabla de usuarios de la base de datos.