Ansluta till SQL-databaser connecting-to-sql-databases

Få tillgång till en extern SQL-databas så att CQ-programmen kan interagera med data:

Paketera JDBC-databasdrivrutinen bundling-the-jdbc-database-driver

Vissa databasleverantörer tillhandahåller JDBC-drivrutiner i ett OSGi-paket, till exempel MySQL. Om JDBC-drivrutinen för din databas inte är tillgänglig som ett OSGi-paket hämtar du JAR-drivrutinen och lägger den i ett OSGi-paket. Paketet måste exportera de paket som krävs för interaktion med databasservern. Paketet måste också importera de paket som det refererar till.

I följande exempel används Bundle plug-in for Maven för att lägga in HSQLDB-drivrutinen i ett OSGi-paket. POM instruerar plugin-programmet att bädda in filen hsqldb.jar som identifieras som ett beroende. Alla org.hsqldb-paket exporteras.

Plugin-programmet bestämmer automatiskt vilka paket som ska importeras och visar dem i filen MANIFEST.MF i paketet. Om något av paketen inte är tillgängligt på CQ-servern startar inte paketet vid installationen. Två möjliga lösningar är följande:

  • Ange i POM att paketen är valfria. Använd den här lösningen när JDBC-anslutningen egentligen inte kräver paketmedlemmarna. Använd elementet Import-Package för att ange valfria paket som i följande exempel:

    <Import-Package>org.jboss.*;resolution:=optional,*</Import-Package>

  • Lägg in de JAR-filer som innehåller paketen i ett OSGi-paket som exporterar paketen och distribuera paketet. Använd den här lösningen när paketmedlemmarna krävs under kodkörningen.

Om du känner till källkoden kan du bestämma vilken lösning som ska användas. Du kan också testa båda lösningarna och utföra testning för att validera lösningen.

POM som innehåller hsqldb.jar pom-that-bundles-hsqldb-jar

<project xmlns="https://maven.apache.org/POM/4.0.0"
  xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.adobe.example.myapp</groupId>
  <artifactId>hsqldb-jdbc-driver-bundle</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>wrapper-bundle-hsqldb-driver</name>
  <url>www.adobe.com</url>
  <description>Exports the HSQL JDBC driver</description>
  <packaging>bundle</packaging>
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.felix</groupId>
        <artifactId>maven-bundle-plugin</artifactId>
        <version>1.4.3</version>
        <extensions>true</extensions>
        <configuration>
         <instructions>
            <Embed-Dependency>*</Embed-Dependency>
            <_exportcontents>org.hsqldb.*</_exportcontents>
          </instructions>
        </configuration>
      </plugin>
    </plugins>
  </build>
  <dependencies>
    <dependency>
      <groupId>hsqldb</groupId>
      <artifactId>hsqldb</artifactId>
      <version>2.2.9</version>
    </dependency>
  </dependencies>
</project>

Följande länkar öppnar hämtningssidorna för några populära databasprodukter:

Konfigurera tjänsten JDBC-anslutningspool configuring-the-jdbc-connection-pool-service

Lägg till en konfiguration för tjänsten JDBC Connections Pool som använder JDBC-drivrutinen för att skapa datakällobjekt. Programkoden använder den här tjänsten för att hämta objektet och ansluta till databasen.

JDBC-anslutningspool ( com.day.commons.datasource.jdbcpool.JdbcPoolService) är en fabrikstjänst. Om du behöver anslutningar som använder olika egenskaper, till exempel läsbehörighet eller läs-/skrivåtkomst, skapar du flera konfigurationer.

När du arbetar med CQ finns det flera metoder för att hantera konfigurationsinställningarna för sådana tjänster. Se Konfigurerar OSGi för fullständig information.

Följande egenskaper är tillgängliga för att konfigurera en poolad anslutningstjänst. Egenskapsnamnen visas så som de visas i webbkonsolen. Motsvarande namn för en sling:OsgiConfig visas inom parentes. Exempelvärden visas för en HSQLDB-server och en databas som har aliaset mydb:

  • JDBC-drivrutinsklass ( jdbc.driver.class): Den Java™-klass som till exempel implementerar gränssnittet java.sql.Driver org.hsqldb.jdbc.JDBCDriver. Datatypen är String.

  • JDBC Connection URI ( jdbc.connection.uri): URL-adressen till den databas som ska användas för att skapa anslutningen, till exempel jdbc:hsqldb:hsql//10.36.79.223:9001/mydb. URL-formatet måste vara giltigt för användning med metoden getConnection i klassen java.sql.DriverManager. Datatypen är String.

  • Användarnamn ( jdbc.username): Det användarnamn som ska användas för att autentisera med databasservern. Datatypen är String.

  • Lösenord ( jdbc.password): Lösenordet som ska användas för autentisering av användaren. Datatypen är String.

  • Valideringsfråga ( jdbc.validation.query): Den SQL-sats som ska användas för att verifiera att anslutningen lyckas, till exempel select 1 from INFORMATION_SCHEMA.SYSTEM_USERS. Datatypen är String.

  • Skrivskyddad som standard (default.readonly): Välj det här alternativet om du vill att anslutningen ska ge skrivskyddad åtkomst. Datatypen är Boolean.

  • Genomför automatiskt som standard ( default.autocommit): Välj det här alternativet om du vill skapa separata transaktioner för varje SQL-kommando som skickas till databasen, och varje transaktion verkställs automatiskt. Välj inte det här alternativet när du implementerar transaktioner explicit i koden. Datatypen är Boolean.

  • Poolstorlek ( pool.size): Antalet samtidiga anslutningar som ska göras tillgängliga för databasen. Datatypen är Long.

  • Väntar på pool ( pool.max.wait.msec): Hur lång tid det tar innan en anslutningsbegäran tar slut. Datatypen är Long.

  • Datakällans namn ( datasource.name): Namnet på den här datakällan. Datatypen är String.

  • Ytterligare serviceegenskaper ( datasource.svc.properties): En uppsättning namn/värde-par som du vill lägga till i anslutningens URL. Datatypen är String[].

Tjänsten JDBC Connections Pool är en fabrik. Om du använder en sling:OsgiConfig för att konfigurera anslutningstjänsten måste nodens namn innehålla fabrikstjänstens-PID följt av -alias. Aliaset som du använder måste vara unikt för alla konfigurationsnoder för det PID:t. Ett exempel på nodnamn är com.day.commons.datasource.jdbcpool.JdbcPoolService-myhsqldbpool.

chlimage_1-7

Ansluta till databasen connecting-to-the-database

Använd tjänsten DataSourcePool för att få en javax.sql.DataSource -objektet för konfigurationen som du skapade. Tjänsten DataSourcePool tillhandahåller getDataSource metod som returnerar en DataSource -objekt för ett angivet datakällnamn. Använd värdet på datakällans namn (eller datasource.name) som du angav för JDBC-anslutningspoolkonfigurationen.

Följande exempel på JSP-kod hämtar en instans av hsqldbds-datakällan, kör en enkel SQL-fråga och visar antalet resultat som returneras.

JSP som utför en databassökning jsp-that-performs-a-database-lookup

<%@include file="/libs/foundation/global.jsp"%><%
%><%@page session="false"%><%
%><%@ page import="com.day.commons.datasource.poolservice.DataSourcePool" %><%
%><%@ page import="javax.sql.DataSource" %><%
%><%@ page import="java.sql.Connection" %><%
%><%@ page import="java.sql.SQLException" %><%
%><%@ page import="java.sql.Statement" %><%
%><%@ page import="java.sql.ResultSet"%><%
%><html>
<cq:include script="head.jsp"/>
<body>
<%DataSourcePool dspService = sling.getService(DataSourcePool.class);
  try {
     DataSource ds = (DataSource) dspService.getDataSource("hsqldbds");
     if(ds != null) {
         %><p>Obtained the datasource!</p><%
         %><%final Connection connection = ds.getConnection();
          final Statement statement = connection.createStatement();
          final ResultSet resultSet = statement.executeQuery("SELECT * from INFORMATION_SCHEMA.SYSTEM_USERS");
          int r=0;
          while(resultSet.next()){
             r=r+1;
          }
          resultSet.close();
          %><p>Number of results: <%=r%></p><%
      }
   }catch (Exception e) {
        %><p>error! <%=e.getMessage()%></p><%
    }
%></body>
</html>
NOTE
Om metoden getDataSource genererar ett undantag eftersom datakällan inte hittas, kontrollerar du att tjänstkonfigurationen för anslutningspoolen är korrekt. Kontrollera egenskapsnamnen, värdena och datatyperna.
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2