![]() ![]() ![]() ![]() ![]() ![]() |
|
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]()
|
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
This help page shows and gives a short description of each property
displayed on the Properties page. The main entry headline for
deprecated properties appears in black; the entry for current
properties appears in red.
The WebLogic Server depends on a set of properties to control its
behavior. Currently, properties are stored in one or more properties
files, and are read in by the WebLogic Server at startup time. You can alter
a property by setting its value in the appropriate properties file, or
by supplying a property name=value with the Java -D flag
on the command line when you start WebLogic.
Properties are organized hierarchically. Most properties have 3
sections: "weblogic," followed by the name of the facility, and then
by the name of the property, separated by periods. For example, the
property to set the name of the server is weblogic.system.name. WebLogic
properties use innerCaps (rather than under_bars).
The weblogic.httpd.register
property is used to register virtual names for servlets, and it
extends the hierarchy one more level to accommodate the virtual name.
The WebLogic Admin Properties page displays properties from several
sources. Properties displayed in the Current column are the
current running properties in the WebLogic Server. The current
properties come from one of four sources, which are detailed in the
other four columns. The order in which properties are loaded when the
WebLogic Server starts is as follows: first, the embedded properties set
in the WebLogic Server are loaded, then properties from the global properties file,
followed by properties in the per-server
properties file, and finally, the properties set on the command
line. Each property in succession overrides previously-read
properties by the same name. If you have multiple properties
files, for example a global properties file that sets the same
properties as a per-server properties file located in the "myserver"
folder, the properties set in the per-server properties file will
override the globally set properties. If you are running only one
WebLogic Server, use only the global properties file to set properties
to avoid confusion.
You cannot change the default, embedded WebLogic Server properties. You
can change properties in the global and per-server properties files by
editing these files and restarting the WebLogic Server. (In a future
release, you will be able to modify properties from the Console.) You
can set properties on the command line with the -D flag, as in:
The pattern is:
Notice that the path names are absolute.
Deprecated in 3.0. Use access
control lists to set up servlet access.
Sets the number of seconds between client communication-receives
before the WebLogic Server drops the HTTP client connection. The default is
set to 120 (in seconds); the valid range is between 5 and 900 seconds.
Sets the maximum number of waiting messages the connection queue will
hold before disconnecting the client. The default for the queue is set
to 20 messages; the valid range is from 1 to 1000 messages.
The default servlet is the virtual path of a registered servlet that
the WebLogic Server executes if it cannot map an incoming HTTP request
to a registered servlet. The embedded system default for this server
property points to the T3AdminMain servlet, which gives you access to
the administration pages.
For more information on setting up an HTTPD proxy as the default
servlet, check the WebLogic Administrators Guide document on the
WebLogic website, Setting
WebLogic properties.
The document root is used for JHTML files (PageCompileServlet), for
serving standard HTML pages and images (FileServlet), and for SSI
(ServerSideIncludeServlet).
Turns on HTTP access to the WebLogic Server. If you set this property to
true, it is recommended that you create access
control lists to control access to Server resources.
The WebLogic Server offers port 80 access to serve HTTP servlets and
T3Servlets as well as HTML pages, images, jar files, etc.
Enables the logging of HTTPD requests with WebLogic Events when this property
is set to true. The default is false. If t
his property is set to true,
all HTTP requests generate an event with the same information that is
logged to the HTTP log file. The event is delivered to the topic weblogic.log.http. Parameters
delivered with this event are REMOTE_HOST, RFC931, AUTH_USER, DATE,
VIRTUAL_DOMAIN, REQUEST, STATUS, BYTES, REFERER, USER_AGENT. These
correspond to the information stored in the common log format.
See
weblogic.httpd.enableLogFile for more information about each
property, or Running
and maintaining the WebLogic Server for more information on setting
the properties.
Logs HTTP requests to a separate log file, in addition to the
WebLogic Server's log file. This file is the access.log file, found in the same directory as the
weblogic.log file for the
WebLogic Server.
The access.log for the
WebLogic Server is written in common log format. The format of this file is:
Note that the access log will grow indefinitely, and must be
maintained manually.
A registered servlet may have
input arguments. Use this property to set the input arguments for
registered servlets. For example, if you plan to use the WebLogic Server for
port-80 HTTP access and want to proxy unfulfillable HTTP requests to
another HTTP server running on another host, you would register the
HttpProxyServlet and set its redirectURL argument to the URL of
the alternate HTTP server.
For more information on how to retrieve initArgs, check the Developers
Guide, Using
WebLogic HTTP Servlets, on the WebLogic website.
Enables HTTP keep-alive. Set to true by default. You should set the
properties weblogic.httpd.http.keepAliveSecs
and/or weblogic.httpd.https.keepAliveSecs
to the number of seconds that the keep-alive should be maintained
before timing out.
Sets the size in K for the HTTP request log (by default, this log file
is named "access.log" and is
located in the "myserver/" directory). Maximum size is one
megabyte. When the log file size is exceeded, a new log file is
started and the old log file is versioned in the same directory. You
should routinely clean up or archive old log files.
Establishes a name for the common log format log file, when logging to
this file has been enabled with the property weblogic.httpd.enableLogFile. The
property should be just the name of the file; the default is access.log, stored in the same
directory as this WebLogic Server's other log files (for example, in the
directory "myserver"). This file is always referenced from the
per-server directory of the WebLogic Server.
You must register HTTP servlets in the properties file. Registered
servlets should be in the CLASSPATH of the WebLogic Server. A servlet is loaded
first when it is requested, and will not be reloaded again until the
Server is restarted. You can set up the Server to reload modified
servlets with the properties weblogic.httpd.servlet.classpath
and weblogic.httpd.servlet.reloadOnModify.
For more information about servlets, check the Developers Guide, Using WebLogic
HTTP Servlets, at the WebLogic website. For more information about
setting up the WebLogic Server for HTTP use, check the WebLogic
Administrators Guide, Setting up WebLogic as
a web server.
Set this property to point to a directory that is not in the CLASSPATH
of the WebLogic Server host, and then place servlets here. If your servlets
are in a package, you will need to create the appropriate directory
structure below this directory. The uppermost directory of the package
name should be in the directory you register for this property.
This property and
weblogic.httpd.servlet.reloadOnModify must be set to enable this
feature. You can still register and use servlets in the WebLogic
Server's CLASSPATH, but they will not be reloaded until the WebLogic
Server is restarted. See Reloading
servlets you modify for more information.
Deprecated in 3.1. The frequency with which servlets may be reloaded
from the servlet classpath is now set with
the property weblogic.httpd.servlet.reloadCheckSecs.
Enables URL rewriting for session tracking. In cases where a client
browser cannot handle cookies or the user does not allow the cookie to
be set, the URL is rewritten to append session information in a series
of name/value pairs. The default setting is true.
For more information on session management, see the Developers Guide,
Using
WebLogic HTTP Servlets.
Sets the number of sessions that are cached in memory on the WebLogic
Server. The default is 1024, and the minimum is 16. Caching sessions
can speed up response to requests, but each application should have the
cache session tuned appropriately. For more information on
session-related properties, see the Administrators Guide, Setting
WebLogic properties.
String comment contained in a cookie set in a browser session with the
WebLogic Server. The default is "WebLogic WebLogic Session Tracking
Cookie." For more information on session-related properties, see the
Administrators Guide, Setting
WebLogic properties.
Sets the domain to which the cookie will be returned.
For more information on session-related properties, see the
Administrators Guide, Setting
WebLogic properties.
Sets the time-to-live for the cookie, which translates to the lifetime
of the session, in seconds. Setting the property to -1 (also the default)
sets the cookie to last as long as the browser is running. Minimum is
zero (hardly ever useful) and maximum is MAX_VALUE.
For more information on session-related properties, see the
Administrators Guide, Setting
WebLogic properties.
Sets the name of the cookie; default is "TengahSession."
For more information on session-related properties, see the
Administrators Guide, Setting
WebLogic properties.
Sets the cookie path, which you can use to limit the part of the
website that is session-tracked. For example, if this property is
set to "/only/this/directory" only URLS beneath that path will be
tracked. Default is set to root ("/"), which means that all URLs
sent to the WebLogic Server will be tracked.
For more information on session-related properties, see the
Administrators Guide, Setting
WebLogic properties.
Allows WebLogic to send cookies to the HTTP browser client to set and
retrieve session information. Default is true. For more information
on session-related properties, see the Administrators Guide, Setting
WebLogic properties.
Enables session tracking. Default is true. Once session tracking and
cookies are enabled, write your servlets to use cookies to set and
retrieve session-related information.
For more information on session-related properties, see the
Administrators Guide, Setting
WebLogic properties. For more information on servlets, read the
Developers Guide, Using
WebLogic HTTP Servlets.
Interval at which WebLogic will check the session store for
sessions that have expired. Invalid and timed out sessions
are removed from the session store. Default is 60; minimum
is every second, and maximum is 1 week (604800).
For more information on session-related properties, see the
Administrators Guide, Setting
WebLogic properties.
Set this property to true to enable session persistence. If you
turn on persistence, you must set other session-persistence-related
properties, including
persistentStoreType,
and
persistentStoreDir for
file persistence or
persistentStorePool and
persistentStoreShared
for JDBC-based persistence.
For more information on session-related properties, see the
Administrators Guide, Setting
WebLogic properties.
Used when persistentStoreType is set to "file." Sets the directory
name to be used for storing session-related information.
For more information on session-related properties, see the
Administrators Guide, Setting
WebLogic properties.
Use when persistentStoreType is set to "jdbc." Sets the name of the connection
pool to be used for session JDBC-based persistence.
For more information on session-related properties, see the
Administrators Guide, Setting
WebLogic properties. There's more on setting up connection pools
for session persistence in the Developers Guide Using
WebLogic HTTP Servlets.
Used when persistentStoreType is set to "jdbc." Set to true if the
JDBC-based persistent store is to be shared among multiple WebLogic
Servers.
For more information on session-related properties, see the
Administrators Guide, Setting
WebLogic properties.
Set to "file" or "jdbc" to determine which type of persistent
store should be used for storing session data. See the other
persistence-related properties immediately preceding in this
document.
For more information on session-related properties, see the
Administrators Guide, Setting
WebLogic properties.
Determines how often WebLogic checks to see if too many sessions are in
memory. The weblogic.httpd.session.cacheEntries
property configures the size of the cache. When the number of sessions
in memory exceeds the limit, sessions are cleared, starting with
the oldest/expired/invalid sessions.
For more information on session-related properties, see the
Administrators Guide, Setting
WebLogic properties.
Sets how long a session can sit inactive and unused before it is
invalidated or expired. The size of the cache and the timeout of
each session should be tuned to suit each particular application.
For more information on session-related properties, see the
Administrators Guide, Setting
WebLogic properties.
Set this property to use the WebLogic File service with the
WebLogic Server. Specifies an access point into the native file system on the
WebLogic Server, using the full pathname on the host system. Set a volume
using the syntax in this example, which maps the volume name "users"
to the UNIX directory "/usr/local/tmp":
For more information on setting properties for client read/write
access, see Setting
properties for client read/write access in the WebLogic
Administrators Guide document, Setting
WebLogic properties.
A connection pool is a set of DBMS connections that can be created by
registering a name for the pool and setting its parameters. You set
the name for the connection pool by adding it to the end of the
property, as in "weblogic.jdbc.connectionPool.eng," which
would register a connection pool called "eng." Once a connection pool
is created and its parameters are set, a T3User can request a connection
from the pool without having to supply any further information.
Parameters to be set include include:
This illustrates a connection pool named "eng" and its access control
list. The connection pool is for an Oracle database, with an initial
pool of 4 connections that can be incrementally increased two at a
time, up to a maximum of 10 connections. A login delay of 2 seconds is
set; some databases cannot handle rapid requests for connections, and
the login delay setting can be adjusted to prevent errors from a busy
DBMS.
You can set an interval of time after which a pool that has
incrementally grown in size will shrink back to its initialCapacity,
if the added connections are not in use. The default for the
shrinkPoolMins property is 15 minutes. To allow backwards
compatibility, there is an enabling property, allowShrinking, which --
like the command to reset a connection pool -- can be executed from
the command line with the weblogic.Admin program by a user with
administrative-level privileges. The ACL permission for this
action is "shrink."
The properties for access to the DBMS itself (as you might set with a
java.utils.Properties object) are "username," "password," and
"server."
An access control list has also been set for this connection pool, to
allow the T3Users "guest," "joe," and "jill" the "reserve" permission
for JDBC connections from the pool. Since any T3Client not created
with an explicit T3User defaults to the default T3User "Guest," this
connection pool will be accessible to any T3Client.
You should not have this property in your properties file unless you
can make the explicitly described connection to the proper DBMS,
since the connections are created when the WebLogic Server is started.
Enables logging of all jdbcKona operations generated from
DriverManager.setLogStream() into a single per-server file,
located in the per-server directory (default per-server
directory is "myserver/"). Default is false.
Identifies the logfile name (no path info should be included) for
jdbcKona logging from DriverManager.setLogStream(). This file is
always in the per-server directory (default per-server directory is
"myserver/"). If this file does not exist, it will be created.
Supplies a list of factories (interfaces/classes) that
create transportable objects. For more information on
using this property read the Developers Guide,
Using
WebLogic JNDI.
Sets the number of milliseconds that WebLogic will wait for a client
login request to fail before closing the connection. For some client
login operations, for example for a client logging in over a secure
line with authentication/encryption enabled, the login process may
require several seconds, and this property may need to be increased.
This property assigns username and password for users that have access
to the WebLogic Server. The syntax is
weblogic.password.username=password, where the username
and password are both case-sensitive, and the password must be at
least the length defined by the property weblogic.system.minPasswordLen.
For example,
The username and password to allow access to registered servlets with
the property weblogic.httpd.allow.virtualName=username,
where each registered servlet has a comma-delimited list of users that
can access the servlet.
that can be used for finer control over access to registered
servlets, with access
control lists.
The password for the user "system" must be set before you start the
WebLogic Server. See the next entry.
This property is a special case of weblogic.password that assigns the
password for the administrative, privileged user of the WebLogic
Server. Some functionality in administering the WebLogic Server requires
the username and password of a privileged user. See the WebLogic
Administrators Guide document Managing the
WebLogic Server for more information.
The username for this user is always system. The syntax is
weblogic.password.system=password, where the password is
case-sensitive and at least 8 letters long. The password for the
user "system" must be set before you start the WebLogic Server.
Deprecated in 3.0. Use weblogic.system.startupArgs.
Deprecated in 3.0. Use weblogic.system.startupClass.
Identifies the filename of the certificate of the certificate
authority that issued the WebLogic Server's X509 certificate. This
property is optional in version 2.5. Use multiple instances of this
property as "weblogic.security.certificate.authority2" and
"weblogic.security.certificate.authority3" to establish a certificate
chain.
For more information, see the Developers Guide, Using
WebLogic SSL. See also weblogic.system.SSLListenPort.
Identifies the filename of the WebLogic Server's SSL certificate issued by a
certificate authority, which must be located in the per-server
directory of the WebLogic Server (default directory is "myserver").
For more information, see the Developers Guide, Using
WebLogic SSL. See also weblogic.system.SSLListenPort.
Limits the number of temporary tokens for applet authentication
produced by the ClientAuthenticationServlet. This safeguards the
WebLogic Server from having to store tokens indefinitely that are never
claimed and used. Default is 3.
For more information, see the Developers Guide, Using
WebLogic SSL. See also weblogic.system.SSLListenPort.
Setting this property to the filename of any certificate authority's
valid certificate turns on two-way authentication. The certificate
must be located in the per-server directory (default is "myserver").
For more information about two-way authentication and setting this
property, see the Developers Guide, Using
WebLogic SSL. See also weblogic.system.SSLListenPort.
Use this property to set up realm-based groups. Each username
that you add to the group must have a username and password in
the operating realm. For example in the WebLogic realm, you must
first set up:
Identifies the filename of the private key of the WebLogic Server, which must
be located in the per-server directory (default is "myserver").
For more information, see the Developers Guide, Using
WebLogic SSL. See also weblogic.system.SSLListenPort.
If this property is set to true, WebLogic will listen to the port set
with the the weblogic.system.SSLListenPort
property for SSL login requests. Default is true.
This property was deprecated in version 2.3.2. Use weblogic.password.system.
Sets the destination IP address that the WebLogic Server will accept
requests for.
Deprecated in 2.4. WebLogic uses the CLASSPATH of the shell in which it
is running. For servlet loading, see weblogic.httpd.servlet.classpath.
Turns on logging to the console. Everything that appears on the
console is also written to the system logfile. Lines you add to
your applications with System.out.println()
appear on the console. To add log messages, use the log
facility, which is detailed in the Developers Guide,
Writing
a T3Client application.
When this property is set to true, WebLogic may attempt to complete
reverse DNS lookups on some operations. If your network does not
support DNS, you should disable this property.
UNIX only: Set to true to change the ownership of the WebLogic Server process
after it binds to port 80 during the startup process. The WebLogic Server
must be started from a privileged user account in order to bind to
port 80, but after that is completed, it is preferable for security
purposes to set the user ID (UID) of the WebLogic Server process to a
non-privileged user. Identify the user with weblogic.system.nonPrivUser.
This property sets the maximum number of execute threads that can be
running in the WebLogic Server. It indicates how many simultaneous operations
can be executing in the WebLogic Server at the same time. This property
defaults to 15. This property is not the same as the number of client
connections; for example, one client may be using more than one
execute thread at a time.
For more information, see the WebLogic Administrators Guide on Tuning the WebLogic
Server.
Sets the base URL for these help files. The directory in which these
help files are stored in the distribution is the "docs/adminhelp/"
directory in WebLogic's document
root (default location is "myserver/public_html"), so that you can
view these help files without interacting with an HTTP server that
will serve HTML pages. If you prefer to read these files online, you
can set this property to
http://www.weblogic.com/docs/adminhelp/. The latest versions of
these files are always online at the WebLogic website.
WebLogic home is the base directory for all WebLogic Server operations. Your
properties file should
always be located in this directory, as well as any per-server
directories. You must have weblogic.system.home set to start the WebLogic Server.
Sets the number of outstanding HTTPD requests that the WebLogic Server can
queue while waiting for an available HTTPD thread. Use the property weblogic.system.httpdThreadCount
to increase or decrease the number of HTTPD threads available.
Sets the number of HTTPD threads the WebLogic Server should spawn to
service HTTPD requests. The default is 5, and the valid range is
1-256. Tuning the WebLogic Server for optimum HTTPD performance requires
finding the right balance between the number of threads available to
answer requests -- more threads can answer more requests -- and the
overhead from spawning many threads unnecessarily, which also has
overhead.
For more information, see the WebLogic Administrators Guide on Tuning the WebLogic
Server.
The TCP port at which the WebLogic Server listens for incoming connection
requests. Set this port to "80" to use the WebLogic Server as a HTTP server
with transfirewall support. Choose a number between 7000-8000 if you
are not running your WebLogic Server on port 80. Ports 1023 and below are
reserved.
For more information on using the WebLogic Server as a webserver, see
the WebLogic Administrators Guide, Setting up the WebLogic
Server as an HTTP server.
The full pathname of the WebLogic Server logfile. The logfile is located in
the per-server directory (the default is the directory "myserver/"
located in WebLogic home). If this logfile does not exist, it is
created when the WebLogic Server is started.
Deprecated in 3.1. Use weblogic.system.maxSockReadThreads.
This property sets the maximum size to which a logfile can grow before
backup and reset (in K). When a new log file is started, the old log
file is saved and the new file is versioned with the name plus an
incremented integer. You should delete or archive older versions on
a regular basis.
Sets the maximum number of threads that are set to read T3 messages
from a socket. The default is 25, and the valid range is 1-5000.
Indicates the maximum number of socket readers that the Tengah Server can
have at any one time.
Supercedes weblogic.system.maxConnections.
For more information, see the WebLogic Administrators Guide on Tuning the WebLogic
Server.
Sets the minimum length of user access passwords. Passwords are
case-sensitive. The minimum password length is 8 characters (also the
default) and the maximum length is 16 characters.
The name of the WebLogic Server. The default server name is "myserver," which
is also the name of the default directory (in weblogic.home) in which you will find your logfile, WebLogic JDBC log file, and common log format log file. You
can change the name of the server by setting this property and
creating a directory of the same name in Weblogic home. For more information
about setting up multiple WebLogic Servers, check Setting
WebLogic properties on the WebLogic website.
UNIX only: Non-privileged group that should own the process in which
the WebLogic Server is running after binding to port 80 for HTTP.
Enable this feature with weblogic.system.enableSetGID.
See also weblogic.system.nonPrivUser.
UNIX only: Use this property to identify the non-privileged UNIX user
for switching the UID after starting the WebLogic Server on port 80. The
non-privileged user must have adequate permissions for the files the
WebLogic Server will need for operation (like log files and the WebLogic
classes). This identifies the user for use with the property weblogic.system.enableSetUID.
Location of the per-server properties file, if it exists. The default
full pathname -- which is the file that the WebLogic Server looks for to see
if a per-server file exists -- is displayed in the far right column
(the default properties column). Properties that are set out of this
file are reflected by values in the 4th column. The order in which
properties are looked for when the WebLogic Server starts begins with the
default properties inside the WebLogic Server; then properties in the global properties file is
examined, followed by the per-server properties file for this
WebLogic Server, and then by properties set on the command line.
The global properties file. The order in which properties are read in
begins with the default properties that are set in the server; then
the global properties file is read, followed by the per-server
properties file, and finally by the properties that you set on the
command line when you start the WebLogic Server. Note that properties set in
the global properties file will be overridden by properties in the
per-server properties file, which in turn are overridden by properties
set on the command line.
Set this property to name-value pairs for your shutdownClass. Shutdown args
are passed to your shutdownClass as a Hashtable.
Use this property to register a virtual name for one or more shutdown
classes. Shutdown classes are automatically loaded and executed. The
virtual name is passed to the shutdown() method in the class you write (implements
weblogic.common.T3ShutdownDef)
as one of the arguments, and the name-value pairs created in the shutdownArgs property are
passed as a Hashtable. Note that the shutdown class must be located in
the CLASSPATH of the WebLogic
Server host.
For more info on writing a shutdown class, check the section on
shutdown classes in the Developers Guide, Writing
a T3Client application.
Sets the TCP port at which WebLogic Server listens for SSL
connection requests. The default is zero, which disables SSL in the
WebLogic Server.
For more information, see the Developers Guide, Using
WebLogic SSL.
Set this property to name-value pairs for your startup class. Startup args are
passed to your startup class as a Hashtable.
Use this property to register a virtual name for one or more startup
classes. Startup classes are automatically loaded and executed. The
virtual name is passed to the startup() method in the class you write (implements
weblogic.common.T3StartupDef)
as one of the arguments, and the name-value pairs created in the startupArgs property are passed
as a Hashtable. Note that the startup class must be located in the
CLASSPATH of the WebLogic Server
host.
You can register more than one startup class, either in
separate registrations, as in this example:
For more info on writing a startup class, check the section on startup
classes in the Developers Guide, Writing a
T3Client application.
See also how to register a startup
class.
Enables publishing for clients and administrators with WebLogic ZAC from
this WebLogic Server. Set the "write" permission with an ACL
to control who can publish ZAC applications to the server (defaults to
system); for clients, set the "read" permission (defaults to
everyone). If this property is set to false, no one can publish or
use ZAC packages from this WebLogic Server.
Sets the directory location where ZAC packages should be stored on
WebLogic for serving to clients. The default is the "myserver/zac"
directory.
Back to the Admin Help Summary
Copyright © 1997-99 BEA WebXpress, Inc. All rights reserved. Product
specifications, release dates, and prices are subject to change
without notice. BEA WebXpress, Inc. makes no warranties, express or
implied, with regards to its products in this
document.
Last updated
12/28/1998
|