|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ServerStartMBean
This bean is used to configure the attributes necessary to start up a server on a remote machine.
Field Summary |
---|
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
---|---|
abstract String |
getArguments() The arguments to use when starting this server. |
abstract String |
getBeaHome() Deprecated. 12.1.3.0 replaced by ServerStartMBean.getMWHome |
abstract String |
getClassPath() The classpath (path on the machine running Node Manager) to use when starting this server. |
abstract String |
getJavaHome() The Java home directory (path on the machine running Node Manager) to use when starting this server. |
abstract String |
getJavaVendor() The Java Vendor value to use when starting this server. |
abstract String |
getMWHome() |
abstract String |
getPassword() The password of the username used to boot the server and perform server health monitoring. |
abstract byte[] |
getPasswordEncrypted() The encrypted password of the username used to boot the server and perform server health monitoring. |
abstract String |
getRootDirectory() The directory that this server uses as its root directory. |
abstract String |
getSecurityPolicyFile() The security policy file (directory and filename on the machine running Node Manager) to use when starting this server. |
abstract String |
getUsername() The user name to use when booting this server. |
abstract void |
setArguments(String classpath) Set the value of the Arguments attribute. |
abstract void |
setBeaHome(String path) Deprecated. 12.1.3.0 replaced by ServerStartMBean.setMWHome |
abstract void |
setClassPath(String classpath) Sets the value of the ClassPath attribute. |
abstract void |
setJavaHome(String path) Sets the value of the JavaHome attribute. |
abstract void |
setJavaVendor(String vendor) Sets the value of the JavaVendor attribute. |
abstract void |
setMWHome(String path) Sets the value of the MWHome attribute. |
abstract void |
setOutputFile(String fileName) Sets the value of the OutputFile attribute. |
abstract void |
setPassword(String password) Sets the value of the Password attribute. |
abstract void |
setPasswordEncrypted(byte[] bytes) Encrypts the user password and sets the value of the PasswordEncrypted attribute. |
abstract void |
setRootDirectory(String path) Sets the value of the RootDirectory attribute. |
abstract void |
setSecurityPolicyFile(String filePath) Sets the value of the SecurityPolicy attribute. |
abstract void |
setUsername(String username) Sets the value of the Username attribute. |
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 |
Method Detail |
---|
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.
void setJavaVendor(String vendor) throws InvalidAttributeValueException
Sets the value of the JavaVendor attribute.
vendor
- The new javaVendor valueInvalidAttributeValueException
ServerStartMBean.getJavaVendor()
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.
void setJavaHome(String path) throws InvalidAttributeValueException
Sets the value of the JavaHome attribute.
path
- The new javaHome valueInvalidAttributeValueException
ServerStartMBean.getJavaHome()
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.
void setClassPath(String classpath) throws InvalidAttributeValueException
Sets the value of the ClassPath attribute.
classpath
- The new classPath valueInvalidAttributeValueException
ServerStartMBean.getClassPath()
String getBeaHome()
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
.
void setBeaHome(String path) throws InvalidAttributeValueException
Sets the value of the BeaHome attribute.
path
- The new beaHome valueInvalidAttributeValueException
ServerStartMBean.getBeaHome()
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.
void setMWHome(String path) throws InvalidAttributeValueException
Sets the value of the MWHome attribute.
path
- The new MWHome valueInvalidAttributeValueException
ServerStartMBean.getMWHome()
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.
void setRootDirectory(String path) throws InvalidAttributeValueException
Sets the value of the RootDirectory attribute.
path
- The new rootDirectory valueInvalidAttributeValueException
ServerStartMBean.getRootDirectory()
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=
void setSecurityPolicyFile(String filePath) throws InvalidAttributeValueException
Sets the value of the SecurityPolicy attribute.
filePath
- The new securityPolicyFile valueInvalidAttributeValueException
ServerStartMBean.getSecurityPolicyFile()
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.
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.
classpath
- The new arguments valueInvalidAttributeValueException
ServerStartMBean.getArguments()
void setOutputFile(String fileName)
Sets the value of the OutputFile attribute.
fileName
- The new outputFile valueServerStartMBean.getOutputFile()
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.
void setUsername(String username) throws InvalidAttributeValueException
Sets the value of the Username attribute.
username
- The new username valueInvalidAttributeValueException
ServerStartMBean.getUsername()
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:
PasswordEncrypted
attribute.When you set the value of this attribute, WebLogic Server does the following:
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
.
ServerStartMBean.getPasswordEncrypted()
void setPassword(String password) throws InvalidAttributeValueException
Sets the value of the Password attribute.
password
- The new password valueInvalidAttributeValueException
ServerStartMBean.getPassword()
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.
void setPasswordEncrypted(byte[] bytes) throws InvalidAttributeValueException
Encrypts the user password and sets the value of the PasswordEncrypted attribute.
bytes
- The new password value as a byte arrayInvalidAttributeValueException
ServerStartMBean.getPasswordEncrypted()
|
Copyright 1996, 2015, 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.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |