ServerStartMBean


Overview  |   Child MBeans  |   Attributes  |   Operations

Overview

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

Fully Qualified Interface Name

If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.ServerStartMBean

Factory Methods

No factory methods. Instances of this MBean are created automatically.

Access Points

You can access this MBean from the following MBean attributes:


    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.

    Separate arguments with a space.

           
    Privileges Read/Write
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    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 BEA products and licenses were installed. For example, c:\bea.

           
    Privileges Read/Write
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    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 (:).

           
    Privileges Read/Write
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    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.

           
    Privileges Read/Write
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart 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

           
    Privileges Read/Write
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Notes

    Optional information that you can include to describe this configuration.

    WebLogic Sever saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. 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.

           
    Privileges Read/Write
    Typejava.lang.String

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    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. 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:

           
    Privileges Read/Write
    Typejava.lang.String
    Default Value
    Encryptedtrue
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    PasswordEncrypted

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

    To set this attribute, pass an unencrypted string to the MBean server's setAttribute method. WebLogic Server encrypts the value and sets the attribute to the encrypted value.

    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.

    For more information, see:

           
    Privileges Read/Write
    Typebyte[]
    Default Value
    Encryptedtrue
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    RootDirectory

    The directory that this server uses as its root directory. This directory must be on the computer that hosts the Node Manager. If you do not specify a Root Directory value, the default Node Manager working directory is used (generally WL_HOME\common\nodemanager).

           
    Privileges Read/Write
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    SecurityPolicyFile

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

           
    Privileges Read/Write
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Type

    Returns the type of the MBean.

           
    Privileges Read only
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    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.

           
    Privileges Read/Write
    Typejava.lang.String
    Default Value
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


    Operations

    This section describes the following operations:


    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

       
    Operation Name"freezeCurrentValue"
    ParametersObject [] {  attributeName }

    where:

    • attributeName is an object of type java.lang.String that specifies:

      attributeName

    SignatureString [] { "java.lang.String" }
    Returns void

    Exceptions

    isSet

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

       
    Operation Name"isSet"
    ParametersObject [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      property to check

    SignatureString [] { "java.lang.String" }
    Returns boolean

    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

       
    Operation Name"restoreDefaultValue"
    ParametersObject [] {  attributeName }

    where:

    • attributeName is an object of type java.lang.String that specifies:

      attributeName

    SignatureString [] { "java.lang.String" }
    Returns void

    Exceptions

    unSet

    Restore the given property to its default value.

       
    Operation Name"unSet"
    ParametersObject [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      property to restore

    SignatureString [] { "java.lang.String" }
    Returns void