Metacat

/**

 *  '$RCSfile$'

 *    Purpose: A class represent a connection object, it includes connction 

 *    itself, index, status, age and usageCount.

 *  Copyright: 2000 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Jing Tao

 *    Release: @release@

 *

 *   '$Author$'

 *     '$Date$'

 * '$Revision$'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program 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 General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat;

import java.io.*;

import java.sql.*;

/**

 * A class represent a connection object, it includes connection itself, 

 * index, status, age, usageCount, warning message

 */

 public class DBConnection

{

  private Connection conn;

  private int status;

  private long age;

  private int usageCount;

  private SQLWarning warningMessage;

  /**

   * default constructor of the DBConnection class 

   *

   */

  public DBConnection()

  {

    conn = null;

    status = 0;

    age = 0;

    usageCount= 0;

    warningMessage = null;

  }

  /**

   * construct an instance of the DBQConnection class 

   *

   * @param conn, the JDBC connection itself.

   * @param status, the status of this connection, free or using

   * @param age,the age of the connection 

   * @param usageCount of the connection

   */

  public DBConnection (Connection conn, int status, int myAge, 

                                                      int usageCount)

                               throws SQLException

  {

    this.conn = conn;

    this.status = status;

    this.age = age;

    this.usageCount = usageCount;

    try

    {

      this.warningMessage = conn.getWarnings();

    }

    catch (SQLException e)

    {

      throw e;

    }

  }

  /**

   * get the db connetion from the object

   */

  public Connection getDBConnection()

  {

    return conn;

  }

  /**

   * Set a connection to this object

   * @param myDBConnection, the connection which will be assign to this object

   */

  public void setDBConnection( Connection myDBConnection)

  {

    this.conn = myDBConnection;

  }

  /**

   * get the db connetion status from the object

   */

  public int getStatus()

  {

    return status;

  }

  /**

   * Set a connection status to this object

   * @param myStatus, the status which will be assign to this object

   * 0 is free, 1 is using

   */

  public void setStatus(int myStatus)

  {

    this.status = myStatus;

  }

  /**

   * get the db connetion age from the object

   */

  public long getAge()

  {

    return age;

  }

  /**

   * Set a connection age to this object

   * @param myAge, the Age which will be assign to this object

   */

  public void setAge(long myAge)

  {

    this.age = myAge;

  }  

  /**

   * get the db connetion usage times from the object

   */

  public int getUsageCount()

  {

    return usageCount;

  }

  /**

   * Set a usage number to this object

   * @param myUsageCount, number of usage which will be assign to this object

   */

  public void setUsageCount(int myUsageCount)

  {

    this.usageCount = myUsageCount;

  }

  /**

   * get the db connetion waring message from the object

   */

  public SQLWarning getWarningMessage()

  {

    return warningMessage;

  }

  /**

   * Set a warning message to this object

   * @param myWarningMessage, the waring which will be assign to this object

   */

  public void setWarningMessage(SQLWarning myWarningMessage)

  {

     this.warningMessage = myWarningMessage;

  }

}//DBConnection class