org.jboss.jca.adapters.jdbc.CheckValidConnectionSQL Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ironjacamar-jdbc Show documentation
The newest version!
/*
 * IronJacamar, a Java EE Connector Architecture implementation
 * 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.
 */

package org.jboss.jca.adapters.jdbc;

import org.jboss.jca.adapters.jdbc.spi.ValidConnectionChecker;

import java.io.Serializable;
import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Statement;

/**
 * Implements check valid connection sql
 *
 * @author Adrian Brock
 * @version $Revision: 71554 $
 */
public class CheckValidConnectionSQL implements ValidConnectionChecker, Serializable
{
   private static final long serialVersionUID = -222752863430216887L;

   private static final String VALIDATION_QUERY_TIMEOUT = "ironjacamar.validation_query_timeout";

   private String sql;

   private int queryTimeout;

   /**
    * Constructor
    */
   public CheckValidConnectionSQL()
   {
      String value = SecurityActions.getSystemProperty(VALIDATION_QUERY_TIMEOUT);

      if (value != null && !value.trim().equals(""))
      {
         try
         {
            queryTimeout = Integer.valueOf(value);
         }
         catch (Throwable t)
         {
            // defaults to 0 which means no timeout
            queryTimeout = 0;
         }
      }
   }

   /**
    * Constructor
    * @param sql The SQL string
    */
   public CheckValidConnectionSQL(String sql)
   {
      this();
      this.sql = sql;
   }

   /**
    * {@inheritDoc}
    */
   @Override
   public SQLException isValidConnection(Connection c)
   {
      if (sql == null)
         return null;

      try
      {
         Statement s = c.createStatement();
         try
         {
            s.setQueryTimeout(queryTimeout);
            s.execute(sql);
            return null;
         }
         finally
         {
            s.close();
         }
      }
      catch (SQLException e)
      {
         return e;
      }
   }
   public void setQueryTimeout(int queryTimeout)
   {
      this.queryTimeout = queryTimeout;
   }
}