Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-01

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.


Field Summary
static int DEFAULT_LISTEN_PORT_RANGE_BASE
           
static int DEFAULT_NAP_LISTEN_PORT_RANGE_BASE
           
static int DEFAULT_SSL_LISTEN_PORT_RANGE_BASE
           
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 String getMachineNameMatchExpression()
          Get the machine name expression to use when selecting machine names.
 int getMaximumDynamicServerCount()
          Get the maximum number of server instances allowed to be created.
 String getServerNamePrefix()
          Get the server name prefix to use when creating server names.
 ServerTemplateMBean getServerTemplate()
          Get the server template used to create dynamic servers.
 boolean isCalculatedListenPorts()
          Specifies whether listen ports are calculated.
 boolean isCalculatedMachineNames()
          Specifies whether machine names are calculated.
 void setCalculatedListenPorts(boolean calculatePorts)
          Set whether listen ports are calculated using the instance id.
 void setCalculatedMachineNames(boolean calculateMachineNames)
          Set whether machine names are calculated.
 void setMachineNameMatchExpression(String machineNameMatchExpression)
          Set the expression to use when determining machines to use for server assignments.
 void setMaximumDynamicServerCount(int count)
          Set the maximum number of dynamic server instances allowed to be created
 void setServerNamePrefix(String serverNamePrefix)
          Set the prefix to use when creating the server name.
 void setServerTemplate(ServerTemplateMBean template)
          Set the server template to use to create dynamic servers.
 
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.WebLogicMBean
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
 
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.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
 

Field Detail

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
Method Detail

getServerTemplate

ServerTemplateMBean getServerTemplate()
Get 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)
Set the maximum number of dynamic server instances allowed to be created

Parameters:
count - the expected number of dynamic servers

getMaximumDynamicServerCount

int getMaximumDynamicServerCount()
Get 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
Maximum Value:
800
Minimum Value:
0

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.

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
Default Value:
true

setCalculatedMachineNames

void setCalculatedMachineNames(boolean calculateMachineNames)
Set whether machine names are calculated. If set, then the servers are asigned 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()
Specifies whether machine names are calculated.

Returns:
true if machine names should be calculated, false if not
Default Value:
false

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()
Get the machine name expression to use when selecting machine names.

Returns:
the matching machine names expression

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()
Get the server name prefix to use when creating server names.

Returns:
the matching server name prefix

Copyright 1996, 2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-01