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

Part Number E41849-02

weblogic.management.configuration
Interface NodeManagerMBean

All Superinterfaces:
ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

public interface NodeManagerMBean
extends ConfigurationMBean

This bean is represents a Node Manager that is associated with a machine.


Field Summary
static String ADAPTER_SEPARATOR
          Deprecated. VMM client support is removed since 12.1.2
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 String getAdapter()
          Gets the node manager client adapter name_version when using a VMM adapter to connect to OVM or other VMM adapter providers
 String getAdapterName()
          Gets the node manager client adapter name when using a VMM adapter to connect to OVM or other VMM adapters providers
 String getAdapterVersion()
          Gets the node manager client adapter version when using a VMM adapter to connect to OVM or other VMM adapters providers
 String[] getInstalledVMMAdapters()
          Deprecated. VMM client support is removed since 12.1.2
 String getListenAddress()
          The host name or IP address of the NodeManager for the server or clients on the server to use when connecting to the NodeManager instance.
 int getListenPort()
          The port number of the NodeManager for the server or clients on the server to use when connecting to the NodeManager instance.
 String getNMType()
          Returns the node manager type for the server or clients on the server to use when connecting to the NodeManager instance.
 String getNodeManagerHome()
          Returns the node manager home directory that will be used to substitute for the shell command template
 String getPassword()
          The password used by a Node Manager client to connect to the underlying service to which the Node Manager client delegates operations.
 byte[] getPasswordEncrypted()
          The encrypted Node Manager client user password.
 String getShellCommand()
          Returns the local command line to use when invoking SSH or RSH node manager functions.
 String getUserName()
          The Node Manager client user name used to connect to the underlying service to which the client delegates operations.
 boolean isDebugEnabled()
          Specifies whether communication with this Node Manager needs to be debugged.
 void setAdapter(String adapterName_Version)
          Deprecated. VMM client support is removed since 12.1.2
 void setAdapterName(String adapterName)
          Deprecated. 10.3.4.0 Replaced by NodeManagerMBean.getAdapter()
 void setAdapterVersion(String adapterVersion)
          Deprecated. 10.3.4.0 Replaced by setAdapter
 void setDebugEnabled(boolean enable)
          Set the value of the DebugEnabled attribute.
 void setListenAddress(String address)
          Sets the value of the ListenAddress attribute of the NodeManager for the server or clients on the server to use when connecting to the NodeManager instance.
 void setListenPort(int port)
          Sets the value of the ListenPort of the NodeManager for the server or clients on the server to use when connecting to the NodeManager instance.
 void setNMType(String type)
          Sets the node manager type for the server or clients on the server to use when connecting to the NodeManager instance.
 void setNodeManagerHome(String nmhome)
          Sets the node manager home to use when invoking SSH or RSH node manager functions.
 void setPassword(String s)
          Deprecated. VMM client support is removed since 12.1.2
 void setPasswordEncrypted(byte[] bytes)
          Deprecated. VMM client support is removed since 12.1.2
 void setShellCommand(String cmd)
          Sets the command line to use when invoking SSH or RSH node manager functions.
 void setUserName(String s)
          Deprecated. VMM client support is removed since 12.1.2
 
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

ADAPTER_SEPARATOR

static final String ADAPTER_SEPARATOR
Deprecated. VMM client support is removed since 12.1.2
See Also:
Constant Field Values
Method Detail

setNMType

void setNMType(String type)
               throws InvalidAttributeValueException
Sets the node manager type for the server or clients on the server to use when connecting to the NodeManager instance.

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 for the server or clients on the server to use when connecting to the NodeManager instance.

Returns:
the node manager type

getListenAddress

String getListenAddress()

The host name or IP address of the NodeManager for the server or clients on the server to use when connecting to the NodeManager instance.

Returns:
The listenAddress value
Default Value:
"localhost"

setListenAddress

void setListenAddress(String address)
                      throws InvalidAttributeValueException

Sets the value of the ListenAddress attribute of the NodeManager for the server or clients on the server to use when connecting to the NodeManager instance.

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

getListenPort

int getListenPort()

The port number of the NodeManager for the server or clients on the server to use when connecting to the NodeManager instance.

Returns:
The listenPort value
Default Value:
5556

setListenPort

void setListenPort(int port)

Sets the value of the ListenPort of the NodeManager for the server or clients on the server to use when connecting to the NodeManager instance.

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, connections to the NodeManager from the server or clients on the server will result in more information sent to the server log.

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)
Deprecated. VMM client support is removed since 12.1.2

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

Returns:
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 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)
Deprecated. VMM client support is removed since 12.1.2

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)
Deprecated. VMM client support is removed since 12.1.2

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)
Deprecated. VMM client support is removed since 12.1.2

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()
Deprecated. VMM client support is removed since 12.1.2

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

Returns:
The VMM adapter names as a String[].

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