DynamicServersMBean

Overview

Contains the properties used to control how dynamic servers are created. These properties allow you to control if listens ports are calculated, how servers are assigned to machines, and the number of dynamic servers to create.

Related MBeans

This section describes attributes that provide access to other MBeans.

ServerTemplate

The server template used to create dynamic servers.

Attributes

This section describes the following attributes:

CachingDisabled

Private property that disables caching in proxies.

CalculatedListenPorts

Specifies whether listen ports are calculated.

CalculatedMachineNames

The CalculatedMachineNames attribute controls how server instances in a dynamic cluster are assigned to a machine. If the attribute is not set, then the dynamic servers will not be assigned to a machine. If the attribute is set, then the MachineNameMatchExpression attribute is used to select the set of machines to use for the dynamic servers.

DynamicallyCreated

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

DynamicClusterCooloffPeriodSeconds

Get the cool-off period (in seconds) used by the Elasticity Framework while performing scale up or scale down operations. If a scale up or scale down operation was performed, subsequent requests for scale up or down operations will be ignored by the Elasticity Framework during this period.

DynamicClusterShutdownTimeoutSeconds

Get the timeout period (in seconds) used by the Elasticity Framework while gracefully shutting down a server. If the server does not shut down before the specified timeout period, the server will be forcibly shut down. With a negative time value, no timeout will be applied.

For more information, see:

• ServerLifeCycleRuntimeMBean#shutdown(int, boolean, boolean)

DynamicClusterSize

Get the current size of the dynamic cluster (the number of dynamic server instances allowed to be created). The specified number of server instances are dynamically added to the configuration at runtime and associated ServerLifeCycleRuntimeMBeans are created.

DynamicServerNames

Return an array of all the dynamic server names

Id

Return the unique id of this MBean instance

IgnoreSessionsDuringShutdown

Indicates if the Elasticity Framework should ignore inflight HTTP sessions while shutting down servers.

For more information, see:

• ServerLifeCycleRuntimeMBean#shutdown(int, boolean, boolean)

MachineMatchExpression

Get the machine tag expression to use when selecting machine names. If the MachineMatchType is "name", each value will either match a machine name exactly or, if specified with a trailing '*' suffix, will match multiple machine names. If the MachineMatchType is "tag", the values will match all of the machines that have all of the tag values.

MachineMatchType

Get the machine tag expression to use when selecting machine names. If the MachineMatchType is "name", each value will either match a machine name exactly or, if specified with a trailing '*' suffix, will match multiple machine names. If the MachineMatchType is "tag", the values will match all of the machines that have all of the tag values.

MachineNameMatchExpression

The expression is used when determining machines to use for server assignments. If null, then all machines in the domain are used. If a expression is provided, then only the machines in the domain that match the expression will be used when assigning machine names to dynamic servers. The expression is a comma separated set of values that specify the machines to match. Each value will either match a machine name exactly or if specified with a trailing '*' suffix, the value will match multiple machine names.

MaxDynamicClusterSize

Get the upper bound on the DynamicClusterSize that the Elasticity Framework is allowed to assign to DynamicClusterSize.

MaximumDynamicServerCount

The maximum number of server instances allowed to be created. This value should be set to the number of servers expected to be in the cluster. The specified number of servers are dynamically added to the configuration at runtime and associated ServerLifeCycleRuntimeMBeans are created.

Deprecated. 12.2.1.0.0 Use getDynamicClusterSize()

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

MinDynamicClusterSize

Get the minimum number of running server instances that the Elasticity Framework will attempt to keep in the dynamic cluster.

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.

ObjectName

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

Deprecated.

Parent

Return the immediate parent for this MBean

Registered

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

Deprecated.

ServerNamePrefix

The server name prefix is used to specify the naming convention when creating server names. When the server name prefix is defined, server names are calculated with the specified prefix followed by the index starting with 1.

Tags

Return all tags on this Configuration MBean

Type

Returns the type of the MBean.

WaitForAllSessionsDuringShutdown

Indicates if the Elasticity Framework should wait for all (persisted and non-persisted) HTTP sessions during inflight work handling while shutting down servers.

For more information, see:

• ServerLifeCycleRuntimeMBean#shutdown(int, boolean, boolean)

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.

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

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.