Ready to get started?

Learn more about the CData JDBC Driver for Alfresco or download a free trial:

Download Now

Configure the CData JDBC Driver for Alfresco in a Connection Pool in Tomcat

Connect to Alfresco data from a connection pool in Tomcat.

The CData JDBC Drivers support standard JDBC interfaces to integrate with Web applications running on the JVM. This article details how to connect to Alfresco data from a connection pool in Tomcat.

Connect to Alfresco Data through a Connection Pool in Tomcat

  1. Copy the CData JAR and CData .lic file to $CATALINA_HOME/lib. The CData JAR is located in the lib subfolder of the installation directory.
  2. Add a definition of the resource to the context. Specify the JDBC URL here.

    To connect to Alfresco, the following connection properties must be supplied: User, Password, and InstanceUrl. User and Password correspond to the login credentials that you use to access Alfresco in a web browser. InstanceUrl corresponds to the Alfresco instance you will be querying. For instance, if you expect your queries to hit https://search-demo.dev.alfresco.me/alfresco/api/-default-/public/search/versions/1/sql, you should supply search-demo.dev.alfresco.me for InstanceUrl.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the Alfresco JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.alfresco.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    You can see the JDBC URL specified in the resource definition below.

    <Resource name="jdbc/alfresco" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.alfresco.AlfrescoDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:alfresco:User=MyUsername; Password=MyPassword; Format=Solr; InstanceUrl=api-explorer.alfresco.com;" maxActive="20" maxIdle="10" maxWait="-1" />

    To allow a single application to access Alfresco data, add the code above to the context.xml in the application's META-INF directory.

    For a shared resource configuration, add the code above to the context.xml located in $CATALINA_BASE/conf. A shared resource configuration provides connectivity to Alfresco for all applications.

  3. Add a reference to the resource to the web.xml for the application. Alfresco data JSP jdbc/Alfresco javax.sql.DataSource Container
  4. Initialize connections from the connection pool: Context initContext = new InitialContext(); Context envContext = (Context)initContext.lookup("java:/comp/env"); DataSource ds = (DataSource)envContext.lookup("jdbc/Alfresco"); Connection conn = ds.getConnection();

More Tomcat Integration

The steps above show how to connect to Alfresco data in a simple connection pooling scenario. For more use cases and information, see the JNDI Datasource How-To in the Tomcat documentation.