ServerStartMBean

Overview

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

Attributes

This section describes the following attributes:

Arguments

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.

BeaHome

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.

Deprecated. 12.1.3.0 replaced by ServerStartMBean.getMWHome

CachingDisabled

Private property that disables caching in proxies.

ClassPath

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.

DynamicallyCreated

Return whether the MBean was created dynamically or is persisted to config.xml

Id

Return the unique id of this MBean instance

JavaHome

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.

JavaVendor

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.

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

MWHome

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.

Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:

Name=user-specified-name

Notes

Optional information that you can include to describe this configuration.

WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.

Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

ObjectName

Returns the ObjectName under which this MBean is registered in the MBean server.

Deprecated.

Parent

Return the immediate parent for this MBean

Password

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.

For more information, see:

• getPasswordEncrypted()

PasswordEncrypted

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.

Registered

Returns false if the MBean represented by this object has been unregistered.

Deprecated.

RootDirectory

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.

SecurityPolicyFile

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=

Tags

Return all tags on this Configuration MBean

Type

Returns the type of the MBean.

Username

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.

Operations

This section describes the following operations:

addTag

Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.

freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note: To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

getInheritedProperties

Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

isInherited

Check if the value of a property is inherited from template mbean or not.

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

removeTag

Remove a tag from this Configuration MBean

restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

unSet

Restore the given property to its default value.