Package weblogic.management.configuration

Interface DynamicDeploymentMBean

All Superinterfaces:

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

All Known Subinterfaces:

FileStoreMBean, JDBCStoreMBean, MessagingBridgeMBean, PersistentStoreMBean, ReplicatedStoreMBean, TransactionLogJDBCStoreMBean, weblogic.management.configuration.TransactionLogStoreMBean

public interface DynamicDeploymentMBean
extends DeploymentMBean

Definition of a dynamic deployment interface

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
java.lang.String	getDistributionPolicy()	Specifies how the instances of a configured JMS artifact are named and distributed when cluster-targeted.
long	getFailbackDelaySeconds()	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.
int	getFailOverLimit()	Specify a limit for the number of cluster-targeted JMS artifact instances that can fail over to a particular JVM.
long	getInitialBootDelaySeconds()	Specifies the amount of time, in seconds, to delay before starting a cluster-targeted JMS instance on a newly booted WebLogic Server instance.
java.lang.String	getMigrationPolicy()	Controls migration and restart behavior of cluster-targeted JMS service artifact instances.
int	getNumberOfRestartAttempts()	Specifies the maximum number of restart attempts.
long	getPartialClusterStabilityDelaySeconds()	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.
boolean	getRebalanceEnabled()	If set to true, then rebalance running cluster-targeted JMS instances when the system is idle and instances are unevenly distributed.
boolean	getRestartInPlace()	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.
int	getSecondsBetweenRestarts()	Specifies the amount of time, in seconds, to wait in between attempts to restart a failed service instance.
void	setDistributionPolicy(java.lang.String distributionPolicy)
void	setFailbackDelaySeconds(long failbackDelaySeconds)	Sets the value of the failbackDelaySeconds attribute.
void	setFailOverLimit(int failOverLimit)	Sets the value of the FailOverLimit attribute.
void	setInitialBootDelaySeconds(long initialBootDelaySeconds)	Sets the value of the initialBootDelaySeconds attribute.
void	setMigrationPolicy(java.lang.String migrationPolicy)	Migration policy used for this JMS artifact (persistent store or messaging bridge).
void	setNumberOfRestartAttempts(int restartAttempts)	Sets the value of the NumberOfRestartAttempts attribute.
void	setPartialClusterStabilityDelaySeconds(long partialClusterStabilityDelaySeconds)	Sets the value of the steadyStateStime attribute.
void	setRebalanceEnabled(boolean rebalanceEnabled)	Sets the value of the Rebalance Enabled attribute.
void	setRestartInPlace(boolean restartInPlace)
void	setSecondsBetweenRestarts(int seconds)	Sets the value of the SecondsBetweenRestarts attribute.

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

Methods inherited from interface weblogic.management.configuration.DeploymentMBean

addTarget, getDeploymentOrder, getTargets, removeTarget, setDeploymentOrder, setTargets

Methods inherited from interface weblogic.descriptor.DescriptorBean

addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

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

getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

Method Detail

getDistributionPolicy

java.lang.String getDistributionPolicy()

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:

• Distributed Creates an instance on each server JVM in a cluster. Required for all SAF agents and for cluster-targeted or resource-group-scoped JMS servers that host distributed destinations.
• Singleton Creates a single instance on a single server JVM within 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.

Instance Naming Note:

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

Messaging Bridge Notes:

• When an instance per server is desired for a cluster-targeted messaging bridge, Oracle recommends setting the bridge Distributed Policy and Migration Policy to Distributed/Off, respectively; these are the defaults.
• When a single instance per cluster is desired for a cluster-targeted bridge, Oracle recommends setting the bridge Distributed Policy and Migration Policy to Singleton/On-Failure, respectively.
• If you cannot cluster-target a bridge and still need singleton behavior in a configured cluster, you can target the bridge to a migratable target and configure the Migration Policy on the migratable target to Exactly-Once.

Returns:

DistributionPolicy, the name of the distribution mode policy chosen for this dynamic deployment mbean (persistent store or messaging bridge)

See Also:

getMigrationPolicy(), setDistributionPolicy(java.lang.String)

Default Value:

JMSConstants.DISTRIBUTION_POLICY_DISTRIBUTED

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.

Valid Values:

JMSConstants.DISTRIBUTION_POLICY_DISTRIBUTED, JMSConstants.DISTRIBUTION_POLICY_SINGLETON

setDistributionPolicy

void setDistributionPolicy(java.lang.String distributionPolicy)

Parameters:

distributionPolicy - the name of the distribution mode policy chosen for this dynamic deployment mbean (persistent store or messaging bridge)

See Also:

getDistributionPolicy()

getMigrationPolicy

java.lang.String getMigrationPolicy()

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.

• Off Disables migration support for cluster-targeted JMS service objects, and changes the default for Restart In Place to false. If you want a restart to be enabled when the Migration Policy is Off, then Restart In Place must be explicitly configured to true. This policy cannot 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.

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

Messaging Bridge Notes:

• When an instance per server is desired for a cluster-targeted messaging bridge, Oracle recommends setting the bridge Distributed Policy and Migration Policy to Distributed/Off, respectively; these are the defaults.
• When a single instance per cluster is desired for a cluster-targeted bridge, Oracle recommends setting the bridge Distributed Policy and Migration Policy to Singleton/On-Failure, respectively.
• A Migration Policy of Always is not recommended for bridges.
• If you cannot cluster-target a bridge and still need singleton behavior in a configured cluster, you can target the bridge to a migratable target and configure the Migration Policy on the migratable target to Exactly-Once.

Returns:

migrationPolicy, the policy used for migration

See Also:

setMigrationPolicy(java.lang.String)

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.

setMigrationPolicy

void setMigrationPolicy(java.lang.String migrationPolicy)

Migration policy used for this JMS artifact (persistent store or messaging bridge).

Parameters:

migrationPolicy - , the dynamic server number,

See Also:

getMigrationPolicy()

Default Value:

JMSConstants.MIGRATION_POLICY_OFF

Valid Values:

JMSConstants.MIGRATION_POLICY_OFF, JMSConstants.MIGRATION_POLICY_ON_FAILURE, JMSConstants.MIGRATION_POLICY_ALWAYS

getRestartInPlace

boolean getRestartInPlace()

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.

• If the Migration Policy of the JMS artifact is set to Off, Restart In Place is disabled by default.
• If the Migration Policy of the JMS artifact is set to On-Failure or Always, Restart In Place is enabled by default.
• This attribute is not used by WebLogic messaging bridges which automatically restart internal connections as needed.
• For a JMS artifact that is cluster-targeted and the Migration Policy is set to On-Failure or Always, if restart fails after the configured maximum retry attempts, it will migrate to a different server within the cluster.

Returns:

restart-in-place, the value of the restart-in-place option for this dynamic deployment mbean (persistent or messaging bridge).

See Also:

setRestartInPlace(boolean)

setRestartInPlace

void setRestartInPlace(boolean restartInPlace)

Parameters:

restartInPlace - the value of restart-in-place chosen for this JMS artifact (persistent store)

See Also:

getRestartInPlace()

getSecondsBetweenRestarts

int getSecondsBetweenRestarts()

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

Default Value:

30

Minimum Value:

1

setSecondsBetweenRestarts

void setSecondsBetweenRestarts(int seconds)

Sets the value of the SecondsBetweenRestarts attribute.

Parameters:

seconds - to pause between restart attempts

See Also:

getSecondsBetweenRestarts()

getNumberOfRestartAttempts

int getNumberOfRestartAttempts()

Specifies the maximum number of restart attempts.

• A value > 0 specifies the maximum number of restart attempts.
• A value of 0 specifies the same behavior as setting getRestartInPlace() to false.
• A value of -1 means infinite retry restart until it either starts or the server instance shuts down.

Default Value:

6

Minimum Value:

-1

setNumberOfRestartAttempts

void setNumberOfRestartAttempts(int restartAttempts)

Sets the value of the NumberOfRestartAttempts attribute.

Parameters:

restartAttempts -

See Also:

getNumberOfRestartAttempts()

getInitialBootDelaySeconds

long getInitialBootDelaySeconds()

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.

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

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

See Also:

#PartialClusterStabilityDelaySeconds

Default Value:

60

setInitialBootDelaySeconds

void setInitialBootDelaySeconds(long initialBootDelaySeconds)

Sets the value of the initialBootDelaySeconds attribute.

Parameters:

initialBootDelaySeconds -

See Also:

getInitialBootDelaySeconds()

getPartialClusterStabilityDelaySeconds

long getPartialClusterStabilityDelaySeconds()

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.

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

See Also:

getInitialBootDelaySeconds()

Default Value:

240

setPartialClusterStabilityDelaySeconds

void setPartialClusterStabilityDelaySeconds(long partialClusterStabilityDelaySeconds)

Sets the value of the steadyStateStime attribute.

Parameters:

partialClusterStabilityDelaySeconds -

See Also:

getPartialClusterStabilityDelaySeconds()

getFailbackDelaySeconds

long getFailbackDelaySeconds()

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 indicates that the instance would never failback.
• A value of -1 indicates that there is no delay and the instance would failback immediately.

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

Default Value:

-1

setFailbackDelaySeconds

void setFailbackDelaySeconds(long failbackDelaySeconds)

Sets the value of the failbackDelaySeconds attribute.

Parameters:

failbackDelaySeconds -

See Also:

getFailbackDelaySeconds()

getFailOverLimit

int getFailOverLimit()

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.

• A value of -1 means there is no fail over limit (unlimited).
• A value of 0 prevents any fail overs of cluster-targeted JMS artifact instances, so no more than 1 instance will run per server (this is an instance that has not failed over).
• A value of 1 allows one fail-over instance on each server, so no more than two instances will run per server (one failed over instance plus an instance that has not failed over).

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

Default Value:

-1

Minimum Value:

-1

setFailOverLimit

void setFailOverLimit(int failOverLimit)

Sets the value of the FailOverLimit attribute.

Parameters:

the - limit on the number of cluster-targeted JMS artifacts.

See Also:

getFailOverLimit()

getRebalanceEnabled

boolean getRebalanceEnabled()

If set to true, then rebalance running cluster-targeted JMS instances when the system is idle and instances are unevenly distributed.

The system is considered idle when the Partial Cluster Stability Delay and Initial Boot Delay have passed, and no instances have moved plus no server status has changed within the last two system check periods (typically 10 seconds between each check). Two is the default, you can tune this higher using Rebalance Delay Periods on the Cluster bean.

The system is considered unbalanced if any running server has a JMS instance count that is more than one higher than the instance count on any other running server.

The rebalance heuristic forces all running instances that are not on their preferred server to move to their preferred server if the preferred server is running. It then finds the alphanumerically highest failed-over instance on the running server with the most instances, moves this instance to the alphanumerically least most running server with the fewest failed-over instances, and repeats this pattern until there are no running servers with an instance count that is more than one higher than the instance count on any other running server.

Note: This setting only applies when the JMS artifact is cluster-targeted, its Distribution Policy is set to Distributed, and its Migration Policy is set to On-Failure or Always.

See Also:

getPartialClusterStabilityDelaySeconds(), getInitialBootDelaySeconds(), ClusterMBean.getRebalanceDelayPeriods()

Default Value:

false

setRebalanceEnabled

void setRebalanceEnabled(boolean rebalanceEnabled)

Sets the value of the Rebalance Enabled attribute.

Parameters:

Set - to true to rebalance cluster-targeted JMS instances when the system is idle and instances are unevenly distributed.

See Also:

getRebalanceEnabled()