|
Oracle Fusion Middleware Oracle WebLogic Server MBean Javadoc 11g Release 1 (10.3.3) Part Number E13945-03 |
||||||||||
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.
This is a type-safe interface for a
WebLogic Server MBean, which you can import into your client
classes and access through
weblogic.management.MBeanHome
. As of 9.0, the
MBeanHome
interface and all type-safe interfaces for
WebLogic Server MBeans are deprecated. Instead, client classes that
interact with WebLogic Server MBeans should use standard JMX design
patterns in which clients use the
javax.management.MBeanServerConnection
interface to
discover MBeans, attributes, and attribute types at runtime.
Field Summary |
---|
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
---|---|
String |
getArguments()
The arguments to use when starting this server. |
String |
getBeaHome()
The BEA home directory (path on the machine running Node Manager) to use when starting this server. |
String |
getClassPath()
The classpath (path on the machine running Node Manager) to use when starting this server. |
String |
getJavaHome()
The Java home directory (path on the machine running Node Manager) to use when starting this server. |
String |
getJavaVendor()
The Java Vendor value to use when starting this server For example, BEA, Sun, HP etc |
String |
getPassword()
The password of the username used to boot the server and perform server health monitoring. |
byte[] |
getPasswordEncrypted()
The encrypted password of the username used to boot the server and perform server health monitoring. |
String |
getRootDirectory()
The directory that this server uses as its root directory. |
String |
getSecurityPolicyFile()
The security policy file (directory and filename on the machine running Node Manager) to use when starting this server. |
String |
getUsername()
The user name to use when booting this server. |
void |
setArguments(String classpath)
Set the value of the Arguments attribute. |
void |
setBeaHome(String path)
Sets the value of the BeaHome attribute. |
void |
setClassPath(String classpath)
Sets the value of the ClassPath attribute. |
void |
setJavaHome(String path)
Sets the value of the JavaHome attribute. |
void |
setJavaVendor(String vendor)
Sets the value of the JavaVendor attribute. |
void |
setOutputFile(String fileName)
Sets the value of the OutputFile attribute. |
void |
setPassword(String password)
Sets the value of the Password attribute. |
void |
setPasswordEncrypted(byte[] bytes)
Encrypts the user password and sets the value of the PasswordEncrypted attribute. |
void |
setRootDirectory(String path)
Sets the value of the RootDirectory attribute. |
void |
setSecurityPolicyFile(String filePath)
Sets the value of the SecurityPolicy attribute. |
void |
setUsername(String username)
Sets the value of the Username attribute. |
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
freezeCurrentValue, getName, getNotes, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet |
Method Detail |
---|
String getJavaVendor()
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.
void setJavaVendor(String vendor) throws InvalidAttributeValueException
Sets the value of the JavaVendor attribute. .
vendor
- The new javaVendor value
InvalidAttributeValueException
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
.
void setJavaHome(String path) throws InvalidAttributeValueException
Sets the value of the JavaHome attribute. .
path
- The new javaHome value
InvalidAttributeValueException
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 (:).
void setClassPath(String classpath) throws InvalidAttributeValueException
Sets the value of the ClassPath attribute.
classpath
- The new classPath value
InvalidAttributeValueException
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 value
InvalidAttributeValueException
ServerStartMBean.getBeaHome()
String getRootDirectory()
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.
void setRootDirectory(String path) throws InvalidAttributeValueException
Sets the value of the RootDirectory attribute.
path
- The new rootDirectory value
InvalidAttributeValueException
ServerStartMBean.getRootDirectory()
String getSecurityPolicyFile()
The security policy file (directory and filename on the machine running Node Manager) to use when starting this server.
void setSecurityPolicyFile(String filePath) throws InvalidAttributeValueException
Sets the value of the SecurityPolicy attribute.
filePath
- The new securityPolicyFile value
InvalidAttributeValueException
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.
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 value
InvalidAttributeValueException
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 value
InvalidAttributeValueException
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 value
InvalidAttributeValueException
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 array
InvalidAttributeValueException
ServerStartMBean.getPasswordEncrypted()
|
Copyright 1996, 2010, 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 Oracle WebLogic Server MBean Javadoc 11g Release 1 (10.3.3) Part Number E13945-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |