AbstractRecoveryLogMBean.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): Nicolas Modrzyk.
 * Contributor(s): Emmanuel Cecchet.
 */

package org.objectweb.cjdbc.common.jmx.mbeans;

import java.sql.SQLException;
import java.util.ArrayList;

import org.objectweb.cjdbc.controller.recoverylog.BackendRecoveryInfo;

/**
 * This class defines a AbstractRecoveryLogMBean
 * 
 * @author <a href="mailto:Nicolas.Modrzyk@inrialpes.fr">Nicolas Modrzyk </a>
 * @author <a href="mailto:Emmanuel.Cecchet@inria.fr">Emmanuel Cecchet </a>
 * @version 1.0
 */
public interface AbstractRecoveryLogMBean
{
  /**
   * Possibly clean the recovery log after all recovery process are done.
   * 
   * @exception SQLException if an error occurs
   */
  void cleanRecoveryLog() throws SQLException;

  /**
   * Retrieve recovery information on a backend. This includes, the last known
   * state of the backend, and the last known checkpoint
   * 
   * @param databaseName the virtual database name
   * @param backendName the backend name
   * @return <code>BackendRecoveryInfo<code> instance or <code>null</code> if the backend does not exist
   * @throws SQLException if cannot proceed
   */
  BackendRecoveryInfo getBackendRecoveryInfo(String databaseName,
      String backendName) throws SQLException;

  /**
   * Returns an array of names of all the checkpoint available in the recovery
   * log
   * 
   * @return <code>ArrayList</code> of <code>String</code> checkpoint names
   * @throws SQLException if fails
   */
  ArrayList getCheckpointNames() throws SQLException;

  /**
   * Get the request id corresponding to a given checkpoint. This is the first
   * step in a recovery process. Following steps consist in calling
   * recoverNextRequest.
   * 
   * @param checkpointName Name of the checkpoint
   * @return int the request identifier corresponding to this checkpoint.
   * @exception SQLException if an error occurs
   */
  long getCheckpointRequestId(String checkpointName) throws SQLException;

  /**
   * Returns the recoveringNb value.
   * 
   * @return Returns the recoveringNb.
   */
  long getRecoveringNb();

  /**
   * Get the id of the last transaction logged in the recovery log.
   * 
   * @return the last transaction id.
   * @throws SQLException if an error occurs
   */
  long getLastTransactionId() throws SQLException;

  /**
   * Returns <code>true</code> if at least one backend has started a recover
   * process.
   * 
   * @return <code>boolean</code>
   */
  boolean isRecovering();

  /**
   * Remove a checkpoint from the recovery. This is useful for recovery
   * maintenant
   * 
   * @param checkpointName to remove
   * @throws SQLException if an error occurs
   */
  void removeCheckpoint(String checkpointName) throws SQLException;

  /**
   * Store the state of the backend in the recovery log
   * 
   * @param databaseName the virtual database name
   * @param backendRecoveryInfo the backend recovery information to store
   * @throws SQLException if cannot proceed
   */
  void storeBackendRecoveryInfo(String databaseName,
      BackendRecoveryInfo backendRecoveryInfo) throws SQLException;

  /**
   * Store a Checkpoint using the current log state.
   * 
   * @param checkpointName Name of the checkpoint
   * @exception SQLException if an error occurs
   */
  void storeCheckpoint(String checkpointName) throws SQLException;

  /**
   * Store a Checkpoint using the given request id.
   * 
   * @param checkpointName Name of the checkpoint
   * @param requestId request identifier
   * @exception SQLException if an error occurs
   */
  void storeCheckpoint(String checkpointName, long requestId)
      throws SQLException;

}

---