com.ibm.as400.access.ConnectionPoolEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jt400 Show documentation
The Open Source version of the IBM Toolbox for Java
There is a newer version: 20.0.8
///////////////////////////////////////////////////////////////////////////////
//                                                                             
// JTOpen (IBM Toolbox for Java - OSS version)                              
//                                                                             
// Filename: ConnectionPoolEvent.java
//                                                                             
// The source code contained herein is licensed under the IBM Public License   
// Version 1.0, which has been approved by the Open Source Initiative.         
// Copyright (C) 1997-2000 International Business Machines Corporation and     
// others. All rights reserved.                                                
//                                                                             
///////////////////////////////////////////////////////////////////////////////

package com.ibm.as400.access;

/**
   The ConnectionPoolEvent class represents a connection pool event.
**/
public class ConnectionPoolEvent extends java.util.EventObject
{
  private static final String copyright = "Copyright (C) 1997-2000 International Business Machines Corporation and others.";



    static final long serialVersionUID = 4L;


  /**
   Event ID indicating that a connection pool has been closed.
   A call to getSource() on an event with this ID will return a reference to a ConnectionPool object.
   **/
  public static final int CONNECTION_POOL_CLOSED = 0;

  /**
   Event ID indicating that a connection has been created.
   A call to getSource() on an event with this ID will return a reference to an AS400 object
   if fired from an AS400ConnectionPool; or, a reference to a javax.sql.PooledConnection object
   if fired from an AS400JDBCConnectionPool.
   **/
  public static final int CONNECTION_CREATED = 1;

  /**
   Event ID indicating that a connection has been given to an application.
  A call to getSource() on an event with this ID will return a reference to an AS400 object
  if fired from an AS400ConnectionPool; or, a reference to a javax.sql.PooledConnection object
  if fired from an AS400JDBCConnectionPool.
   **/
  public static final int CONNECTION_RELEASED = 2;

  /**
   Event ID indicating that a connection has been returned to the pool.
  A call to getSource() on an event with this ID will return a reference to an AS400 object
  if fired from an AS400ConnectionPool; or, a reference to a javax.sql.PooledConnection object
  if fired from an AS400JDBCConnectionPool.
   **/
  public static final int CONNECTION_RETURNED = 3;

  /**
   Event ID indicating that a connection has been cleaned up by the 
   maintenance thread because one or more of its properties expired.
  A call to getSource() on an event with this ID will return a reference to an AS400 object
  if fired from an AS400ConnectionPool; or, a reference to a javax.sql.PooledConnection object
  if fired from an AS400JDBCConnectionPool.
   **/
  public static final int CONNECTION_EXPIRED = 4;

  /**
   Event ID indicating that the maintenance thread is running.
   A call to getSource() on an event with this ID will return a reference to a ConnectionPool object.
   **/
  public static final int MAINTENANCE_THREAD_RUN = 5;


  private int eventID_;   // event identifier
   

 /**
   * Constructs a ConnectionPoolEvent object. It uses the specified source and
   * eventID.
   * @param source The object where the event originated.
   * @param eventID The event identifier.
   **/
  public ConnectionPoolEvent(Object source,
                             int eventID)
  {
	 super(source);
	 eventID_ = eventID;
  }

  
  /**
   * Returns the identifier for this event.
   * @return The identifier for this event.
   **/
  public int getID()
  {
    return eventID_;
  }
}