WebLogic Server 8.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 © 2002 BEA Systems, Inc. All Rights Reserved.

Field Summary

static long

CACHING_STUB_SVUID Description of the Field

Fields inherited from class weblogic.management.configuration.DeploymentMBean

CACHING_STUB_SVUID, DEFAULT_ORDER, MAX_ORDER, MIN_ORDER

Fields inherited from class weblogic.management.configuration.ConfigurationMBean

CACHING_STUB_SVUID

Method Summary

java.lang.String	getACLName() Deprecated.
java.lang.String	getAlgorithmType() The algorithm type for this Multipool.
JDBCConnectionPoolMBean[]	getPoolList() The list of connection pools in the MultiPool.
void	setACLName(java.lang.String newACLName) Deprecated. @non-dynamic
void	setAlgorithmType(java.lang.String algorithm) The algorithm type for this Multipool.
void	setPoolList(JDBCConnectionPoolMBean[] thePoolList) The list of connection pools in the MultiPool.

Methods inherited from interface weblogic.management.configuration.DeploymentMBean

addTarget, getDeploymentOrder, getTargets, removeTarget, setDeploymentOrder, setTargets

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getNotes, restoreDefaultValue, setComments, setDefaultedMBean, 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, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Field Detail

CACHING_STUB_SVUID

public static final long CACHING_STUB_SVUID

Description of the Field

Method Detail

getACLName

public java.lang.String getACLName()

Deprecated.

The access control list (ACL) used to control access to this MultiPool.

Returns:

The aCLName value

setACLName

public void setACLName(java.lang.String newACLName)
                throws javax.management.InvalidAttributeValueException

Deprecated. @non-dynamic

The access control list (ACL) used to control access to this MultiPool.

Parameters:

newACLName - The new aCLName value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getPoolList

public JDBCConnectionPoolMBean[] getPoolList()

The list of connection pools in the MultiPool.

Returns:

The poolList value

setPoolList

public void setPoolList(JDBCConnectionPoolMBean[] thePoolList)
                 throws javax.management.InvalidAttributeValueException

The list of connection pools in the MultiPool.

Legal NULL: false

Parameters:

thePoolList - The new poolList value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setAlgorithmType

public void setAlgorithmType(java.lang.String algorithm)

The algorithm type for this Multipool.

If set to "High availability", the connection pools are set up as an ordered list. That is, every time an application asks the Multipool 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 the algorithm is 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: JDBCLegalHelper.ALGORITHM_HIGH_AVAILABILITY, JDBCLegalHelper.ALGORITHM_LOAD_BALANCING

Parameters:

algorithm - The new algorithmType value

getAlgorithmType

public java.lang.String getAlgorithmType()

The algorithm type for this Multipool.

If set to "High availability", the connection pools are set up as an ordered list. That is, every time an application asks the Multipool 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 the algorithm is 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: JDBCLegalHelper.ALGORITHM_HIGH_AVAILABILITY

Returns:

The algorithmType value