PersistentStoreMBean

Overview

This MBean is the parent of the GenericFileStoreMBean and GenericJDBCStoreMBean. It is not intended for deployment.

Related MBeans

This section describes attributes that provide access to other MBeans.

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.

Attributes

This section describes the following attributes:

CachingDisabled

Private property that disables caching in proxies.

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.

DistributionPolicy

Specifies how the instances of a configured JMS artifact are named and distributed when deployed to a cluster. When this setting is configured on a Store it applies to all JMS artifacts that reference the store. Valid options:

• Distributed

  creates an artifact instance on each cluster member in a cluster. Required for all SAF Agents and for cluster targeted or resource group scoped JMS Servers that host distributed destinations.

• Singleton

  creates one artifact instance on a single cluster member of a cluster. Required for cluster targeted or resource group scoped JMS Servers that host standalone (non-distributed) destinations and for cluster targeted or resource group scoped Path Services. The Migration Policy must be On-Failure or Always when using this option with a JMS Server, On-Failure when using this option with a Messaging Bridge, and Always when using this option with a Path Service.

The DistributionPolicy determines the instance name suffix for cluster targeted JMS artifacts. The suffix for a cluster targeted Singleton is -01 and for a cluster targeted Distributed is @ClusterMemberName.

For more information, see:

• getMigrationPolicy
• setDistributionPolicy

DynamicallyCreated

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

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.

• A value > 0 specifies the time, in seconds, to delay before failing a JMS artifact back to its user preferred server.

• A value of 0 specifies there is no delay and the dynamic load balancer manages the failback process.

• A value of -1 specifies the default delay value is used.

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

Id

Return the unique id of this MBean instance

InitialBootDelaySeconds

Specifies the amount of time, in seconds, to delay before starting a cluster targeted JMS instance on a newly booted WebLogic server. 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.

• A value > 0 is the time, in seconds, to delay before before loading resources after a failure and restart.

• A value of 0 specifies no delay.

• A value of -1 specifies the default delay value is used.

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:

• PartialClusterStabilityDelaySeconds

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.

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

MigrationPolicy

Controls migration and restart behavior of cluster targeted JMS service artifact instances. When this setting is configured on a Store it applies to all JMS artifacts that reference the store. Valid options:

• Off

  disables migration and restart support for cluster targeted JMS service objects, including the ability to restart a failed persistent store instance and its associated services. This policy can not be combined with the Singleton Migration Policy.

• On-Failure

  enables automatic migration and restart of instances on the failure of a subsystem Service or WebLogic Server instance, including automatic fail-back and load balancing of instances.

• Always

  provides the same behavior as On-Failure and automatically migrates instances even in the event of a graceful shutdown or a partial cluster start.

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

For more information, see:

• setMigrationPolicy

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

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 <. 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.

NumberOfRestartAttempts

Specifies the number of restart attempts before migrating a failed JMS artifact instance to another server in the WebLogic cluster.

• A value > 0 specifies the number of restart attempts before migrating a failed service instance.

• A value of 0specifies the same behavior as setting RestartInPlace tofalse.

• A value of -1 specifies the service is never migrated. Instead, it continues to attempt to restart until it either starts or the server instance shuts down.

ObjectName

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

Deprecated.

Parent

Return the immediate parent for this MBean

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 once a cluster is fully started (stable) or when individual servers are started.

• A value > 0 specifies the time, in seconds, to delay before a partially started cluster starts dynamically configured services.

• A value of 0 specifies no delay.

• A value of -1 specifies a default delay value of 240 seconds.

For more information, see:

• getInitialBootDelaySeconds

Registered

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

Deprecated.

RestartInPlace

Enables periodic automatic restart of failed cluster targeted JMS artifact instance(s) running on healthy WebLogic Server instances. Restart attempts occur before attempts to migrate an instance to a different server in the cluster. When this setting is configured on a Store it applies to all JMS artifacts that reference the store.

• Restarts occur when Restart In Place is set to true, the JMS artifact is cluster targeted, and the Migration Policy is set to On-Failure or Always>.

• This attribute is not used by WebLogic Messaging Bridges which automatically restart internal connections as needed.

For more information, see:

• setRestartInPlace

SecondsBetweenRestarts

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

Tags

Return all tags on this Configuration MBean

Type

Returns the type of the MBean.

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.

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.

addTarget

Targets a server instance to a store.

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

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.

isInherited

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

isSet

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

removeTag

Remove a tag from this Configuration MBean

removeTarget

Untargets a server instance from a store.

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

unSet

Restore the given property to its default value.