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

Part Number E41849-02

weblogic.management.configuration
Interface ManagedExternalServerMBean

All Superinterfaces:
ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean
All Known Subinterfaces:
CoherenceServerMBean, SystemComponentMBean

public interface ManagedExternalServerMBean
extends ConfigurationMBean

Used to configure an external server that can be managed by Node Manager.


Field Summary
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 boolean getAutoRestart()
           Specifies whether the Node Manager can automatically restart this server if it crashes or otherwise goes down unexpectedly.
 MachineMBean getMachine()
           The WebLogic Server host computer (machine) on which this server is meant to run.
 String getName()
          An alphanumeric name for this server instance.
 int getNMSocketCreateTimeoutInMillis()
          Returns the timeout value to be used by NodeManagerRuntime when creating a socket connection to the agent.
 int getRestartDelaySeconds()
           The number of seconds the Node Manager should wait before restarting this server.
 int getRestartIntervalSeconds()
           The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax.
 int getRestartMax()
           The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds.
 void setAutoRestart(boolean enable)
           Sets the value of the AutoRestart attribute.
 void setMachine(MachineMBean machine)
           Sets the value of the Machine attribute.
 void setName(String name)
          Set the value of the Name attribute.
 void setNMSocketCreateTimeoutInMillis(int timeout)
           
 void setRestartDelaySeconds(int secs)
           Sets the value of the RestartDelaySeconds attribute.
 void setRestartIntervalSeconds(int secs)
           Sets the value of the RestartIntervalSeconds attribute.
 void setRestartMax(int value)
           Sets the value of the RestartMax attribute.
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, 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
 

Method Detail

setName

void setName(String name)
             throws InvalidAttributeValueException,
                    ManagementException

Set the value of the Name attribute.

Specified by:
setName in interface ConfigurationMBean
Parameters:
name - The new name value
Throws:
InvalidAttributeValueException
ManagementException
See Also:
ManagedExternalServerMBean.getName()

getName

String getName()

An alphanumeric name for this server instance. (Spaces are not valid.)

The name must be unique for all configuration objects in the domain. Within a domain, each server, machine, cluster, JDBC connection pool, virtual host, and any other resource type must be named uniquely and must not use the same name as the domain.

The server name is not used as part of the URL for applications that are deployed on the server. It is for your identification purposes only. The server name displays in the Administration Console, and if you use WebLogic Server command-line utilities or APIs, you use this name to identify the server.

After you have created a server, you cannot change its name. Instead, clone the server and provide a new name for the clone.

Specified by:
getName in interface ConfigurationMBean
Specified by:
getName in interface WebLogicMBean
Returns:
The name value

getMachine

MachineMBean getMachine()

The WebLogic Server host computer (machine) on which this server is meant to run.

If you want to use a Node Manager to start this server, you must assign the server to a machine and you must configure the machine for the Node Manager.

You cannot change this value if a server instance is already running.

Returns:
The machine value

setMachine

void setMachine(MachineMBean machine)
                throws InvalidAttributeValueException

Sets the value of the Machine attribute.

Parameters:
machine - The new machine value
Throws:
InvalidAttributeValueException
See Also:
ManagedExternalServerMBean.getMachine()

getAutoRestart

boolean getAutoRestart()

Specifies whether the Node Manager can automatically restart this server if it crashes or otherwise goes down unexpectedly.

Returns:
The autoRestart value
Default Value:
true

setAutoRestart

void setAutoRestart(boolean enable)

Sets the value of the AutoRestart attribute.

Parameters:
enable - The new autoRestart value
See Also:
ManagedExternalServerMBean.getAutoRestart()

getRestartIntervalSeconds

int getRestartIntervalSeconds()

The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax.

Returns:
The restartIntervalSeconds value
See Also:
ManagedExternalServerMBean.getRestartMax()
Default Value:
3600
Maximum Value:
2147483647
Minimum Value:
300

setRestartIntervalSeconds

void setRestartIntervalSeconds(int secs)
                               throws InvalidAttributeValueException

Sets the value of the RestartIntervalSeconds attribute.

Parameters:
secs - The new restartIntervalSeconds value
Throws:
InvalidAttributeValueException
See Also:
ManagedExternalServerMBean.getRestartIntervalSeconds()

getRestartMax

int getRestartMax()

The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds.

Returns:
The restartMax value
Default Value:
2
Maximum Value:
2147483647
Minimum Value:
0

setRestartMax

void setRestartMax(int value)
                   throws InvalidAttributeValueException

Sets the value of the RestartMax attribute.

Parameters:
value - The new restartMax value
Throws:
InvalidAttributeValueException
See Also:
ManagedExternalServerMBean.getRestartMax()

getRestartDelaySeconds

int getRestartDelaySeconds()

The number of seconds the Node Manager should wait before restarting this server.

After killing a server process, the system might need several seconds to release the TCP port(s) the server was using. If Node Manager attempts to restart the Managed Server while its ports are still active, the startup attempt fails.

If AutoMigration is enabled and RestartDelaySeconds is 0, the RestartDelaySeconds is automatically set to the lease time. This prevents the server from failing to restart after migration when the previous lease is still valid.

Returns:
The restartDelaySeconds value
Default Value:
0
Maximum Value:
2147483647
Minimum Value:
0

setRestartDelaySeconds

void setRestartDelaySeconds(int secs)
                            throws InvalidAttributeValueException

Sets the value of the RestartDelaySeconds attribute.

Parameters:
secs - The new restartDelaySeconds value
Throws:
InvalidAttributeValueException
See Also:
ManagedExternalServerMBean.getRestartDelaySeconds()

getNMSocketCreateTimeoutInMillis

int getNMSocketCreateTimeoutInMillis()
Returns the timeout value to be used by NodeManagerRuntime when creating a socket connection to the agent. Default set high as SSH agent may require a high connection establishment time.

Default Value:
180000
Minimum Value:
0

setNMSocketCreateTimeoutInMillis

void setNMSocketCreateTimeoutInMillis(int timeout)
                                      throws InvalidAttributeValueException,
                                             DistributedManagementException
Throws:
InvalidAttributeValueException
DistributedManagementException

Copyright 1996, 2014, 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.3)

Part Number E41849-02