BEA Systems, Inc.

WebLogic Server 6.1 API Reference

weblogic.management.configuration
Interface JDBCMultiPoolMBean


public interface JDBCMultiPoolMBean
extends DeploymentMBean

Relevant only in single-server configurations, JDBC Multipools provide backup pools and load balancing to enhance database connectivity. A MultiPool is a "pool of pools" that allows a configurable algorithm for choosing among its list of pools, the pool that will be selected to provide the connection. MultiPools do not apply to multiple-server configurations.

Author:
Copyright © 2001 BEA Systems, Inc. All Rights Reserved.

Fields inherited from class weblogic.management.configuration.DeploymentMBean
DEFAULT_ORDER, MAX_ORDER, MIN_ORDER
 
Method Summary
 java.lang.String getAlgorithmType()
          Returns algorithm type for this Multipool.
 boolean isHighAvail()
          Return true if the high availability algorithm is used in this meta pool.
 boolean isLoadBalance()
          finds out whether load balancing is used in this meta pool
 void setAlgorithmType(java.lang.String algorithm)
          Sets algorithm type for this Multipool.
 void setHighAvail(boolean useHighAvail)
          Selects the high availability algorithm for this Multipool, in which the connection pools are set up as an ordered list used in order.
 void setLoadBalance(boolean useLoadBalance)
          Selects the load balancing algorithm for this Multipool, in which the Multipool will distribute the connection requests evenly to its member pools.
 
Methods inherited from interface weblogic.management.configuration.DeploymentMBean
addTarget, getDeploymentOrder, getTargets, removeTarget, setDeploymentOrder, setTargets
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
getNotes, setNotes, setPersistenceEnabled
 
Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent
 
Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes
 
Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister
 
Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener
 

Method Detail

setLoadBalance

public void setLoadBalance(boolean useLoadBalance)
                    throws javax.management.InvalidAttributeValueException
Selects the load balancing algorithm for this Multipool, in which the Multipool will distribute the connection requests evenly to its member pools.


isLoadBalance

public boolean isLoadBalance()
finds out whether load balancing is used in this meta pool


setHighAvail

public void setHighAvail(boolean useHighAvail)
                  throws javax.management.InvalidAttributeValueException
Selects the high availability algorithm for this Multipool, in which the connection pools are set up as an ordered list used in order. That is, every time the Multipool is asked for a connection, it tries to get a connection from the first pool in its list. If unable to get a valid connection, it tries the next pool in its list. The process is repeated until a valid connection is obtained, or until the end of the list is reached, in which case an exception will be thrown. Note that the Multipool will only move to the next pool in the list when there is a real problem with the pool, for example the database is down or the pool disabled. For the cases where all connections are busy, the Multipool behaves as a single pool and an exception is thrown.


isHighAvail

public boolean isHighAvail()
Return true if the high availability algorithm is used in this meta pool.


setAlgorithmType

public void setAlgorithmType(java.lang.String algorithm)
Sets algorithm type for this Multipool.

If attribute set to "High availability", the connection pools are set up as an ordered list used in order. That is, every time the Multipool is asked for a connection, it tries to get a connection from the first pool in its list. If unable to get a valid connection, it tries the next pool in its list. The process is repeated until a valid connection is obtained, or until the end of the list is reached, in which case an exception will be thrown. Note that the Multipool will only move to the next pool in the list when there is a real problem with the pool, for example the database is down or the pool disabled. For the cases where all connections are busy, the Multipool behaves as a single pool and an exception is thrown.

If attribute set to "Load balancing" the Multipool will distribute the connection requests evenly to its member pools. This algorithm also performs the same failover behavior as the high availability algorithm.

Default value for this attribute is "High availability".

Legal Values: weblogic.management.configuration.JDBCLegalHelper.ALGORITHM_HIGH_AVAILABILITY,weblogic.management.configuration.JDBCLegalHelper.ALGORITHM_LOAD_BALANCING

getAlgorithmType

public java.lang.String getAlgorithmType()
Returns algorithm type for this Multipool.

If attribute set to "High availability", the connection pools are set up as an ordered list used in order. That is, every time the Multipool is asked for a connection, it tries to get a connection from the first pool in its list. If unable to get a valid connection, it tries the next pool in its list. The process is repeated until a valid connection is obtained, or until the end of the list is reached, in which case an exception will be thrown. Note that the Multipool will only move to the next pool in the list when there is a real problem with the pool, for example the database is down or the pool disabled. For the cases where all connections are busy, the Multipool behaves as a single pool and an exception is thrown.

If attribute set to "Load balancing" the Multipool will distribute the connection requests evenly to its member pools. This algorithm also performs the same failover behavior as the high availability algorithm.

Default value for this attribute is "High availability".

Default Value: weblogic.management.configuration.JDBCLegalHelper.ALGORITHM_HIGH_AVAILABILITY

Documentation is available at
http://e-docs.bea.com/wls/docs61

WebLogic classes and methods that do not appear in this reference are not public and are not supported.