DatabaseClusterMBean.java :  » Database-JDBC-Connection-Pool » HA-JDBC » net » sf » hajdbc » Java Open Source

/*
 * HA-JDBC: High-Availability JDBC
 * Copyright (c) 2004-2007 Paul Ferraro
 * 
 * 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 (at your 
 * option) 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
 * 
 * Contact: ferraro@users.sourceforge.net
 */
package net.sf.hajdbc;

import java.net.URL;
import java.util.Set;

/**
 * @author  Paul Ferraro
 * @version $Revision: 1679 $
 * @since   1.0
 */
public interface DatabaseClusterMBean
{
  /**
   * Determines whether or not the specified database is responsive
   * @param databaseId a database identifier
   * @return true, if the database is alive, false otherwise
   * @throws IllegalArgumentException if no database exists with the specified identifier.
   */
  public boolean isAlive(String databaseId);
  
  /**
   * Deactivates the specified database.
   * @param databaseId a database identifier
   * @throws IllegalArgumentException if no database exists with the specified identifier.
   * @throws IllegalStateException if mbean could not be re-registered using inactive database interface.
   */
  public void deactivate(String databaseId);

  /**
   * Synchronizes, using the default strategy, and reactivates the specified database.
   * @param databaseId a database identifier
   * @throws IllegalArgumentException if no database exists with the specified identifier.
   * @throws IllegalStateException if synchronization fails, or if mbean could not be re-registered using active database interface.
   */
  public void activate(String databaseId);

  /**
   * Synchronizes, using the specified strategy, and reactivates the specified database.
   * @param databaseId a database identifier
   * @param syncId the class name of a synchronization strategy
   * @throws IllegalArgumentException if no database exists with the specified identifier, or no synchronization strategy exists with the specified identifier.
   * @throws IllegalStateException if synchronization fails, or if mbean could not be re-registered using active database interface.
   */
  public void activate(String databaseId, String syncId);
  
  /**
   * Returns a collection of active databases in this cluster.
   * @return a list of database identifiers
   */
  public Set<String> getActiveDatabases();
  
  /**
   * Returns a collection of inactive databases in this cluster.
   * @return a collection of database identifiers
   */
  public Set<String> getInactiveDatabases();
  
  /**
   * Return the current HA-JDBC version
   * @return the current version
   */
  public String getVersion();
  
  /**
   * Removes the specified database/DataSource from the cluster.
   * @param databaseId a database identifier
   * @throws IllegalStateException if database is still active, or if mbean unregistration fails.
   */
  public void remove(String databaseId);
  
  /**
   * Flushes this cluster's cache of DatabaseMetaData.
   */
  public void flushMetaDataCache();
  
  /**
   * Returns the set of synchronization strategies available to this cluster.
   * @return a set of synchronization strategy identifiers
   */
  public Set<String> getSynchronizationStrategies();
  
  /**
   * Returns the default synchronization strategy used by this cluster.
   * @return a synchronization strategy identifier
   */
  public String getDefaultSynchronizationStrategy();
  
  /**
   * Returns the URL of the configuration file for this cluster.
   * @return a URL
   */
  public URL getUrl();
  
  /**
   * Provided so that mbean proxies will use mbean toString() implementation
   * @return string representation of this cluster
   */
  public String toString();
}