Cómo configurar JBoss para persistir O3 sobre Diferentes Bases de Datos

Entorno

Es recomendable para ambientes en producción sustituir la base Derby que trae O3 por defecto por algún manejador de base de datos.

Base de datos predefinidas

No es necesario configurar el módulo

PostgreSQL
MS-SQL
h2
Derby
DerbyClient
hsqldb

Bases de datos testeadas

Hemos testeado el funcionamiento correcto de O3 con las siguiente bases de datos:

PostgreSQL (solo es necesario ejecutar el procedimiento de cambio de base)
MS-SQL - ver apartado
MySQL - ver apartado
ORACLE - ver apartado

Es posible configurar otras bases de datos, O3 provee la creación de tablas para las bases anteriormente mencionadas.

Como cambiar a Base de Datos

Servidor sin interfaz gráfica

Bajar o asegurarse que el JBoss este bajo.
Renombrar datasource <o3>/jboss/standalone/deployments/O3Server-ds.xml como #O3Server-ds.xml
Definir nuevo datasource O3Server-ds.xml con la configuración de la nueva base en <o3>/jboss/standalone/deployments/
Crear el archivo O3Server_custom.properties en la raíz de la instalación y agregar la property: o3.config.dataBase=true (A partir de versiones 6.X.X no se realiza este paso)
Levantar O3 Server desde el JBoss.bat o jboss.sh y ver que levanta sin excepciones.

Servidor con interfaz gráfica

Para las bases testeadas desde la aplicación admserver(.exe/.bat/.sh) es posible usar un wizard que se encarga de este proceso.

Procedimiento:

Bajar o asegurarse que el JBoss este bajo.
Abrir el admserver
Ir a Herramientas -> Wizard de Configuración y Migración
Elegir opción: Usar una base de datos distinta a la incluida con O3
Elegir en Motor la base correspondiente
Completar datos acorde y usar el botón de probar conexión.
Si el testeo de conexión es exitoso, apretar el botón siguiente.
Saltear el paso 2 a menos que se este además migrando de version.
Apretar el botón siguiente e ir al pasa 3.
En el paso 3 elegir Habilitar el uso de la base de datos.
Levantar O3 Server desde el JBoss.bat o jboss.sh y ver que levanta sin excepciones.

Este proceso creara el datasource con la configuración de la nueva base.

Solo en aquellos casos, dónde se realiza una migración de versión desde o3v5, se debe definir el usuario internal (pass: internal), el cual deberá estar asociado al rol System y tener definido cómo atributo runAsEnabled de tipo Boolean.

Para el caso de MS-SQL en versión anterior a 6.2

Ir al directorio <o3>/jboss/standalone/deployments/o3-server.ear/lib
Si no esta abierto el jar o3-o3ee-xxxx.jar convertirlo a o3-o3ee-xxxx.zip desempacarlo, borrar o mover el o3-o3ee.xxxx.jar y renombra la carpeta como o3-o3ee-xxxx.jar xxxx = número de versión del jar.
Ir al directorio <o3>/jboss/standalone/deployments/o3-server.ear/lib/o3-o3ee-xxxx.jar/META-INF/
Renombrar el archivo orm-sqlserver.xml como orm.xml
Realizar el procedimiento de cambio de base de datos arriba enumerado.

Para el caso de MySQL

Por temas de licenciamiento no se suministra el driver, por lo cual el usuario deberá bajarlo de internet

Los drivers de mysql hasta la versión 5.1.22 inclusive no se pueden poner en el deploy para que JBoss se encargue de configurarse automáticamente por lo cual hay que realizar un procedimiento manual.

Atención: es conveniente tener la última versión del driver ya que este contiene códigos para funcionar con JBoss 7

Antes de realizar el procedimiento anteriormente descrito hacer los siguiente paso:

Copiar el driver de mysql en <o3>/classes/jdbc/

Crear un archivo de nombre module.xml en <o3>/jboss/modules/com/mysql/main con el siguiente contenido:

<?xml version="1.0" encoding="UTF-8"?>
 
<!--
 ~ JBoss, Home of Professional Open Source.
 ~ Copyright 2010, Red Hat, Inc., and individual contributors
 ~ as indicated by the @author tags. See the copyright.txt file in the
 ~ distribution for a full listing of individual contributors.
 ~
 ~ This is free software; you can redistribute it and/or modify it
 ~ under the terms of the GNU Lesser General Public License as
 ~ published by the Free Software Foundation; either version 2.1 of
 ~ the License, or (at your option) any later version.
 ~
 ~ This software is distributed in the hope that it will be useful,
 ~ but WITHOUT ANY WARRANTY; without even the implied warranty of
 ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 ~ Lesser General Public License for more details.
 ~
 ~ You should have received a copy of the GNU Lesser General Public
 ~ License along with this software; if not, write to the Free
 ~ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 ~ 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 -->
 
<module xmlns="urn:jboss:module:1.0" name="com.mysql">
 <resources>
 <resource-root path="mysql-connector-java-5.1.22-bin.jar"/>
 </resources>
 <dependencies>
 <module name="javax.api"/>
 </dependencies>
</module>

Crear directorios /mysql/main en <o3>/jboss/modules/com/
Agregar el driver de mysql (.jar) en <o3>/jboss/modules/com/mysql/main con el nombre igual al declarado en
<resource-root path="mysql-connector-java-5.1.22-bin.jar"/>

Editar el archivo <o3>/jboss/standalone/configuration/o3bi.xml, buscar la sección <drivers> y agregarle:

<driver name="mysql" module="com.mysql">
    <xa-datasource-class>
        com.mysql.jdbc.jdbc2.optional.MysqlXADataSource
    </xa-datasource-class>
</driver>

Atención: En el caso de utilizar un driver de versión mayor a 5.1.30 también se deberá indicar la <driver-class> :

<driver name="mysql" module="com.mysql">
    <xa-datasource-class>
        com.mysql.jdbc.jdbc2.optional.MysqlXADataSource
    </xa-datasource-class>
	<driver-class>com.mysql.jdbc.Driver</driver-class>
</driver>

Realizar el procedimiento de cambio de base de datos arriba enumerado.

Para el caso de DB2

Por temas de licenciamiento no se suministra el driver, por lo cual el usuario deberá ser suminstrado por el administrador de base de datos, el cual dispondra de de los archivos necesarios(generalmente un .jar con el driver y otro .jar conteniendo la licencia).

Los drivers de db2 hasta la versión 6.3.6 de O3 inclusive no se pueden poner en el deploy para que JBoss se encargue de configurarse automáticamente por lo cual hay que realizar un procedimiento manual.

Atención: es conveniente tener la última versión del driver ya que este contiene códigos para funcionar con JBoss 7

Antes de realizar el procedimiento anteriormente descrito hacer los siguiente paso:

Copiar los drivers de db2 en <o3>/classes/jdbc/(db2jcc.jar y db2jcc_license_cu.jar) Estos drivers son a modo de ejemplo, los drivers deben ser proporcionados por el adm. de base de datos de la empresa.

Crear un archivo de nombre module.xml en <o3>/jboss/modules/com/ibm/db2/main con el siguiente contenido(crear directorios: ibm/db2/main):

module.xml

<?xml version="1.0" encoding="UTF-8"?>
  <module xmlns="urn:jboss:module:1.1" name="com.ibm.db2">
      <resources>
        <resource-root path="db2jcc.jar"/>
        <resource-root path="db2jcc_license_cu.jar"/>
    </resources>
    <dependencies>
        <module name="javax.api"/>
        <module name="javax.transaction.api"/>
        <module name="sun.jdk"/>
    </dependencies>
  </module>

En el directorio <o3>/jboss/modules/com/ibm/db2/main/ creado anteriormente
Agregar los drivers de db2 (.jar) en <o3>/jboss/modules/com/ibm/db2/main con el nombre igual al declarado en
<resource-root path="db2jcc.jar"/> y <resource-root path="db2jcc_license_cu.jar"/>
Copiar los archivos db2jcc.jar.index y db2jcc_license.jar.index a la carpeta anteriormente mencionada
Editar el archivo <o3>/jboss/standalone/configuration/o3bi.xml, buscar la sección <drivers> y agregarle:
o3bi.xml
```
<driver name="db2" module="com.ibm.db2">
	<driver-class>com.ibm.db2.jcc.DB2Driver</driver-class>
</driver>
```

Ir al Archivo O3AdmServer.properties ubicado en la raiz de O3, editarlo y configurar el nuevo motor de base de datos de la siguiente forma:
ubicar: # Other driver y antes de este codigo agregar lo siguiente reemplazando:

O3AdmServer.properties

engine.6            = DB2
engineid.6          = DB2
driver.6            = com.ibm.db2.jcc.DB2Driver
url.6               = jdbc:db2://host:50000/DATABASE
jbossPrefix.4       = db2
jbossDirver.4       = db2

# Other driver
engine.7           = Other
driver.7           = 
url.7              = jdbc:

Realizar el procedimiento de cambio de base de datos arriba enumerado.

Para el caso de Oracle

Por temas de licenciamiento no se suministra el driver, por lo cual el usuario deberá bajarlo de internet

Los drivers de oracle no se pueden poner en el deploy para que JBoss se encargue de configurarse automáticamente por lo cual hay que realizar un procedimiento manual.

Atención: es conveniente tener la última versión del driver ya que este contiene códigos para funcionar con JBoss 7

Antes de realizar el procedimiento anteriormente descrito hacer los siguiente paso:

Copiar el driver de mysql en <o3>/classes/jdbc/

Crear un archivo de nombre module.xml en <o3>/jboss/modules/com/oracle/ojdbc6/main con el siguiente contenido:

<?xml version="1.0" encoding="UTF-8"?>
 
<!--
 ~ JBoss, Home of Professional Open Source.
 ~ Copyright 2010, Red Hat, Inc., and individual contributors
 ~ as indicated by the @author tags. See the copyright.txt file in the
 ~ distribution for a full listing of individual contributors.
 ~
 ~ This is free software; you can redistribute it and/or modify it
 ~ under the terms of the GNU Lesser General Public License as
 ~ published by the Free Software Foundation; either version 2.1 of
 ~ the License, or (at your option) any later version.
 ~
 ~ This software is distributed in the hope that it will be useful,
 ~ but WITHOUT ANY WARRANTY; without even the implied warranty of
 ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 ~ Lesser General Public License for more details.
 ~
 ~ You should have received a copy of the GNU Lesser General Public
 ~ License along with this software; if not, write to the Free
 ~ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 ~ 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 -->
 
<module xmlns="urn:jboss:module:1.0" name="com.oracle.ojdbc6">
  <resources>
    <resource-root path="ojdbc6.jar"/>
  </resources>
  <dependencies>
    <module name="javax.api"/>
  </dependencies>
</module>

Crear directorios /oracle/ojdbc6/main en <o3>/jboss/modules/com/
Agregar el driver de oracle (.jar) en <o3>/jboss/modules/com/oracle/ojdbc6/main con el nombre igual al declarado en
<resource-root path="ojdbc6.jar"/>

Editar el archivo <o3>/jboss/standalone/configuration/o3bi.xml, buscar la sección <drivers> y agregarle:

<driver name="oracle" module="com.oracle.ojdbc6">
  <xa-datasource-class>
    oracle.jdbc.OracleDriver
  </xa-datasource-class>
</driver>

Realizar el procedimiento de cambio de base de datos arriba enumerado.

Agregar control para obtener conexiones a la base de datos validas

Hay que modificar las siguientes configuraciones de datasource:

Editar el archivo <o3>/jboss/standalone/deployments/O3Server-ds.xml, buscar la sección <datasource> y agregarle:

 <validation>
        <validate-on-match>false</validate-on-match>
        <background-validation>false</background-validation>
        <valid-connection-checker class-name="org.jboss.resource.adapter.jdbc.vendor.OracleValidConnectionChecker"/>
        <exception-sorter class-name="org.jboss.resource.adapter.jdbc.vendor.OracleExceptionSorter"></exception-sorter>
    </validation>

Editar el archivo <o3>/jboss/standalone/configuration/o3bi.xm, buscar la sección <datasource> y agregar el mismo código que se muestra en el punto anterior.

HowTo Configurar Liferay con Diferentes Bases de Datos

Browser not supported