WebLogic Server 8.1 API Reference

weblogic.management.configuration
Interface JDBCDataSourceMBean

public interface JDBCDataSourceMBean

extends DeploymentMBean

This MBean defines a non-transactional JDBC DataSource.

Author:

Copyright © 2004 BEA Systems, Inc. All Rights Reserved.

Field Summary

static long

CACHING_STUB_SVUID

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, DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

int	getConnectionWaitPeriod() Deprecated.
java.lang.String	getJNDIName() The JNDI path to where this DataSource is bound.
java.lang.String	getJNDINameSeparator() The JNDI Seperator is used to seperate JNDIName list for this DataSource.
java.lang.String	getPoolName() The name of the connection pool with which the DataSource is associated.
int	getRowPrefetchSize() The number of result set rows to prefetch for a client.
int	getStreamChunkSize() Data chunk size for steaming datatypes.
boolean	isRowPrefetchEnabled() Controls row prefetching between a client and WebLogic Server for each ResultSet.
boolean	isWaitForConnectionEnabled() Deprecated.
void	setConnectionWaitPeriod(int waitseconds) Deprecated.
void	setJNDIName(java.lang.String name) Sets the JNDI path to where this DataSource is bound.
void	setJNDINameSeparator(java.lang.String name) Sets the Separator used for list of different JNDINames for this DataSource.
void	setPoolName(java.lang.String pool) Sets the name of the JDBC connection pool that is associated with this DataSource.
void	setRowPrefetchEnabled(boolean enable) Set to true to enable row prefetching between a client and WebLogic Server for each ResultSet.
void	setRowPrefetchSize(int prefetch)
void	setStreamChunkSize(int chunk_size) Sets the streamChunkSize attribute of the JDBCDataSourceMBean object
void	setWaitForConnectionEnabled(boolean enable) Deprecated.

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

Method Detail

getJNDIName

public java.lang.String getJNDIName()

The JNDI path to where this DataSource is bound.

Applications that look up the JNDI path will get a javax.sql.DataSource instance that corresponds to this DataSource.

Legal NULL: false

Returns:

The jNDIName value

setJNDIName

public void setJNDIName(java.lang.String name)
                 throws javax.management.InvalidAttributeValueException

Sets the JNDI path to where this DataSource is bound. Applications that look up the JNDI path will get a javax.sql.DataSource instance that corresponds to this DataSource. Note that the old style usage of DriverManager.getConnection() or Driver.connect() has been deprecated in favor of looking up a datasource to obtain a connection.

Legal Value: ((value != null) && (value.trim().length() > 0))

Parameters:

name - The new jNDIName value

Throws:

javax.management.InvalidAttributeValueException -

getJNDINameSeparator

public java.lang.String getJNDINameSeparator()

The JNDI Seperator is used to seperate JNDIName list for this DataSource.

Applications that look up the JNDI path will get a javax.sql.DataSource instance that corresponds to this DataSource.

Default Value: ;

Legal NULL: false

Returns:

The jNDINameSeparator value

setJNDINameSeparator

public void setJNDINameSeparator(java.lang.String name)
                          throws javax.management.InvalidAttributeValueException

Sets the Separator used for list of different JNDINames for this DataSource. Applications that look up the JNDI path will get a javax.sql.DataSource instance that corresponds to this DataSource.

Legal Value: ((value != null) && (value.trim().length() > 0))

Parameters:

name - The new jNDINameSeparator value

Throws:

javax.management.InvalidAttributeValueException -

getPoolName

public java.lang.String getPoolName()

The name of the connection pool with which the DataSource is associated.

Calls from applications to getConnection() on this DataSource will return a connection from the associated connection pool.

Returns:

The poolName value

setPoolName

public void setPoolName(java.lang.String pool)
                 throws javax.management.InvalidAttributeValueException

Sets the name of the JDBC connection pool that is associated with this DataSource. Calls to getConnection() on this DataSource will return a connection from the associated connection pool.

Legal Value: (value != null) && (value.trim().length() > 0)

Parameters:

pool - The new poolName value

Throws:

javax.management.InvalidAttributeValueException -

isRowPrefetchEnabled

public boolean isRowPrefetchEnabled()

Controls row prefetching between a client and WebLogic Server for each ResultSet. When an external client accesses a database using JDBC through WebLogic Server, row prefetching improves performance by fetching multiple rows from the server to the client in one server access. WebLogic Server will ignore this setting and not use row prefetching when the client and WebLogic Server are in the same JVM.

Default Value: false

Returns:

The rowPrefetchEnabled value

setRowPrefetchEnabled

public void setRowPrefetchEnabled(boolean enable)

Set to true to enable row prefetching between a client and WebLogic Server for each ResultSet. When an external client accesses a database using JDBC through WebLogic Server, row prefetching improves performance by fetching multiple rows from the server to the client in one server access. WebLogic Server will ignore this setting and not use row prefetching when the client and WebLogic Server are in the same JVM.

Default Value: false

Parameters:

enable - The new rowPrefetchEnabled value

getRowPrefetchSize

public int getRowPrefetchSize()

The number of result set rows to prefetch for a client. The optimal value depends on the particulars of the query. In general, increasing this number will increase performance, until a particular value is reached. At that point further increases do not result in any significant performance increase. Very rarely will increased performance result from exceeding 100 rows. The default value should be reasonable for most situations.

Default Value: 48

Legal Minimum Value: 2

Legal Maximum Value: 65536

Returns:

The rowPrefetchSize value

setRowPrefetchSize

public void setRowPrefetchSize(int prefetch)

Parameters:

prefetch - The new rowPrefetchSize value

getStreamChunkSize

public int getStreamChunkSize()

Data chunk size for steaming datatypes. Streaming datatypes (for example resulting from a call to getBinaryStream()) will be pulled in StreamChunkSize sized chunks from WebLogic Server to the client as needed.

Default Value: 256

Legal Minimum Value: 1

Legal Maximum Value: 65536

Returns:

The streamChunkSize value

setStreamChunkSize

public void setStreamChunkSize(int chunk_size)

Sets the streamChunkSize attribute of the JDBCDataSourceMBean object

Parameters:

chunk_size - The new streamChunkSize value

isWaitForConnectionEnabled

public boolean isWaitForConnectionEnabled()

Deprecated.

Returns true if the system will wait for a free connection pool entry to become available when a request is made with all pool entries in use. In order to avoid tying up server threads and possibly hurting performance, it is recommended that this feature not be used.

Default Value: false

Returns:

The waitForConnectionEnabled value

setWaitForConnectionEnabled

public void setWaitForConnectionEnabled(boolean enable)

Deprecated.

Allow the sytem to wait for a free connection pool entry to become available if a request is received when there are no free entries in the pool. A WLS server thread is occupied while waiting for a free connection, and this can result in a decrease in system throughput. Therefore, the recommended way to deal with the exhaustion of a connection pool is to increase the size of the pool, and this method is not recommended for use in a production environment!

Default Value: false

Secure Value: false

Parameters:

enable - The new waitForConnectionEnabled value

getConnectionWaitPeriod

public int getConnectionWaitPeriod()

Deprecated.

The time in seconds which the system will wait for a free connection pool entry to become available if a request is received when there are no free entries in the pool. This value will be used only if setWaitForConnectionEnabled(true) has previously been called. A WLS server thread is occupied while waiting for a free connection, and this can result in a decrease in system throughput. Therefore, the recommended way to deal with the exhaustion of a connection pool is to increase the size of the pool, and this method is not recommended for use in a production environment!

Default Value: 1

Legal Minimum Value: 1

Legal Maximum Value: 60

Returns:

The connectionWaitPeriod value

setConnectionWaitPeriod

public void setConnectionWaitPeriod(int waitseconds)

Deprecated.

Sets the connectionWaitPeriod attribute of the JDBCDataSourceMBean object

Parameters:

waitseconds - The new connectionWaitPeriod value