Skip navigation links

weblogic.management.configuration
Interface DynamicServersMBean

All Superinterfaces:

ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

public interface DynamicServersMBean

extends ConfigurationMBean

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.

Since:

release specific (what release of product did this appear in)

DEFAULT_LISTEN_PORT_RANGE_BASE

static final int DEFAULT_LISTEN_PORT_RANGE_BASE

See Also:

Constant Field Values

DEFAULT_SSL_LISTEN_PORT_RANGE_BASE

static final int DEFAULT_SSL_LISTEN_PORT_RANGE_BASE

See Also:

Constant Field Values

DEFAULT_NAP_LISTEN_PORT_RANGE_BASE

static final int DEFAULT_NAP_LISTEN_PORT_RANGE_BASE

See Also:

Constant Field Values

DEFAULT_ADMINISTRATION_PORT_RANGE_BASE

static final int DEFAULT_ADMINISTRATION_PORT_RANGE_BASE

See Also:

Constant Field Values

getServerTemplate

ServerTemplateMBean getServerTemplate()

The server template used to create dynamic servers.

Returns:

ServerTemplateMBean used for the dynamic servers

setServerTemplate

void setServerTemplate(ServerTemplateMBean template)

Set the server template to use to create dynamic servers.

Parameters:

template - to use when creating a dynamic server

setMaximumDynamicServerCount

void setMaximumDynamicServerCount(int count)

Deprecated. Use setDynamicClusterSize(int size)

Set the maximum number of dynamic server instances allowed to be created.

Parameters:

count - the expected number of dynamic servers

getMaximumDynamicServerCount

int getMaximumDynamicServerCount()

Deprecated. Use getDynamicClusterSize()

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.

Returns:

maximum number of dynamic servers to be created

setCalculatedListenPorts

void setCalculatedListenPorts(boolean calculatePorts)

Set whether listen ports are calculated using the instance id. The listen ports are calculated as follows: If the listen port is explicitly set in the ServerTemplate, then the instance id is added to the listen port to calculate the listen port for each server. If the listen port is not explicitly set, then WebLogic Server will utilize the following base values when calculating the listen port. For the ListenPort in ServerMBean, WebLogic Server will add the instance id to 7100 to calculate the ListenPort for the server. For the ListenPort in the SSLMBean, WebLogic Server will add the instance id to 8100. For the ListenPort in the NetworkAccessPointMBean, WebLogic Server will add the instance id to 9100. For the administration port, WebLogic Server will add the instance id to 9002 if the administration port is enabled.

Parameters:

calculatePorts - true if listen ports should be calculated, false if not

isCalculatedListenPorts

boolean isCalculatedListenPorts()

Specifies whether listen ports are calculated.

Returns:

true if listen ports should be calculated, false if not

setCalculatedMachineNames

void setCalculatedMachineNames(boolean calculateMachineNames)

Set whether machine names are calculated. If set, then the servers are assigned machine names using the instance id and the number of machines selected from the domain. The first server is assigned to the first machine, the second server is assigned to the second machine, and so on until the last machine. Then the assignment process wraps back to the first machine. This continues until all servers have been assigned.

Parameters:

calculateMachineNames - true if machine names should be calculated, false if not

isCalculatedMachineNames

boolean isCalculatedMachineNames()

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.

Returns:

true if machine names should be calculated, false if not

setMachineNameMatchExpression

void setMachineNameMatchExpression(String machineNameMatchExpression)

Set the expression to use when determining machines to use for server assignments. If null, then all machines in the domain are used when performing assignments. If a machine in the domain matches the expression, then it will be included in the set of machines 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 then will match multiple machine names.

Parameters:

machineNameMatchExpression - to use when determining the machines to use when assigning servers to a machine.

getMachineNameMatchExpression

String getMachineNameMatchExpression()

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.

Returns:

the matching machine names expression

setMachineMatchExpression

void setMachineMatchExpression(String machineMatchExpression)

Set the expression to use when determining machines to use for server assignments. If null, then all machines in the domain are used when performing assignments. If a machine in the domain matches the expression, then it will be included in the set of machines used when assigning machine names to dynamic servers. The expression is a comma separated set of values that specify the machines to match. 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 the machines which have all the tag values.

Parameters:

machineMatchExpression - to use when determining the machines to use when assigning servers to a machine.

Since:

12.2.1

getMachineMatchExpression

String getMachineMatchExpression()

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.

Returns:

the matching machine tags expression

Since:

12.2.1

setMachineMatchType

void setMachineMatchType(String machineMatchType)

Set the type of expression to use when determining machines to use for server assignments. If a machine in the domain matches the expression, then it will be included in the set of machines used when assigning machine names to dynamic servers. The expression is a comma separated set of values that specify the machines to match. If the MachineMatchType is "name", each value will either match a machine name exactly or if specified with a trailing '*' suffix then will match multiple machine names. If the MachineMatchType is "tag", the values will match all the machines which have all the tag values.

Parameters:

machineMatchType - to use when determining the machines to use when assigning servers to a machine.

Since:

12.2.1

getMachineMatchType

String getMachineMatchType()

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.

Returns:

the matching machine tags expression

Since:

12.2.1

setServerNamePrefix

void setServerNamePrefix(String serverNamePrefix)

Set the prefix to use when creating the server name. If null, then defaults to clusterName-{id} where id is the server index starting with 1.

Parameters:

serverNamePrefix - to use when determining the machines to use when assigning servers to a machine.

getServerNamePrefix

String getServerNamePrefix()

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.

Returns:

the matching server name prefix

getDynamicClusterSize

int getDynamicClusterSize()

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.

Returns:

maximum number of dynamic servers to be created

setDynamicClusterSize

void setDynamicClusterSize(int size)

Set the current size of the dynamic cluster. This will typically be adjusted by the Elasticity Framework. However, it may be set directly if the Elasticity Framework is not enabled. When the Elasticity Framework is enabled, manually set values may be overridden by the Elasticity Framework at any time.

Parameters:

size - Size of the dynamic cluster

getMinDynamicClusterSize

int getMinDynamicClusterSize()

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

Returns:

Minimum number of servers maintained by Elasticity framework in the cluster

Since:

12.2.1

setMinDynamicClusterSize

void setMinDynamicClusterSize(int minSize)

Set the minimum number of running server instances that the Elasticity Framework will attempt to maintain.

Parameters:

minSize - Minimum number of running servers that the Elasticity framework will attempt to maintain

Since:

12.2.1

getMaxDynamicClusterSize

int getMaxDynamicClusterSize()

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

Returns:

Upper bound on DynamicClusterSize

Since:

12.2.1

setMaxDynamicClusterSize

void setMaxDynamicClusterSize(int maxSize)

Set the upper bound for the DynamicClusterSize attribute.

Parameters:

maxSize - Upper bound on DynamicClusterSize

Since:

12.2.1

getDynamicClusterCooloffPeriodSeconds

int getDynamicClusterCooloffPeriodSeconds()

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.

Returns:

Cool-off period in seconds for Elastic scaling operations

Since:

12.2.1

setDynamicClusterCooloffPeriodSeconds

void setDynamicClusterCooloffPeriodSeconds(int cooloffPeriod)

Set the cool-off period (in seconds) used by the Elasticity Framework while performing scale up or scale down operations.

Parameters:

cooloffPeriod - Cool-off period (in seconds) used by the Elasticity framework while performing scale-up or scale-down operations.

Since:

12.2.1

getDynamicClusterShutdownTimeoutSeconds

int getDynamicClusterShutdownTimeoutSeconds()

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.

Returns:

Timeout period in seconds

Since:

12.2.1

See Also:

ServerLifeCycleRuntimeMBean.shutdown(int, boolean, boolean)

isIgnoreSessionsDuringShutdown

boolean isIgnoreSessionsDuringShutdown()

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

Returns:

If true, inflight HTTP sessions will be ignored during server shutdown

Since:

12.2.1

See Also:

ServerLifeCycleRuntimeMBean.shutdown(int, boolean, boolean)

setIgnoreSessionsDuringShutdown

void setIgnoreSessionsDuringShutdown(boolean ignoreSessions)

Set to true if the Elasticity Framework should ignore inflight HTTP sessions during server shutdown.

Parameters:

ignoreSessions - If true, inflight HTTP sessions will be ignored during server shutdown

Since:

12.2.1

See Also:

ServerLifeCycleRuntimeMBean.shutdown(int, boolean, boolean)

isWaitForAllSessionsDuringShutdown

boolean isWaitForAllSessionsDuringShutdown()

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

Returns:

If true, wait for all HTTP sessions; else wait for non-persisted HTTP sessions only

Since:

12.2.1

See Also:

ServerLifeCycleRuntimeMBean.shutdown(int, boolean, boolean)

setWaitForAllSessionsDuringShutdown

void setWaitForAllSessionsDuringShutdown(boolean waitForAllSessions)

Set to true if the Elasticity Framework should wait for all (persisted and non-persisted) HTTP sessions during inflight work handling; set to false to wait for non-persisted HTTP sessions only.

Parameters:

waitForAllSessions - Set to true to wait for all HTTP sessions during inflight work handling; false to wait for non-persisted HTTP sessions only.

Since:

12.2.1

See Also:

ServerLifeCycleRuntimeMBean.shutdown(int, boolean, boolean)

Skip navigation links