Package weblogic.management.configuration

Interface JDBCStoreMBean

All Superinterfaces:

ConfigurationMBean, DeploymentMBean, DescriptorBean, DynamicDeploymentMBean, javax.management.DynamicMBean, GenericJDBCStoreMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, PersistentStoreMBean, SettableBean, WebLogicMBean

All Known Subinterfaces:

TransactionLogJDBCStoreMBean

@SingleTargetOnly
public interface JDBCStoreMBean
extends GenericJDBCStoreMBean, PersistentStoreMBean

Defines an instance of the persistent store that stores its persistent records in a JDBC-accessible database. It may be used by JMS and by other subsystems.

Access limited to the following security roles:

Deployer

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Fields inherited from interface weblogic.management.configuration.DeploymentMBean

DEFAULT_ORDER, MAX_ORDER, MIN_ORDER

Method Summary

Modifier and Type	Method	Description
JDBCSystemResourceMBean	getDataSource()	The JDBC data source used by this JDBC store to access its backing table.
int	getDeletesPerBatchMaximum()	The maximum number of table rows that are deleted per database call.
int	getDeletesPerStatementMaximum()	The maximum number of table rows that are deleted per database call.
int	getInsertsPerBatchMaximum()	The maximum number of table rows that are inserted per database call.
int	getReconnectRetryIntervalMillis()	The length of time in milliseconds between reconnection attempts during the reconnection retry period.
int	getReconnectRetryPeriodMillis()	Returns the length of time in milliseconds during which the persistent store will attempt to re-establish a connection to the database.
int	getThreeStepThreshold()	Specifies the threshold, in bytes, when the JDBC store uses 3 steps (insert, select, populate) instead of 1 step (insert) to populate an Oracle Blob data type.
int	getWorkerCount()	The number of JDBC store worker threads to process the workerload.
int	getWorkerPreferredBatchSize()	Specifies the batch size when the Worker Count attribute is configured to a value greater than 1.
boolean	isOraclePiggybackCommitEnabled()	Deprecated. 12.2.1.3.1
void	setDataSource(JDBCSystemResourceMBean dataSource)	Sets the value of the DataSource attribute.
void	setDeletesPerBatchMaximum(int deletesPerBatchMaximum)	Sets the value of the DeletesPerBatchMaximum attribute.
void	setDeletesPerStatementMaximum(int deletesPerBatchMaximum)	Sets the value of the DeletesPerStatementMaximum attribute.
void	setInsertsPerBatchMaximum(int deletesPerBatchMaximum)	Sets the value of the InsertsPerBatchMaximu attribute.
void	setOraclePiggybackCommitEnabled(boolean enable)	Deprecated. 12.2.1.3.1
void	setReconnectRetryIntervalMillis(int reconnectRetryIntervalMillis)	Set the length of time in milliseconds between reconnection attempts during the reconnection retry period.
void	setReconnectRetryPeriodMillis(int reconnectRetryPeriodMillis)	Set the length of time in milliseconds during which the persistent store will attempt to re-establish a connection to the database.
void	setThreeStepThreshold(int threeStepThreshold)	Sets the value of the ThreeStepThreshold attribute.
void	setWorkerCount(int workerCount)	Sets the value of the WorkerCount attribute.
void	setWorkerPreferredBatchSize(int workerLoadSize)	Sets the value of the WorkerPreferredBatchSize attribute.

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, restoreDefaultValue, setComments, setDefaultedMBean, setNotes, setPersistenceEnabled

Methods inherited from interface weblogic.management.configuration.DeploymentMBean

getDeploymentOrder, setDeploymentOrder

Methods inherited from interface weblogic.descriptor.DescriptorBean

addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

Methods inherited from interface weblogic.management.configuration.DynamicDeploymentMBean

getDistributionPolicy, getFailbackDelaySeconds, getFailOverLimit, getInitialBootDelaySeconds, getMigrationPolicy, getNumberOfRestartAttempts, getPartialClusterStabilityDelaySeconds, getRebalanceEnabled, getRestartInPlace, getSecondsBetweenRestarts, setDistributionPolicy, setFailbackDelaySeconds, setFailOverLimit, setInitialBootDelaySeconds, setMigrationPolicy, setNumberOfRestartAttempts, setPartialClusterStabilityDelaySeconds, setRebalanceEnabled, setRestartInPlace, setSecondsBetweenRestarts

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface weblogic.management.configuration.GenericJDBCStoreMBean

getCreateTableDDLFile, getPrefixName, setCreateTableDDLFile, setPrefixName

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preDeregister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.configuration.PersistentStoreMBean

addTarget, getLogicalName, getTargets, getXAResourceName, removeTarget, setLogicalName, setTargets, setXAResourceName

Methods inherited from interface weblogic.management.WebLogicMBean

getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

Method Detail

getDataSource

JDBCSystemResourceMBean getDataSource()

The JDBC data source used by this JDBC store to access its backing table.

The specified data source must use a non-XA JDBC driver since connection pools for XA JDBC drivers are not supported.

setDataSource

void setDataSource(JDBCSystemResourceMBean dataSource)
            throws javax.management.InvalidAttributeValueException

Sets the value of the DataSource attribute.

Throws:

javax.management.InvalidAttributeValueException

See Also:

getDataSource()

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

getDeletesPerBatchMaximum

int getDeletesPerBatchMaximum()

The maximum number of table rows that are deleted per database call.

• When possible, a JDBC store uses JDBC 3.0 batching to batch concurrent client requests.
• Both the maximum batch size for concurrent inserts and for concurrent writes are configurable.
• To disable JDBC 3.0 batching, set the maximum batch size to 1.
• The maximum batch size has no effect on the maximum number of concurrent client requests.

Returns:

The deletesPerBatchMaximum value

See Also:

getInsertsPerBatchMaximum(), getDeletesPerStatementMaximum()

setDeletesPerBatchMaximum

void setDeletesPerBatchMaximum(int deletesPerBatchMaximum)
                        throws javax.management.InvalidAttributeValueException

Sets the value of the DeletesPerBatchMaximum attribute.

Throws:

javax.management.InvalidAttributeValueException

DistributedManagementException

See Also:

getDeletesPerBatchMaximum()

Default Value:

20

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

100

Minimum Value:

1

getInsertsPerBatchMaximum

int getInsertsPerBatchMaximum()

The maximum number of table rows that are inserted per database call.

• When possible, a JDBC store uses JDBC 3.0 batching to batch concurrent client requests.
• Both the maximum batch size for concurrent inserts and for concurrent writes are configurable.
• To disable JDBC 3.0 batching, set the maximum batch size to 1.
• The maximum batch size has no effect on the maximum number of concurrent client requests.

Returns:

The insertsPerBatchMaximum value

See Also:

getDeletesPerBatchMaximum(), getDeletesPerStatementMaximum()

setInsertsPerBatchMaximum

void setInsertsPerBatchMaximum(int deletesPerBatchMaximum)
                        throws javax.management.InvalidAttributeValueException

Sets the value of the InsertsPerBatchMaximu attribute.

Throws:

javax.management.InvalidAttributeValueException

See Also:

getInsertsPerBatchMaximum()

Default Value:

20

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

100

Minimum Value:

1

getDeletesPerStatementMaximum

int getDeletesPerStatementMaximum()

The maximum number of table rows that are deleted per database call.

• Applies only when a JDBC store does not use JDBC 3.0 batching to batch concurrent client requests.
• The maximum deletes per statement has no effect on the maximum number of concurrent client requests.
• For some databases, the JDBC store may choose a lower value than the one configured.

Returns:

The deletesPerStatementMaximum value

See Also:

getDeletesPerBatchMaximum(), getInsertsPerBatchMaximum()

setDeletesPerStatementMaximum

void setDeletesPerStatementMaximum(int deletesPerBatchMaximum)
                            throws javax.management.InvalidAttributeValueException

Sets the value of the DeletesPerStatementMaximum attribute.

Throws:

javax.management.InvalidAttributeValueException

See Also:

getDeletesPerStatementMaximum()

Default Value:

20

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

100

Minimum Value:

1

getWorkerCount

int getWorkerCount()

The number of JDBC store worker threads to process the workerload.

• A value of 1 indicates a single thread is used (the default).
• A value greater than 1 indicates that multiple threads are used.
• For Oracle databases, Oracle recommends users rebuild the primary key index into a reverse index for the JDBC Store table when the worker count is greater than 1.
• For non-Oracle databases, refer to the database provider's documentation for help with indexing.

Returns:

The WorkerCount value

setWorkerCount

void setWorkerCount(int workerCount)
             throws javax.management.InvalidAttributeValueException

Sets the value of the WorkerCount attribute.

Throws:

javax.management.InvalidAttributeValueException

See Also:

getWorkerCount()

Default Value:

1

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

1000

Minimum Value:

1

getWorkerPreferredBatchSize

int getWorkerPreferredBatchSize()

Specifies the batch size when the Worker Count attribute is configured to a value greater than 1.

Used to configure the workload the JDBC store incrementally puts on each worker thread. The workload consists of IO requests which are grouped and pushed to each JDBC worker thread for processing. If the IO request is very large (for example 1M), then tune this attribute to a smaller value.

Returns:

The WorkerPreferredBatchSize value

setWorkerPreferredBatchSize

void setWorkerPreferredBatchSize(int workerLoadSize)
                          throws javax.management.InvalidAttributeValueException

Sets the value of the WorkerPreferredBatchSize attribute.

The default value is 10.

Throws:

javax.management.InvalidAttributeValueException

See Also:

getWorkerPreferredBatchSize()

Default Value:

10

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

1

getThreeStepThreshold

int getThreeStepThreshold()

Specifies the threshold, in bytes, when the JDBC store uses 3 steps (insert, select, populate) instead of 1 step (insert) to populate an Oracle Blob data type.

Applies only to Oracle databases where a Blob data type is used instead of the default Long Raw data type for record data.

The default value is 200000.

Returns:

The threeStepThreshold value

setThreeStepThreshold

void setThreeStepThreshold(int threeStepThreshold)
                    throws javax.management.InvalidAttributeValueException

Sets the value of the ThreeStepThreshold attribute.

Throws:

javax.management.InvalidAttributeValueException

See Also:

getThreeStepThreshold()

Default Value:

200000

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

4000

setOraclePiggybackCommitEnabled

@Deprecated
void setOraclePiggybackCommitEnabled(boolean enable)

Deprecated.

12.2.1.3.1

Sets the value of the OraclePiggybackCommitEnabled attribute.

Default Value:

false

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

isOraclePiggybackCommitEnabled

@Deprecated
boolean isOraclePiggybackCommitEnabled()

Deprecated.

12.2.1.3.1

Enables committing a batch of INSERT or DELETE operations with the last operation of the transaction instead of issuing a separate commit call to database server which saves a server round trip. This feature benefits applications that have many transactions of a small number of operations or small messages.

Default Value:

false

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

setReconnectRetryPeriodMillis

void setReconnectRetryPeriodMillis(int reconnectRetryPeriodMillis)

Set the length of time in milliseconds during which the persistent store will attempt to re-establish a connection to the database. The JDBC Store will repeatedly attempt to reconnection to the database during this period until the period has expired. The JDBC store will wait a specified period of time between reconnection attempts.

The reconnection period applies to JDBC connections regardless of the database that is used for the JDBC store.

See Also:

getReconnectRetryPeriodMillis(), getReconnectRetryIntervalMillis(), setReconnectRetryIntervalMillis(int)

Default Value:

1000

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

300000

Minimum Value:

200

getReconnectRetryPeriodMillis

int getReconnectRetryPeriodMillis()

Returns the length of time in milliseconds during which the persistent store will attempt to re-establish a connection to the database. Successive reconnection attempts will be attempted after a fixed delay that is specified by the reconnection retry interval.

The reconnection period applies to JDBC connections regardless of the database that is used for the JDBC store.

The default value is 1000

Returns:

The length of the reconnection retry period in milliseconds

See Also:

setReconnectRetryPeriodMillis(int), getReconnectRetryIntervalMillis(), setReconnectRetryIntervalMillis(int)

setReconnectRetryIntervalMillis

void setReconnectRetryIntervalMillis(int reconnectRetryIntervalMillis)

Set the length of time in milliseconds between reconnection attempts during the reconnection retry period.

The reconnection interval applies to JDBC connections regardless of the database that is used for the JDBC store.

Default Value:

200

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

10000

Minimum Value:

100

getReconnectRetryIntervalMillis

int getReconnectRetryIntervalMillis()

The length of time in milliseconds between reconnection attempts during the reconnection retry period.

The reconnection interval applies to JDBC connections regardless of the database that is used for the JDBC store.

The default value is 200 milliseconds

Returns:

The length of time in milliseconds between reconnection attempts within the retry period

See Also:

getReconnectRetryPeriodMillis(), setReconnectRetryPeriodMillis(int)