Oracle Fusion Middleware
Oracle WebLogic Server 10.3.1 MBean API Reference
11g Release 1 (10.3.1)

Part Number E13945-02

weblogic.management.configuration
Interface NodeManagerMBean

All Superinterfaces:
ConfigurationMBean

public interface NodeManagerMBean
extends ConfigurationMBean

This bean is represents a NodeManager that is associated with a machine.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX."


Field Summary
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 String getListenAddress()
          The host name or IP address where Node Manager listens for connection requests.
 int getListenPort()
          The port number where Node Manager listens for connection requests.
 String getNMType()
          Returns the node manager type.
 String getNodeManagerHome()
          Returns the nodemanager home directory that will be used to substitute for the shell command template
 String getShellCommand()
          Returns the local command line to use when invoking SSH or RSH node manager functions.
 boolean isDebugEnabled()
          Specifies whether communication with this Node Manager needs to be debugged.
 void setDebugEnabled(boolean enable)
          Set the value of the DebugEnabled attribute.
 void setListenAddress(String address)
          Sets the value of the ListenAddress attribute.
 void setListenPort(int port)
          Sets the value of the ListenPort attribute.
 void setNMType(String type)
          Sets the node manager type.
 void setNodeManagerHome(String nmhome)
          Sets the nodemanager home to use when invoking SSH or RSH node manager functions.
 void setShellCommand(String cmd)
          Sets the command line to use when invoking SSH or RSH node manager functions.
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getName, getNotes, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet
 

Method Detail

setNMType

void setNMType(String type)
               throws InvalidAttributeValueException
Sets the node manager type.

Parameters:
type - the node manager type
Throws:
InvalidAttributeValueException
Default Value:
"SSL"
Valid Values:
"SSH", "RSH", "Plain", "SSL", "ssh", "rsh", "ssl", "plain"

getNMType

String getNMType()
Returns the node manager type.

Returns:
the node manager type

getListenAddress

String getListenAddress()

The host name or IP address where Node Manager listens for connection requests.

Returns:
The listenAddress value
Default Value:
"localhost"

setListenAddress

void setListenAddress(String address)
                      throws InvalidAttributeValueException

Sets the value of the ListenAddress attribute.

Parameters:
address - The new listenAddress value
Throws:
InvalidAttributeValueException
See Also:
NodeManagerMBean.getListenAddress()

getListenPort

int getListenPort()

The port number where Node Manager listens for connection requests.

Returns:
The listenPort value
Default Value:
5556

setListenPort

void setListenPort(int port)

Sets the value of the ListenPort attribute.

Parameters:
port - The new listenPort value
See Also:
NodeManagerMBean.getListenPort()
Maximum Value:
65534
Minimum Value:
0

isDebugEnabled

boolean isDebugEnabled()

Specifies whether communication with this Node Manager needs to be debugged. When enabled, Node Manager provides more information about request processing. This information is sent to the log of the server making requests to Node Manager.

Returns:
The debugEnabled value
Default Value:
false

setDebugEnabled

void setDebugEnabled(boolean enable)

Set the value of the DebugEnabled attribute.

Parameters:
enable - The new debugEnabled value
See Also:
NodeManagerMBean.isDebugEnabled()

setShellCommand

void setShellCommand(String cmd)
Sets the command line to use when invoking SSH or RSH node manager functions. This command will be executed on the local (client) side and should invoke the ssh or rsh command with appropriate options as well as the wlscontrol.sh as the argument.

Parameters:
cmd - the local command line

getShellCommand

String getShellCommand()
Returns the local command line to use when invoking SSH or RSH node manager functions.

Returns:
the local command line

setNodeManagerHome

void setNodeManagerHome(String nmhome)
Sets the nodemanager home to use when invoking SSH or RSH node manager functions. The value will be used to substitute the nodemanager home in the shellcommand template (parameter name %N)

Parameters:
nmhome - the nodemanager homedirectory for the machine

getNodeManagerHome

String getNodeManagerHome()
Returns the nodemanager home directory that will be used to substitute for the shell command template

Returns:
the nodemanager homedirectory for the machine

Documentation is available at
http://download.oracle.com/docs/cd/E12839_01/web.1111/wls.htm
Copyright 1996, 2009, 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
Oracle WebLogic Server 10.3.1 MBean API Reference
11g Release 1 (10.3.1)

Part Number E13945-02