JDBCStoreMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

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.

               
Since9.0.0.0
Security rolesThe following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
  • Deployer
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.JDBCStoreMBean
Factory Methods
Access Points Inherited from DeploymentMBean Because this MBean extends or implements DeploymentMBean, you can also access this MBean by retrieving DeploymentMBeans. The following attributes contain DeploymentMBeans and its subtypes:
    Access Points Inherited from PersistentStoreMBean Because this MBean extends or implements PersistentStoreMBean, you can also access this MBean by retrieving PersistentStoreMBeans. The following attributes contain PersistentStoreMBeans and its subtypes:
    Subtypes The following MBeans extend or implement this MBean type:


      Related MBeans

      This section describes attributes that provide access to other MBeans.


        DataSource

        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.

               
        Privileges Read/Write
        TypeJDBCSystemResourceMBean
        Relationship type: Reference.
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        Targets

        The server instances, clusters, or migratable targets defined in the current domain that are candidates for hosting a file store, JDBC store, or replicated store. If scoped to a Resource Group or Resource Group Template, the target is inherited from the Virtual Target.

        When selecting a cluster, the store must be targeted to the same cluster as the JMS server. When selecting a migratable target, the store must be targeted it to the same migratable target as the migratable JMS server or SAF agent. As a best practice, a path service should use its own custom store and share the same target as the store.

               
        Privileges Read/Write
        TypeTargetMBean[]
        Relationship type: Reference.


        Attributes

        This section describes the following attributes:


        CachingDisabled

        Private property that disables caching in proxies.

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read only
        Typeboolean
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        ConnectionCachingPolicy

        Advanced use only: gets the connection caching policy for the JDBC store.

        The return values will be one of:

        IMPORTANT: See the below for additional usage information, particularly regarding NONE

        DEFAULT

        The default mode of operation for the JDBC store. The JDBC store will open two connections to the database and it will keep these connections open for the life of the store. In addition, if the worker count for the store is two or more, then it will open one connection for each of the workers and those connections will also stay open for the life of the JDBC store. If the worker count is 3 then the JDBC store will use 5 database connections. If the worker count is the default of 1 then the JDBC store will use just 2 connections.The DEFAULT setting is the recommended setting to be used when the database backing the JDBC store is not constrained with respect to the number of open connections.

        MINIMAL

        The JDBC store will open one connection to the database and it will keep that connection open for the life of the store. In addition, if the worker count for the store is two or more, then it will open one connection for each of the workers and those connections will also stay open for the life of the JDBC store. If the worker count is 3 then the JDBC store will use 4 database connections. If the worker count is the default of 1 then the JDBC store will use just 1 connection. The MINIMAL setting may result in a slight reduction of through-put for low concurrency messaging scenarios in comparison to DEFAULT.

        NONE

        The NONE connection caching policy is for 'advanced usage only'. The JDBC store will open one connection to the database on an as-needed basis to perform I/O and it will release that connection when the operation is complete. The NONE value is not compatible with a configured worker count of 2 or more and will result in a configuration validation exception. The NONE setting may result in a slight reduction of through-put for low concurrency messaging scenarios in comparison to DEFAULT or MINIMAL.

        NOTE: It is strongly recommended that a JDBC store be configured with a dedicated data source when the store is configured with the NONE connection caching policy. A store that shares a data source with other non-store components or applications runs the risk of failing due to dead-locks. Please note that a JDBC store will require more than one connection when first started. As such, a data source should be configured to grow and shrink so that the JDBC store can initialize.

        For more information, see:

               
        Available Since Release 12.2.1.1.0
        Privileges Read/Write
        Typejava.lang.String
        Default ValueDEFAULT
        Legal Values
        • DEFAULT
        • MINIMAL
        • NONE

        CreateTableDDLFile

        Specifies the DDL (Data Definition Language) file to use for creating the JDBC store's backing table.

               
        Privileges Read/Write
        Typejava.lang.String

        DeletesPerBatchMaximum

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

        For more information, see:

               
        Privileges Read/Write
        Typeint
        Default Value20
        Minimum value1
        Maximum value100

        DeletesPerStatementMaximum

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

        For more information, see:

               
        Privileges Read/Write
        Typeint
        Default Value20
        Minimum value1
        Maximum value100

        DeploymentOrder

        A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

        For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

        Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

               
        Privileges Read/Write
        Typeint
        Default Value1000
        Minimum value0
        Maximum value2147483647

        DistributionPolicy

        Specifies how the instances of a configured JMS artifact are named and distributed when cluster-targeted. A JMS artifact is cluster-targeted when its target is directly set to a cluster, or when it is scoped to a resource group and the resource group is in turn targeted to a cluster. When this setting is configured on a store, it applies to all JMS artifacts that reference the store. Valid options:

        Instance Naming Note:

        Messaging Bridge Notes:

        For more information, see:

               
        Privileges Read/Write
        Typejava.lang.String
        Default ValueDistributed
        Legal Values
        • Distributed
        • Singleton

        DynamicallyCreated

        Return whether the MBean was created dynamically or is persisted to config.xml

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read only
        Typeboolean
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        FailbackDelaySeconds

        Specifies the amount of time, in seconds, to delay before failing a cluster-targeted JMS artifact instance back to its preferred server after the preferred server failed and was restarted.

        This delay allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.

        Note:

        This setting only applies when the JMS artifact is cluster-targeted and the Migration Policy is set to On-Failure or Always.

               
        Privileges Read/Write
        Typelong
        Default Value-1

        FailOverLimit

        Specify a limit for the number of cluster-targeted JMS artifact instances that can fail over to a particular JVM.

        This can be used to prevent too many instances from starting on a server, avoiding a system failure when starting too few servers of a formerly large cluster.

        A typical limit value should allow all instances to run in the smallest desired cluster size, which means (smallest-cluster-size * (limit + 1)) should equal or exceed the total number of instances.

        Note:

        This setting only applies when the JMS artifact is cluster-targeted and the Migration Policy is set to On-Failure or Always.

               
        Privileges Read/Write
        Typeint
        Default Value-1
        Minimum value-1

        Id

        Return the unique id of this MBean instance

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read only
        Typelong
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        InitialBootDelaySeconds

        Specifies the amount of time, in seconds, to delay before starting a cluster-targeted JMS instance on a newly booted WebLogic Server instance. When this setting is configured on a store, it applies to all JMS artifacts that reference the store.

        This allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.

        Note:

        This setting only applies when the JMS artifact is cluster-targeted and the Migration Policy is set to On-Failure or Always.

        For more information, see:

               
        Privileges Read/Write
        Typelong
        Default Value60

        InsertsPerBatchMaximum

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

        For more information, see:

               
        Privileges Read/Write
        Typeint
        Default Value20
        Minimum value1
        Maximum value100

        LogicalName

        The name used by subsystems to refer to different stores on different servers using the same name.

        For example, an EJB that uses the timer service may refer to its store using the logical name, and this name may be valid on multiple servers in the same cluster, even if each server has a store with a different physical name.

        Multiple stores in the same domain or the same cluster may share the same logical name. However, a given logical name may not be assigned to more than one store on the same server.

               
        Privileges Read/Write
        Typejava.lang.String

        MBeanInfo

        Returns the MBean info for this MBean.

        This attribute is not dynamic and requires a server restart to take effect.

        Deprecated.

               
        Privileges Read only
        Typejavax.management.MBeanInfo
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        MigrationPolicy

        Controls migration and restart behavior of cluster-targeted JMS service artifact instances. When this setting is configured on a cluster-targeted store, it applies to all JMS artifacts that reference the store. See the migratable target settings for enabling migration and restart on migratable-targeted JMS artifacts.

        Note:

        Cluster leasing must be configured for On-Failure and Always.

        Messaging Bridge Notes:

        For more information, see:

               
        Privileges Read/Write
        Typejava.lang.String
        Default ValueOff
        Legal Values
        • Off
        • On-Failure
        • Always

        Name

        The user-specified name of this MBean instance.

        This name is included as one of the key properties in the MBean's javax.management.ObjectName:

        Name=user-specified-name

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read/Write
        Typejava.lang.String

        Notes

        Optional information that you can include to describe this configuration.

        WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. Carriage returns/line feeds are preserved.

        Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

        This attribute is not dynamic and requires a server restart to take effect.

                   
        Privileges Read/Write
        Security rolesWrite access is granted only to the following roles:
        • Deployer
        • Operator
        Typejava.lang.String

        NumberOfRestartAttempts

        Specifies the maximum number of restart attempts.

               
        Privileges Read/Write
        Typeint
        Default Value6
        Minimum value-1

        ObjectName

        Returns the ObjectName under which this MBean is registered in the MBean server.

        This attribute is not dynamic and requires a server restart to take effect.

        Deprecated.

               
        Privileges Read only
        Typeweblogic.management.WebLogicObjectName
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        OraclePiggybackCommitEnabled

        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.

        Deprecated. 12.2.1.3.1

               
        Privileges Read/Write
        Typeboolean

        Parent

        Return the immediate parent for this MBean

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read/Write
        Type

        PartialClusterStabilityDelaySeconds

        Specifies the amount of time, in seconds, to delay before a partially started cluster starts all cluster-targeted JMS artifact instances that are configured with a Migration Policy of Always or On-Failure.

        Before this timeout expires or all servers are running, a cluster starts a subset of such instances based on the total number of servers running and the configured cluster size. Once the timeout expires or all servers have started, the system considers the cluster stable and starts any remaining services.

        This delay ensures that services are balanced across a cluster even if the servers are started sequentially. It is ignored after a cluster is fully started (stable) or when individual servers are started.

        For more information, see:

               
        Privileges Read/Write
        Typelong
        Default Value240

        PrefixName

        The prefix for the JDBC store's database table (WLStore), in the following format: [[[catalog.]schema.]prefix].

        Each period symbol in the [[catalog.]schema.]prefix format is significant, where schema generally corresponds to username in many databases. When no prefix is specified, the JDBC store table name is simply WLStore and the database implicitly determines the schema according to the JDBC connection's user. As a best practice, you should always configure a prefix for the JDBC WLStore table name.

        For specific guidelines about using JDBC store prefixes, refer to the "Using the WebLogic Store" section of Designing and Configuring WebLogic Server Environments".

               
        Privileges Read/Write
        Typejava.lang.String

        ReconnectRetryIntervalMillis

        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

        For more information, see:

               
        Available Since Release 12.2.1.0.0
        Privileges Read/Write
        Typeint
        Default Value200
        Minimum value100
        Maximum value10000

        ReconnectRetryPeriodMillis

        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

        For more information, see:

               
        Available Since Release 12.2.1.0.0
        Privileges Read/Write
        Typeint
        Default Value1000
        Minimum value200
        Maximum value300000

        Registered

        Returns false if the MBean represented by this object has been unregistered.

        This attribute is not dynamic and requires a server restart to take effect.

        Deprecated.

               
        Privileges Read only
        Typeboolean
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        RestartInPlace

        Enables a periodic automatic in-place restart of failed cluster-targeted or standalone-server-targeted JMS artifact instance(s) running on healthy WebLogic Server instances. See the migratable target settings for in-place restarts of migratable-targeted JMS artifacts. When the Restart In Place setting is configured on a store, it applies to all JMS artifacts that reference the store.

        For more information, see:

               
        Privileges Read/Write
        Typeboolean

        SecondsBetweenRestarts

        Specifies the amount of time, in seconds, to wait in between attempts to restart a failed service instance.

               
        Privileges Read/Write
        Typeint
        Default Value30
        Minimum value1

        Tags

        Return all tags on this Configuration MBean

        This attribute is dynamic and takes effect immediately.

               
        Available Since Release 12.2.1.0.0
        Privileges Read/Write
        Typeclass java.lang.String[]

        ThreeStepThreshold

        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.

               
        Privileges Read/Write
        Typeint
        Default Value200000
        Minimum value4000
        Maximum value2147483647

        Type

        Returns the type of the MBean.

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read only
        Typejava.lang.String
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        WorkerCount

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

               
        Privileges Read/Write
        Typeint
        Default Value1
        Minimum value1
        Maximum value1000

        WorkerPreferredBatchSize

        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.

               
        Privileges Read/Write
        Typeint
        Default Value10
        Minimum value1
        Maximum value2147483647

        XAResourceName

        Overrides the name of the XAResource that this store registers with JTA.

        You should not normally set this attribute. Its purpose is to allow the name of the XAResource to be overridden when a store has been upgraded from an older release and the store contained prepared transactions. The generated name should be used in all other cases.

               
        Privileges Read only
        Typejava.lang.String
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


        Operations

        This section describes the following operations:


        addTag

        Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.

           
        Operation Name"addTag"
        ParametersObject [] {  tag }

        where:

        • tag is an object of type java.lang.String that specifies:

          tag to be added to the MBean

        SignatureString [] { "java.lang.String" }
        Returns boolean
        Exceptions
        • java.lang.IllegalArgumentException
          IllegalArgumentException if the tag contains illegal punctuation

        addTarget

        Targets a server instance to a store.

           
        Operation Name"addTarget"
        ParametersObject [] {  target }

        where:

        • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

          target

        SignatureString [] { "weblogic.management.configuration.TargetMBean" }
        Returns boolean
        Exceptions
        • javax.management.InvalidAttributeValueException
        • weblogic.management.DistributedManagementException

        freezeCurrentValue

        If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

        Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

        Note: To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

        This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

        Deprecated. 9.0.0.0

           
        Operation Name"freezeCurrentValue"
        ParametersObject [] {  attributeName }

        where:

        • attributeName is an object of type java.lang.String that specifies:

          attributeName

        SignatureString [] { "java.lang.String" }
        Returns void
        Exceptions
        • javax.management.AttributeNotFoundException
        • javax.management.MBeanException

        getInheritedProperties

        Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

           
        Operation Name"getInheritedProperties"
        ParametersObject [] {  propertyNames }

        where:

        • propertyNames is an object of type [Ljava.lang.String; that specifies:

          properties to check

        SignatureString [] { "[Ljava.lang.String;" }
        Returns class

        isInherited

        Check if the value of a property is inherited from template mbean or not.

           
        Operation Name"isInherited"
        ParametersObject [] {  propertyName }

        where:

        • propertyName is an object of type java.lang.String that specifies:

          the name of the property

        SignatureString [] { "java.lang.String" }
        Returns boolean

        isSet

        Returns true if the specified attribute has been set explicitly in this MBean instance.

           
        Operation Name"isSet"
        ParametersObject [] {  propertyName }

        where:

        • propertyName is an object of type java.lang.String that specifies:

          property to check

        SignatureString [] { "java.lang.String" }
        Returns boolean

        removeTag

        Remove a tag from this Configuration MBean

           
        Operation Name"removeTag"
        ParametersObject [] {  tag }

        where:

        • tag is an object of type java.lang.String that specifies:

          tag to be removed from the MBean

        SignatureString [] { "java.lang.String" }
        Returns boolean
        Exceptions
        • java.lang.IllegalArgumentException
          IllegalArgumentException if the tag contains illegal punctuation

        removeTarget

        Untargets a server instance from a store.

           
        Operation Name"removeTarget"
        ParametersObject [] {  target }

        where:

        • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

          target

        SignatureString [] { "weblogic.management.configuration.TargetMBean" }
        Returns boolean
        Exceptions
        • javax.management.InvalidAttributeValueException
        • weblogic.management.DistributedManagementException

        restoreDefaultValue

        If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

        Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

        This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

        Deprecated. 9.0.0.0

           
        Operation Name"restoreDefaultValue"
        ParametersObject [] {  attributeName }

        where:

        • attributeName is an object of type java.lang.String that specifies:

          attributeName

        SignatureString [] { "java.lang.String" }
        Returns void
        Exceptions
        • javax.management.AttributeNotFoundException

        unSet

        Restore the given property to its default value.

           
        Operation Name"unSet"
        ParametersObject [] {  propertyName }

        where:

        • propertyName is an object of type java.lang.String that specifies:

          property to restore

        SignatureString [] { "java.lang.String" }
        Returns void