Configurando o recurso RDBMS para se conectar ao seu aplicativo

O recurso RDBMS do XPages é instalado como parte do processo de instalação do produto. Este tópico descreve como fazer a configuração inicial necessária para conectar seu aplicativo ao recurso RDBMS.

Sobre Esta Tarefa

Para conectar seu aplicativo ao recurso RDBMS, é necessária alguma configuração inicial. Use estas etapas para concluir esta configuração:

Procedimento

  1. Faça download do driver JDBC necessário. O recurso RDBMS do XPages é baseado em Java e JDBC. Para que um aplicativo XPages interaja com um banco de dados relacional, seu servidor precisa ter o driver JDBC de requisito para esse banco de dados disponível no servidor. Para isso, faça download ou localize o driver JDBC apropriado para seu banco de dados relacional. Por exemplo, em uma instalação do DB2, o driver JDBC é fornecido em <db2-install-location>\java\db2jcc.jar. Como outro exemplo, para um banco de dados MySQL, é possível fazer download do driver JDBC do website do MySQL.
  2. Instale o driver JDBC no servidor. Use um dos seguintes métodos para instalar o driver no servidor:
    1. Use o JDBC Driver Plug-in Wizard (método recomendado) - Quando tiver o driver JDBC correto, deve-se disponibilizá-lo no servidor. Use a ferramenta JDBC Driver Plug-in Wizard (JDPW) que é fornecida para isso. Esta ferramenta cria um wrapper de plug-in OSGi para um driver JDBC. Para abrir o assistente no Designer, selecione a opção de menu Ferramentas - JDBC Driver Plug-in Wizard e forneça as informações solicitadas pelo assistente. Essas informações incluem Detalhes do driver e Detalhes de saída do assistente. O assistente permite gerar um site ou um plug-in de atualização, que precisa ser instalado no servidor Domino. Quando o servidor tiver sido reiniciado, o driver JDBC estará então disponível para ser usado por seus aplicativos XPages.
    2. Instale o driver JDBC em seu servidor, arrastando o arquivo ou os arquivos JAR do driver para a pasta /jvm/lib/ext/ do servidor. Usando esta abordagem, seu driver será registrado se você estiver usando a definição do conjunto de conexões. Se não estiver usando a definição do conjunto, você mesmo deverá registrar o driver. No entanto, usando a ferramenta do assistente recomendada, o registro do driver será sempre automático.
  3. Crie um arquivo .jdbc no aplicativo XPage. Como na próxima etapa, o aplicativo XPage requer a criação de um arquivo <filename>.jdbc na pasta /WebContent/WEB-INF/jdbc (visível na visualização do Navegador no Designer). Este arquivo define os parâmetros de conexão para seu banco de dados. A seguir está um exemplo do conteúdo de um arquivo <filename>.jdbc: <jdbc type="simple"> <driver>com.ibm.db2.jcc.DB2Driver</driver> <url>jdbc:db2://<host>:<port>/<DB></url> <user>usr</user> <password>pwd</password> <simple> <maxPoolSize>10</maxPoolSize> <maxConnectionSize>5</maxConnectionSize> </simple> </jdbc>. O valor do driver refere-se à classe do driver JDBC, fornecida pelo driver JDBC que foi instalado em seu servidor. O valor da URL é uma URL de conexão que aponta para seu banco de dados. Os valores user e password são armazenados aqui para acessar o banco de dados. No exemplo, o tipo de definição do conjunto de conexões é configurado como simple na primeira linha, com os parâmetros incluídos maxPoolSize e maxConnectionSize também configurados no exemplo. O outro tipo de conjunto de conexões suportado é dbcp.
  4. Inclua a biblioteca relacional em seu aplicativo. Use um dos métodos a seguir para fazer isso:
    1. Para usar controles ou origens de dados relacionais, deve-se incluir a biblioteca relacional na lista de bibliotecas do XPage nas Propriedades de XSP de seu aplicativo. Ao arrastar e soltar um controle ou uma origem de dados relacional do XPages em um XPage, a biblioteca será incluída automaticamente na lista de bibliotecas do XPages para seu aplicativo.
    2. Como alternativa, é possível incluir manualmente a biblioteca, abrindo as Propriedades de XSP de seu aplicativo. Depois de fazer isso, abra a guia Geração de páginas e clique na caixa de seleção próxima a com.ibm.xsp.extlib.relational.library. Quando a biblioteca for incluída, salve seu aplicativo e reconstrua-o.
  5. Referencie o arquivo .jdbc em sua origem de dados. Para que sua origem de dados aponte para o banco de dados, deve-se referenciar o arquivo <filename>.jdbc que foi criado anteriormente. Por exemplo, se você nomeou o arquivo db2.jdbc, inclua uma origem de dados como a seguinte em seu XPage: <xe:this.data> <xe:jdbcRowSet var="myData" sqlTable="users" connectionName="db2"> </xe:jdbcRowSet> </xe:this.data> No exemplo, observe que o atributo connectionName referencia o nome do arquivo .jdbc.

O que Fazer Depois

Depois de concluir todas as etapas recém-descritas, é possível usar o recurso de suporte do RDBMS em seu aplicativo XPages. Quando abrir o aplicativo em um navegador, ele exibirá os dados relacionais extraídos diretamente de seu banco de dados relacional.
Nota: Para evitar conflitos entre o novo plug-in relacional e uma antiga versão do ExtlibX quando ambos estiverem instalados, é recomendável desativar a antiga biblioteca ExtlibX em seu servidor e no Designer ao usar o recurso RDBMS do XPages.

Informações adicionais sobre como usar o recurso RDBMS com aplicativos existentes

Se você desenvolveu anteriormente aplicativos XPages que usavam o plug-in relacional ExtlibX, deverá atualizar seus aplicativos para usarem o novo plug-in relacional. Nas Propriedades de XSP de seu aplicativo, deve-se atualizar o campo Bibliotecas do XPage na guia Geração de páginas. Por exemplo, cancele a seleção de com.ibm.xsp.extlibx.library e selecione com.ibm.xsp.extlib.relational.library no campo Bibliotecas do XPage na guia Geração de páginas. Depois de fazer isso, salve a mudança e reconstrua seu aplicativo.

Se você tiver código Java ou JavaScript em seu aplicativo que referencie classes do antigo plug-in relacional ExtlibX, poderá receber alguns erros no Designer depois de reconstruir seu aplicativo. Para corrigi-los, atualize as referências aos novos nomes de classes, como atualizar instruções de importação em suas classes Java. Por exemplo, para corrigir os seguintes erros:
import com.ibm.xsp.extlib.jdbc.dbHelper.DatabaseHelper;
import com.ibm.xsp.extlib.util.JDBCUtil;
atualize as instruções de importação para o seguinte
import com.ibm.xsp.extlib.relational.jdbc.dbHelper.DatabaseHelper;
import com.ibm.xsp.extlib.relational.util.JDBCUtil;