weblogic.management.configuration
Interface ServerStartMBean

All Superinterfaces:

ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

public interface ServerStartMBean
extends ConfigurationMBean

This bean is used to configure the attributes necessary to start up a server on a remote machine.

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

getJavaVendor

String getJavaVendor()

The Java Vendor value to use when starting this server.

If the server is part of a cluster and configured for automatic migration across possibly different platforms with different vendors providing the JDKs, then, both JavaVendor and JavaHome should be set in the generated configuration file instead.

This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.JavaVendor property.

Node Manager does not pass this value invoking a Java command line to start the server. It does pass this value in the environment variable JAVA_VENDOR to the start script.

Returns:

The javaVendor value

setJavaVendor

void setJavaVendor(String vendor)
                   throws InvalidAttributeValueException

Sets the value of the JavaVendor attribute.

Parameters:

vendor - The new javaVendor value

Throws:

InvalidAttributeValueException

See Also:

ServerStartMBean.getJavaVendor()

getJavaHome

String getJavaHome()

The Java home directory (path on the machine running Node Manager) to use when starting this server.

Specify the parent directory of the JDK's bin directory. For example, c:\bea\jdk141.

This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.JavaHome or property.

Node Manager will pass this value to a start script using the JAVA_HOME environment variable. When issuing a Java command line to start the server, Node Manager will use the Java executable from the specified location.

Returns:

The javaHome value

setJavaHome

void setJavaHome(String path)
                 throws InvalidAttributeValueException

Sets the value of the JavaHome attribute.

Parameters:

path - The new javaHome value

Throws:

InvalidAttributeValueException

See Also:

ServerStartMBean.getJavaHome()

getClassPath

String getClassPath()

The classpath (path on the machine running Node Manager) to use when starting this server.

At a minimum you will need to specify the following values for the class path option: WL_HOME/server/lib/weblogic_sp.jar;WL_HOME/server/lib/weblogic.jar

where WL_HOME is the directory in which you installed WebLogic Server on the Node Manager machine.

The shell environment determines which character you use to separate path elements. On Windows, you typically use a semicolon (;). In a BASH shell, you typically use a colon (:).

This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.ClassPath property.

Node Manager will pass this value to a start script using the CLASSPATH environment variable. When issuing a Java command line to start the server, Node Manager will pass -Djava.class.path.

Returns:

The classPath value

setClassPath

void setClassPath(String classpath)
                  throws InvalidAttributeValueException

Sets the value of the ClassPath attribute.

Parameters:

classpath - The new classPath value

Throws:

InvalidAttributeValueException

See Also:

ServerStartMBean.getClassPath()

getBeaHome

String getBeaHome()

Deprecated. 12.1.3.0 replaced by ServerStartMBean.getMWHome

The BEA home directory (path on the machine running Node Manager) to use when starting this server.

Specify the directory on the Node Manager machine under which all of Oracle's BEA products were installed. For example, c:\bea.

Returns:

The beaHome value

setBeaHome

void setBeaHome(String path)
                throws InvalidAttributeValueException

Deprecated. 12.1.3.0 replaced by ServerStartMBean.setMWHome

Sets the value of the BeaHome attribute.

Parameters:

path - The new beaHome value

Throws:

InvalidAttributeValueException

See Also:

ServerStartMBean.getBeaHome()

getMWHome

String getMWHome()

The MWHome directory (path on the machine running Node Manager) to use when starting this server.

Specify the directory on the Node Manager machine under which all of Oracle's Middleware products were installed. For example, c:\bea.

This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.MWHome property.

Node Manager does not pass this value to start scripts. It does specify -Dbea.home when invoking a Java command line to start the server.

Returns:

The MWHome value

setMWHome

void setMWHome(String path)
               throws InvalidAttributeValueException

Sets the value of the MWHome attribute.

Parameters:

path - The new MWHome value

Throws:

InvalidAttributeValueException

See Also:

ServerStartMBean.getMWHome()

getRootDirectory

String getRootDirectory()

The directory that this server uses as its root directory. This directory must be on the computer that hosts Node Manager. If you do not specify a Root Directory value, the domain directory is used by default.

Returns:

The rootDirectory value

setRootDirectory

void setRootDirectory(String path)
                      throws InvalidAttributeValueException

Sets the value of the RootDirectory attribute.

Parameters:

path - The new rootDirectory value

Throws:

InvalidAttributeValueException

See Also:

ServerStartMBean.getRootDirectory()

getSecurityPolicyFile

String getSecurityPolicyFile()

The security policy file (directory and filename on the machine running Node Manager) to use when starting this server.

*

This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.SecurityPolicyFile property .

When Node Manager is using a start script, the security policy file will be defined in an environment variable, SECURITY_POLICY. Additionally, when Node Manager is launching the process directly using a Java command, the security policy file will be defined with -Djava.security.policy=

Returns:

The securityPolicyFile value

setSecurityPolicyFile

void setSecurityPolicyFile(String filePath)
                           throws InvalidAttributeValueException

Sets the value of the SecurityPolicy attribute.

Parameters:

filePath - The new securityPolicyFile value

Throws:

InvalidAttributeValueException

See Also:

ServerStartMBean.getSecurityPolicyFile()

getArguments

String getArguments()

The arguments to use when starting this server.

These are the first arguments appended immediately after java portion of the startup command. For example, you can set Java heap memory or specify any weblogic.Server option.

This property should not be used to specify weblogic.management.username or weblogic.management.password as these values will be ignored during server startup. Instead the username and password properties should be set. This will also enable Node Manager to properly encrypt these values on the Managed Server's machine.

Separate arguments with a space.

This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.Arguments property.

Node Manager will pass this value to a start script using the JAVA_OPTIONS environment variable. When issuing a Java command line to start the server, Node Manager will pass the arguments as options.

Returns:

The arguments value

setArguments

void setArguments(String classpath)
                  throws InvalidAttributeValueException

Set the value of the Arguments attribute.

This property should not be used to specify weblogic.management.username or weblogic.management.password as these values will be ignored during server startup. Instead the username and password properties should be set. This will also enable Node Manager to properly encrypt these values on the Managed Server's machine.

Parameters:

classpath - The new arguments value

Throws:

InvalidAttributeValueException

See Also:

ServerStartMBean.getArguments()

setOutputFile

void setOutputFile(String fileName)

Sets the value of the OutputFile attribute.

Parameters:

fileName - The new outputFile value

See Also:

ServerStartMBean.getOutputFile()

getUsername

String getUsername()

The user name to use when booting this server.

The Administration Console inserts the user name that you supplied when you logged in to the console. The Domain Configuration Wizard inserts the user name that you defined when you created the domain.

Returns:

The username value

Default Value:

""

setUsername

void setUsername(String username)
                 throws InvalidAttributeValueException

Sets the value of the Username attribute.

Parameters:

username - The new username value

Throws:

InvalidAttributeValueException

See Also:

ServerStartMBean.getUsername()

getPassword

String getPassword()

The password of the username used to boot the server and perform server health monitoring.

As of 8.1 sp4, 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.

Using this attribute (Password) 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.

Instead of using this attribute, use PasswordEncrypted.

Returns:

The password value

See Also:

ServerStartMBean.getPasswordEncrypted()

setPassword

void setPassword(String password)
                 throws InvalidAttributeValueException

Sets the value of the Password attribute.

Parameters:

password - The new password value

Throws:

InvalidAttributeValueException

See Also:

ServerStartMBean.getPassword()

getPasswordEncrypted

byte[] getPasswordEncrypted()

The encrypted password of the username used to boot the server and perform server health monitoring.

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 PasswordEncrypted value as an encrypted byte array

setPasswordEncrypted

void setPasswordEncrypted(byte[] bytes)
                          throws InvalidAttributeValueException

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

Parameters:

bytes - The new password value as a byte array

Throws:

InvalidAttributeValueException

See Also:

ServerStartMBean.getPasswordEncrypted()