Commands.java

/**
 * C-JDBC: Clustered JDBC.
 * Copyright (C) 2002-2005 French National Institute For Research In Computer
 * Science And Control (INRIA).
 * Contact: c-jdbc@objectweb.org
 * 
 * This library 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 any later
 * version.
 * 
 * This library 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 library; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * Initial developer(s): Emmanuel Cecchet.
 * Contributor(s): Nicolas Modrzyk.
 */

package org.objectweb.cjdbc.driver.protocol;

/**
 * Commands used by the protocol between the C-JDBC driver and controller.
 * 
 * @author <a href="mailto:Emmanuel.Cecchet@inria.fr">Emmanuel Cecchet </a>
 * @author <a href="mailto:Nicolas.Modrzyk@inria.fr">Nicolas Modrzyk </a>*
 * @version 1.0
 */
public class Commands
{
  /**
   * Protocol version to check that driver is compatible with controller.
   * Increase this number each time the exchange protocol changes between driver
   * and controller.
   */
  public static final int ProtocolVersion                        = 15;

  /*
   * SQL requests handling
   */

  /**
   * Performs a read request and returns the reply.
   * 
   * @see org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabase#execReadRequest(org.objectweb.cjdbc.common.sql.SelectRequest)
   */
  public static final int ExecReadRequest                        = 0;

  /**
   * Performs a write request and returns the number of rows affected.
   * 
   * @see org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabase#execWriteRequest(org.objectweb.cjdbc.common.sql.AbstractWriteRequest)
   */
  public static final int ExecWriteRequest                       = 1;

  /**
   * Performs a write request and returns the auto generated keys.
   * 
   * @see org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabase#execWriteRequestWithKeys(org.objectweb.cjdbc.common.sql.AbstractWriteRequest)
   */
  public static final int ExecWriteRequestWithKeys               = 2;

  /**
   * Calls a stored procedure and returns the reply (ResultSet).
   * 
   * @see org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabase#execReadStoredProcedure(org.objectweb.cjdbc.common.sql.StoredProcedure)
   */
  public static final int ExecReadStoredProcedure                = 3;

  /**
   * Calls a stored procedure and returns the number of rows affected (write
   * query).
   * 
   * @see org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabase#execReadStoredProcedure(org.objectweb.cjdbc.common.sql.StoredProcedure)
   */
  public static final int ExecWriteStoredProcedure               = 4;

  /**
   * Create Request. This is used when sending a write request from the driver
   * to the database worker thread
   */
  public static final int CreateRequest                          = 5;
  /**
   * Delete Request. This is used when sending a write request from the driver
   * to the database worker thread
   */
  public static final int DeleteRequest                          = 6;
  /**
   * Drop Request. This is used when sending a write request from the driver to
   * the database worker thread
   */
  public static final int DropRequest                            = 7;
  /**
   * Insert Request. This is used when sending a write request from the driver
   * to the database worker thread
   */
  public static final int InsertRequest                          = 8;
  /**
   * Update Request. This is used when sending a write request from the driver
   * to the database worker thread
   */
  public static final int UpdateRequest                          = 9;

  /**
   * Alter Request. This is used when sending a write request from the driver to
   * the database worker thread
   */
  public static final int AlterRequest                           = 10;

  /*
   * Transaction management
   */

  /**
   * Begins a new transaction and returns the corresponding transaction
   * identifier. This method is called from the driver when
   * {@link org.objectweb.cjdbc.driver.Connection#setAutoCommit(boolean)}is
   * called with <code>false</code> argument.
   * 
   * @see org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabase#begin(String)
   */
  public static final int Begin                                  = 20;

  /**
   * Commits a transaction given its id.
   * 
   * @see org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabase#commit(long)
   */
  public static final int Commit                                 = 21;

  /**
   * Rollbacks a transaction given its id.
   * 
   * @see org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabase#rollback(long)
   */
  public static final int Rollback                               = 22;

  /*
   * Connection management
   */

  /**
   * Close the connection
   */
  public static final int Close                                  = 30;

  /**
   * Reset the connection
   */
  public static final int Reset                                  = 31;

  /**
   * Fetch next rows of data for ResultSet streaming
   */
  public static final int FetchNextResultSetRows                 = 32;

  /**
   * Closes a remote ResultSet that was opened for streaming.
   */
  public static final int CloseRemoteResultSet                   = 33;

  /**
   * Restore a connection state after an automatic reconnection.
   */
  public static final int RestoreConnectionState                 = 34;

  /**
   * Command to change the autocommit value from false to true. We want to
   * commit the current transaction but we don't want to start a new one.
   */
  public static final int SetAutoCommit                          = 35;

  /**
   * Retrieve the current catalog
   * 
   * @see org.objectweb.cjdbc.driver.Connection#getCatalog()
   */
  public static final int ConnectionGetCatalog                   = 36;

  /**
   * Retrieve the current catalog
   * 
   * @see org.objectweb.cjdbc.driver.Connection#getCatalogs()
   */
  public static final int ConnectionGetCatalogs                  = 37;

  /**
   * Change the current connection catalog
   * 
   * @see org.objectweb.cjdbc.driver.Connection#setCatalog(String)
   */
  public static final int ConnectionSetCatalog                   = 38;

  /*
   * MetaData functions
   */

  /**
   * Gets the virtual database name to be used by the client (C-JDBC driver).
   * 
   * @see org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabase#getVirtualDatabaseName()
   */
  public static final int GetVirtualDatabaseName                 = 50;

  /**
   * Gets the controller version number.
   * 
   * @see org.objectweb.cjdbc.controller.core.Controller#getVersionNumber()
   */
  public static final int GetControllerVersionNumber             = 51;

  /**
   * Used to get the schema tables by calling DatabaseMetaData.getTables()
   * 
   * @see org.objectweb.cjdbc.driver.DatabaseMetaData#getTables(String, String,
   *      String, String[])
   */
  public static final int DatabaseMetaDataGetTables              = 52;

  /**
   * Used to get the schema columns by calling DatabaseMetaData.getColumns()
   * 
   * @see org.objectweb.cjdbc.driver.DatabaseMetaData#getColumns(String, String,
   *      String, String)
   */
  public static final int DatabaseMetaDataGetColumns             = 53;

  /**
   * Used to get the schema primary keys by calling
   * DatabaseMetaData.getColumns()
   * 
   * @see org.objectweb.cjdbc.driver.DatabaseMetaData#getPrimaryKeys(String,
   *      String, String)
   */
  public static final int DatabaseMetaDataGetPrimaryKeys         = 54;

  /**
   * Used to get the schema procedures by calling
   * DatabaseMetaData.getProcedures()
   * 
   * @see org.objectweb.cjdbc.driver.DatabaseMetaData#getProcedures(String,
   *      String, String)
   */
  public static final int DatabaseMetaDataGetProcedures          = 55;

  /**
   * Used to get the schema procedure columns by calling
   * DatabaseMetaData.getProcedureColumns()
   * 
   * @see org.objectweb.cjdbc.driver.DatabaseMetaData#getProcedureColumns(String,
   *      String, String, String)
   */
  public static final int DatabaseMetaDataGetProcedureColumns    = 56;

  /**
   * Retrieve the database table types
   * 
   * @see org.objectweb.cjdbc.driver.DatabaseMetaData#getTableTypes()
   */
  public static final int DatabaseMetaDataGetTableTypes          = 58;

  /**
   * Retrieve the table privileges
   * 
   * @see org.objectweb.cjdbc.driver.DatabaseMetaData#getTablePrivileges(String,
   *      String, String)
   */
  public static final int DatabaseMetaDataGetTablePrivileges     = 59;

  /**
   * Retrieve the schemas
   * 
   * @see org.objectweb.cjdbc.driver.DatabaseMetaData#getSchemas()
   */
  public static final int DatabaseMetaDataGetSchemas             = 60;

  /**
   * Retrieve the list of database product names
   * 
   * @see org.objectweb.cjdbc.driver.DatabaseMetaData#getDatabaseProductName()
   */
  public static final int DatabaseMetaDataGetDatabaseProductName = 61;
  
  /**
   * Retrieve an object containing all the static metadata. This includes all the boolean values
   * collected from an underlying backend to the controller.
   */
  public static final int DatabaseStaticMetadata = 62;

}

---