001/*
002 * HA-JDBC: High-Availability JDBC
003 * Copyright (c) 2004-2007 Paul Ferraro
004 * 
005 * This library is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Lesser General Public License as published by the 
007 * Free Software Foundation; either version 2.1 of the License, or (at your 
008 * option) any later version.
009 * 
010 * This library is distributed in the hope that it will be useful, but WITHOUT
011 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
012 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License 
013 * for more details.
014 * 
015 * You should have received a copy of the GNU Lesser General Public License
016 * along with this library; if not, write to the Free Software Foundation, 
017 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
018 * 
019 * Contact: ferraro@users.sourceforge.net
020 */
021package net.sf.hajdbc;
022
023import java.util.Properties;
024
025/**
026 * @author Paul Ferraro
027 *
028 */
029public interface ActiveDatabaseMBean
030{
031        /**
032         * Returns the unique idenfier for this database
033         * @return a unique identifier
034         */
035        public String getId();
036        
037        /**
038         * Returns the relative "weight" of this cluster node.
039         * In general, when choosing a node to service read requests, a cluster will favor the node with the highest weight.
040         * A weight of 0 is somewhat special, depending on the type of balancer used by the cluster.
041         * In most cases, a weight of 0 means that this node will never service read requests unless it is the only node in the cluster.
042         * @return a positive integer
043         */
044        public int getWeight();
045        
046        /**
047         * @return the database user
048         */
049        public String getUser();
050        
051        /**
052         * @return the password of the database user
053         */
054        public String getPassword();
055        
056        /**
057         * Returns a collection of additional properties of this database.
058         * @return additional properties of this database
059         */
060        public Properties getProperties();
061        
062        /**
063         * Indicates whether or not this database is local to the machine on which the JVM resides.
064         * @return true if local, false if remote
065         */
066        public boolean isLocal();
067}