weblogic.management.configuration
Interface NodeManagerMBean

All Superinterfaces:

ConfigurationMBean

public interface NodeManagerMBean
extends ConfigurationMBean

This bean is represents a Node Manager 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."

ADAPTER_SEPARATOR

static final String ADAPTER_SEPARATOR

See Also:

Constant Field Values

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", "VMM", "vmm", "VMMS", "vmms"

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:

1

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

Changes take effect after you redeploy the module or restart the server.

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 node manager home to use when invoking SSH or RSH node manager functions. The value will be used to substitute the node manager home in the shellcommand template (parameter name %N)

Parameters:

nmhome - the node manager home directory for the machine

getNodeManagerHome

String getNodeManagerHome()

Returns the node manager home directory that will be used to substitute for the shell command template

Returns:

the node manager home directory for the machine

setAdapter

void setAdapter(String adapterName_Version)

Sets the node manager client adapter name_version when using a VMM adapter to connect to OVM or other VMM adapter providers

Parameters:

adapterName_Version - the name and version of the adapter to use with the syntax of ADAPTER_SEPARATOR

getAdapter

String getAdapter()

Gets the node manager client adapter name_version when using a VMM adapter to connect to OVM or other VMM adapter providers

Parameters:

adapterName_Version - the name and version of the adapter associated with a VMM node manager client having the syntax of ADAPTER_SEPARATOR

setAdapterName

void setAdapterName(String adapterName)

Deprecated. 10.3.4.0 Replaced by NodeManagerMBean.getAdapter()

Sets the node manager client adapter name when using a VMM adapter to connect to OVM or other VMM adapters providers

Parameters:

adapterName - the name of the adapter associated with a VMM node manager client

getAdapterName

String getAdapterName()

Gets the node manager client adapter name when using a VMM adapter to connect to OVM or other VMM adapters providers

Returns:

adapterName the name of the adapter associated with a VMM node manager client

setAdapterVersion

void setAdapterVersion(String adapterVersion)

Deprecated. 10.3.4.0 Replaced by weblogic.management.configuration.NodeManagerMBean#setAdapter()

Sets the node manager client adapter version when using a VMM adapter to connect to OVM or other VMM adapters providers

Parameters:

adapterVersion - the version of the adapter associated with a VMM node manager client

getAdapterVersion

String getAdapterVersion()

Gets the node manager client adapter version when using a VMM adapter to connect to OVM or other VMM adapters providers

Returns:

adapterVersion the version of the adapter associated with a VMM nodemanager client

setUserName

void setUserName(String s)

Sets the value of the UserName attribute.

Parameters:

s - The new userName value

See Also:

NodeManagerMBean.getUserName()

Changes take effect after you redeploy the module or restart the server.

getUserName

String getUserName()

The Node Manager client user name used to connect to the underlying service to which the client delegates operations.

Returns:

The userName value

setPassword

void setPassword(String s)

Sets the value of the Password attribute.

Parameters:

s - The new password value

See Also:

NodeManagerMBean.getPassword()

Changes take effect after you redeploy the module or restart the server.

getPassword

String getPassword()

The password used by a Node Manager client to connect to the underlying service to which the Node Manager client delegates operations.

When you get the value of this attribute, WebLogic Server does the following:

1. Retrieves the value of the PasswordEncrypted attribute.
2. Decrypts the value and returns the unencrypted password as a String.

When you set the value of this attribute, WebLogic Server does the following:

1. Encrypts the value.
2. Sets the value of the PasswordEncrypted attribute to the encrypted value.

Caution: Using the (Password) attribute is a potential security risk because the String object (which contains the unencrypted password), remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory. Therefore, you should use the PasswordEncrypted() attribute instead.

Returns:

The password value

See Also:

NodeManagerMBean.getPasswordEncrypted();

getPasswordEncrypted

byte[] getPasswordEncrypted()

The encrypted Node Manager client user password.

To set this attribute, use weblogic.management.EncryptionHelper.encrypt() to encrypt the value. Then set this attribute to the output of the encrypt() method.

To compare a password that a user enters with the encrypted value of this attribute, go to the same WebLogic Server instance that you used to set and encrypt this attribute and use weblogic.management.EncryptionHelper.encrypt() to encrypt the user-supplied password. Then compare the encrypted values.

Returns:

The password value as an encrypted byte array.

setPasswordEncrypted

void setPasswordEncrypted(byte[] bytes)

Encrypts the user password and sets the value of the PasswordEncrypted attribute.

Parameters:

bytes - The new password value, as a byte array

See Also:

NodeManagerMBean.getPasswordEncrypted()

Changes take effect after you redeploy the module or restart the server.

getInstalledVMMAdapters

String[] getInstalledVMMAdapters()

Gets a list of the names and versions of the installed Virtual Machine Manager (VMM) adapters

Returns:

The VMM adapter names as a String[].