ServerStartMBean


Overview  |   Related 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 NameIf 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.

    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.

           
    Privileges Read/Write
    Typejava.lang.String

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

           
    Privileges Read/Write
    Typejava.lang.String

    CachingDisabled

    Private property that disables caching in proxies.

           
    Privileges Read only
    Typeboolean
    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

    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

    JavaVendor

    The Java Vendor value to use when starting this server For example, BEA, Sun, HP etc

    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.

           
    Privileges Read/Write
    Typejava.lang.String

    MBeanInfo

    Returns the MBean info for this MBean.

    Deprecated.

           
    Privileges Read only
    Typejavax.management.MBeanInfo
    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

    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

    ObjectName

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

    Deprecated.

           
    Privileges Read only
    Typeweblogic.management.WebLogicObjectName
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type

    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:

           
    Privileges Read/Write
    Typejava.lang.String
    Default Value
    Encryptedtrue

    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.

           
    Privileges Read/Write
    Typebyte[]
    Default Value
    Encryptedtrue

    Registered

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

    Deprecated.

           
    Privileges Read only
    Typeboolean
    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 domain directory is used by default.

           
    Privileges Read/Write
    Typejava.lang.String

    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

    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


    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
    • javax.management.AttributeNotFoundException
    • javax.management.MBeanException

    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
    • javax.management.AttributeNotFoundException

    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