BEA Logo BEA WebLogic Server Release 6.1

  BEA Home  |  Events  |  Solutions  |  Partners  |  Products  |  Services  |  Download  |  Developer Center  |  WebSUPPORT

 

  |  

  WebLogic Server Doc Home   |     Configuration Reference   |   Previous Topic   |   Next Topic   |   Contents   |   Index   |   View as PDF

config.xml Elements and Attributes

 

The following sections describe the elements defined in the WebLogic Server config.xml file, the configuration file for the WebLogic Server.

 


Element Hierarchy

The config.xml file consists of a series of XML elements. The Domain element is the top-level element, and all elements in the Domain are children of the Domain element. Child elements may have children themselves. For example, the Server element contains the SSL, ServerStart, Log, WebServer, and ExecuteQueue child elements.

The characters following the element names in the diagram indicate the possible occurrence of the children elements in the Domain element:

 


Element Attribute Descriptions

The following sections describe the attributes that you can configure for each element in the config.xml file.

 


Administrator

This element provides contact information for a system administrator. A domain may have one or more administrators.

Attribute

Description

Range of Values and Default

Console Navigation

EmailAddress

The administrator's well-formed email address.

userid, userid@domain, or null

Default: root


Name

Name of this MBean. (Required.)

String

Default: AdministratorMBean


Notes

Optional user-supplied information about this configuration Administrator.

String

Default: Null


PhoneNumber

Returns this administrator's phone number, or null if none has been specified.

String

Default: Null


WriteAuthorized

Indicates whether this administrator has write access to the configuration.

true or false

Default: false


 


Application

An application represents a J2EE application contained in a EAR file or EAR directory.

Attribute

Description

Range of Values and Default

Console Navigation

ApplicationDescriptor




Deployed

Deploy or undeploy the entire application. Setting deployed to be true on an application, or setting deployed to be false on an application that is not deployed is an error.

true or false

Default: true

Deployments: Applications: Deployed

Name

The name of the MBean. (Required.)

String

Default: ApplicationMBean

Deployments: Applications: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


Path

The path pointing to the application's EAR file, relative to the administration server's file system.

Pathname (absolute paths allowed)

Deployments: Applications: Path

 


ApplicationManager

This Mbean manages an application across a Domain. It is an AdminServer-only MBean that is configurable as a singleton child of Domain.

Attribute

Description

Range of Values and Default

Console Navigation

AutoDeployedEnabled

Enables the Auto Deployment feature of the Admin Server, in which applications that reside in a particular directory are automatically deployed by the Admin Server, regardless of whether or not they are configured. The server polls the directory throughout the session, so even if the server is running at the time, placing an application (for example, EAR, JAR, or WAR files) in that directory causes it to be deployed; deleting an application from the directory causes it to become undeployed.

The directory is located at:

(root)\config\<domain>\applications

For example:

c:\bea61\config\mydomain\applications

This attribute only takes effect if the server is running in "development mode". It is ignored if the server is in "production mode".

In development mode, the default value for this attribute is "true".

true or false

Default: true


AutoUpdateInterval

The auto-update interval for the application manager. The application manager regularly polls the application directories for new applications. This interval is the length of time, in milliseconds, between these checks. A check may be forced by directly calling for an update.

Integer, in milliseconds

Default: 3000


Name

The name of the MBean. (Required.)

String

Default: ApplicationManagerMBean


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


 


BridgeDestination

Defines a Bridge destination.

Attribute

Description

Range of Values and Default

Console Navigation

AdapterJNDIName

The string defined in the adapter's description and used to bind the adapter in WebLogic Server JNDI.

String


Name

The name of the MBean. (Required.)

String

Default: BridgeDestinationMBean


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


Properties

Set of properties defined for destination. The properties are separated by a semicolon (";").



 


CachingRealm

This element represents CachingRealm's configuration properties. It allows the user to specify an alternate realm to the FileRealm. It is associated with the RealmMBean. If this MBean is not created, then only the FileRealm is used.

Attribute

Description

Range of Values and Default

Console Navigation

ACLCacheEnable

Enables the caching of Access Control Lists (ACL).

true or false

Default: true


ACLCacheSize

The maximum number of ACL lookups to cache. This attribute should be a prime number for best lookup performance.

17-65537

Default: 211


ACLCacheTTLNegative

The number of seconds to retain the results of an unsuccessful ACL lookup. TTL means "Time to Live".

1-n

n=java.lang.Integer.MAX_VALUE.

In Seconds.

Default: 10


ACLCacheTTLPositive

The number of seconds to retain the results of a successful ACL lookup. TTL means "Time to Live."

1-n

n=java.lang.Integer.MAX_VALUE.

In seconds.

Default: 60


AuthenticationCacheEnable

Enables the caching of authentication requests.

true or false

Default: true


AuthenticationCacheSize

The maximum number of authentication requests to cache. This attribute should be a prime number, for best lookup performance.

17-65537

Default: 211


AuthenticationCacheTTLNegative

The number of seconds to retain the results of an unsuccessful authentication request. TTL means "Time to Live."

1-n

n=java.lang.Integer.MAX_VALUE.

In seconds.

Default: 10


AuthenticationCacheTTLPositive

The number of seconds to retain the results of a successful authentication request. TTL means "Time to Live."

1-n

n=java.lang.Integer.MAX_VALUE.

In seconds.

Default: 60


BasicRealm

The name of the class of the security realm being used with the Caching realm. Required. To use an alternate security realm follow these steps:

  1. Create an RealmMBean for the alternate security realm. For example: NTRealm.

  2. Create a CachingRealm MBean and set the BasicRealm attribute to the name of the MBean for the alternate security realm.

  3. Set the CachingRealm MBean to the Caching Realm.



CacheCaseSensitive

Defines whether or not the specified security realm is case-sensitive. By default, this attribute is enabled. To use a security realm that is not case-sensitive (such as the Windows NT and LDAP security realms), disable this attribute.

true or false

Default: true


GroupCacheEnable

Enables the caching of Group lookups.

true or false

Default: true


GroupCacheSize

The maximum number of Group lookups to cache. This attribute should be a prime number for best lookup performance.

17-65537

Default: 211


GroupCacheTTLNegative

The number of seconds to retain the results of an unsuccessful Group lookup. TTL means "Time to Live."

1-n

n=java.lang.Integer.MAX_VALUE.

In seconds.

Default: 10


GroupCacheTTLPositive

The number of seconds to retain the results of a successful Group lookup. TTL means "Time to Live."

1-n

n=java.lang.Integer.MAX_VALUE.

In seconds.

Default: 60


GroupMembershipCacheTTL

The number of seconds to store the members of the Group before updating the members. TTL means "Time to Live."

1-n

n=java.lang.Integer.MAX_VALUE.

In seconds.

Default: 300


Name

The name of the MBean for the Caching realm attributes. (Required.)

String

Default: CachingRealmMBean


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


PermissionCacheEnable

Enables the caching of permission lookups.

true or false

Default: true


PermissionCacheSize

The maximum number of permission lookups to cache. This attribute should be a prime number for best lookup performance.

17-65537

Default: 211


PermissionCacheTTLNegative

The number of seconds to retain the results of an unsuccessful permission lookup. TTL means "Time to Live."

1-n

n=java.lang.Integer.MAX_VALUE.

In seconds.

Default: 10


PermissionCacheTTLPositive

The number of seconds to retain the results of successful permission lookup. TTL means "Time to Live."

1-n

n=java.lang.Integer.MAX_VALUE.

In seconds.

Default: 60


UserCacheEnable

Enables caching of User lookups.

true or false

Default: true


UserCacheSize

The maximum number of User lookups to cache. This attribute should be a prime number for best lookup performance.

17-65537

Default: 211


UserCacheTTLNegative

The number of seconds to retain the results of unsuccessful User lookup. TTL means "Time to Live."

1-n

n=java.lang.Integer.MAX_VALUE.

In seconds.

Default: 10


UserCacheTTLPositive

The number of seconds to retain the results of successful User lookup.

1-n

n=java.lang.Integer.MAX_VALUE.

In seconds.

Default: 60


 


Cluster

This element represents a cluster in the domain. A configuration may define zero or more clusters. Servers join a configured cluster by calling ServerMBean.setCluster with the logical name of the cluster. A configuration may define zero or more clusters. They may be looked up by logical name. The name of a cluster denotes its logical cluster name.

Attribute

Description

Range of Values and Default

Console Navigation

ClusterAddress

The address to be used by clients to connect to this cluster.

Must be either a DNS host name that maps to multiple IP addresses or, for development or testing purposes, a comma-separated list of single address host names or IP addresses.

Valid IP address or hostname

Default: Null

Clusters: clustername: Configuration: General: Cluster Address

DefaultLoadAlgorithm

The algorithm used to distribute requests among instances in a cluster.

round-robin

weight-based

random

Default: round-robin

Clusters: clustername: Configuration: General: Default Load Algorithm

MulticastAddress

The multicast address used by cluster members to communicate with each other.

IP multicast address

Clusters: clustername: Configuration: Multicast: Multicast Address

MulticastSendDelay

The number of milliseconds to delay sending message fragments over multicast.

Integer

Default: 12

Clusters: clustername: Configuration: Multicast: Multicast Send Delay

MulticastTTL

The maximum number of network hops that a cluster multicast message is allowed to travel. A value of 1 restricts the cluster to one subnet. TTL means "Time to Live"

1 to 255 inclusive.

Default: 1

Clusters: clustername: Configuration: Multicast: Multicast TTL

Name

The name of the MBean. (Required.)

The cluster name can be up to 256 alphanumeric characters, but may not contain commas or spaces.

String.

Default: N/A

Clusters: clustername: Configuration: General: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null

Clusters: clustername: Notes

Servers

The servers that have declared membership in this cluster.

List

Default: Null

Clusters: clustername: Servers

WeblogicPluginEnabled

Set to true if the cluster will receive requests from a proxy plug-in or HttpClusterServlet. When WeblogicPluginEnabled is true, a call to getRemoteAddr will return the address of the browser client from the proprietary WL-Proxy-Client-IP header, instead of from the web server.

WeblogicPluginEnabled is present in ClusterMBean and ServerMBean. The ClusterMBean value overrides the ServerMBean value.

true or false

Default: false

WebLogic Plug-in Enabled

 


ConnectorComponent

Defines a resource adapter.

Attribute

Description

Range of Values and Default

Console Navigation

Application



Deployments: Connectors: Application

AuthenticationMechanisms

The authentication mechanism. Non-configurable.



CapacityIncrement

Resource Adapter Connector Pool's properties: the increment by which the pool capacity is expanded. Non-configurable.

1-n

Default: 1


ClassLoader

The classloader. Non-configurable.



ConfigProperties

The configuration properties. Non-configurable.



ConnectionCleanupFrequency

Frequency at which connection times are checked. Connections are cleaned up if they have exceeded their duration time. Non-configurable.

Default: -1


ConnectionDurationTime

Duration of time in which connections are allowed to be active. Non-configurable.

Default: -1


ConnectionFactoryDescription

The connection factory description. Non-configurable.



ConnectionFactoryImpl

One of the Resource Adapter Component's properties. Non-configurable.



ConnectionFactoryInterface

One of the Resource Adapter Component's properties. Non-configurable.



ConnectionFactoryName

The connection factory name. Non-configurable.



ConnectionImpl

One of the Resource Adapter Component's properties. Non-configurable.



ConnectionInterface

One of the Resource Adapter Component's properties. Non-configurable.



DelayedBinding

Non-configurable.

true or false

Default: false


DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

Default: 1000


Description




DisplayName

Resource Adapter Component's display name. Non-configurable.



EisType

EIS Type of the Resource Adapter Component. Non-configurable.



InitialCapacity

Resource Adapter Connector Pool's properties: initial number of connections. Non-configurable.

0-n

Default: 1


JNDIName

The JNDI name for the ManagedConnectionFactory reference. Non-configurable.



LargeIcon

The large icon name for the Resource Adapter Component. Non-configurable.



LicenseDescription

The license description for the Resource Adapter Component. Non-configurable.



LicenseRequired

A flag that indicates whether or not a license is required. Non-configurable.

true or false

Default: false


LogFileName

ManagedConnectionFactory log file. Non-configurable.



LoggingEnabled

ManagedConnectionFactory logger flag. Non-configurable.

true or false

Default: false


ManagedConnectionFactoryClass

One of the Resource Adapter Component's properties. Non-configurable.



MapConfigProperties

The mapped configuration properties (those that are overridden from the default configuration properties). Non-configurable.



MaxCapacity

Resource Adapter Connector Pool's properties: the maximum number of connections. Non-configurable.

1-n

Default: 10


Name

The name of the MBean. (Required.)

String

Default: N/A

Deployments: Connectors: Name

NativeLibDir

The native library directory. Non-configurable.



Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null

Null

RALinkRef

Resource Adapter Link reference. Non-configurable.



reauthenticationSupport

Flag that indicates whether or not reauthorization is supported. Non-configurable.

true or false

Default: false


SecurityPermissions

The security permissions. Non-configurable.



SecurityPrincipalMaps

The security principal maps. Non-configurable.



ShrinkingEnabled

Set to true to enable pool shrinking. Non-configurable.

true or false

Default: true


ShrinkPeriodMinutes

Non-configurable.

0-n

Default: 15


SmallIcon

small icon name for the Resource Adapter Component Non-configurable.



SpecVersion

The version of the specification for the Resource Adapter Component Non-configurable.



Targets




TransactionSupport

Transaction support. Non-configurable.

none, local, XA


URI

A Uniform Resource Identifier (URI) pointing to the application component, usually found on the Admin server.

(Required.)

Valid string

Deployments: Connectors: URI

VendorName

The name of the vendor for the Resource Adapter Component Non-configurable.



Version

The version for the Resource Adapter Component Non-configurable.



 


CustomRealm

This element holds configuration properties for a custom realm. A custom realm is a realm entirely written by the customer vs. a tweak of the RDBMSRealm. Since we cannot possibly know what the custom realm's configuration properties will be, we just add a attribute that contains a properties list. The custom realm can define which properties should be in the list.

Attribute

Description

Range of Values and Default

Console Navigation

ConfigurationData

A list of the configuration properties for the custom security realm. These properties could be database schema.



Name

The name of the MBean. (Required.)

String

Default: CustomRealmMBean


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


Password

The password for the Custom Security realm. If a password is supplied, WebLogic Server encrypts it.



RealmClassName

The name of the Java class that implements the Custom Security realm. This class should be included in the CLASSPATH of the WebLogic Server.


Security: Realms: Realm Class Name

 


Domain

A WebLogic Domain. A WebLogic Domain is a special target, the "Domain" target. Usually this equates to an instance of the WebLogic server.

Attribute

Description

Range of Values and Default

Console Navigation

Active

Is this domain active?

true or false

Default: false


LastModificationTime

The last time this domain was updated. Guaranteed to be unique for a given transactional modification.

Default: 0


Name

The name of the MBean. (Required.)

May contain up to 256 alphanumeric characters, but not commas or spaces.

String.

Default: mydomain


Notes

Optional user-supplied information about this configuration MBean.

alphanumeric string

Default: Null


RootDirectory

The highest directory in which the administrative server is installed.

None specified.


 


DomainLogFilter

This element represents a filter to qualify log messages which are logged to the domain log file. A message must qualify all criteria specified to qualify the filter. Multiple instances of this MBean can be defined, if needed. If there are multiple instances, a message must qualify at least one filter to qualify for the domain log file.

Attribute

Description

Range of Values and Default

Console Navigation

Name

The name of the MBean. (Required.)

String

Default: DomainLogFilterMBean


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


SeverityLevel

The minimum severity of a message which qualifies this filter. All messages with given severity and higher, qualify.

The ascending order of severities is

  • 64 (INFO)

  • 32 (WARNING)

  • 16 (ERROR)

  • 8 (NOTICE)

  • 4 (CRITICAL)

  • 2 (ALERT)

  • 1 (EMERGENCY)

64, 32, 16, 8, 4, 2, 1

Default: 16


SubsystemNames

If none are specified, messages from all subsystems qualify.



UserIds

If no IDs are specified, messages from all user IDs qualify.



 


EJBComponent

An Enterprise Java Bean or EJB performs business transactions between the client and the database.This element in the configuration file lets you modify settings that affect EJBs.

Attribute

Description

Range of Values and Default

Console Navigation

Application

The name of the application this component is a part of. This is guaranteed to never be null.


Deployments: Application: Name

DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one. This attribute is especially useful for EJBs, in which one EJB may depend on another to be deployed first.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

Default: 1000


ExtraRmicOptions

The extra options passed to RMIC during server-side generation. The default value for this attribute must be null. If no instances of ExtraRmicOption are specified on the EJB Component, the default from Server.ExtraRmicOptions is used.

Default: Null

Servers: servername: Configuration: Compilers: Extra rmic Options

JavaCompiler

The path to the Java compiler (such as "sj" or "javac") to use to compile EJBs.

If no Java Compiler is specified on the EJBComponent, the default from Server.JavaCompiler is used.

Pathname (absolute paths allowed)

Default: Null

Servers: servername: Configuration: Compilers: Java Compiler

JavaCompilerPostClassPath

The options to be appended to the Java compiler classpath for when compiling Java code.

Pathname (absolute paths allowed)

Default: Null

Servers: servername: Configuration: Compilers: Append to classpath

JavaCompilerPreClassPath

The options to be prepend to the Java compiler classpath when compiling Java code.

Pathname (absolute paths allowed)

Default: Null

Servers: servername: Configuration: Compilers: Prepend to classpath

KeepGenerated

Returns true if the EJBC should keep its generated source files; returns false if EJBC should delete the source files after compiling them.

true or false

Default: true


Name

The name of the MBean. (Required.)

String

Default: N/A

Deployments: EJB: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


Targets

The targets on which this deployment is deployed.



TmpPath

The temporary directory where generated files are stored by EJBC.

Pathname (absolute paths allowed)

Default: tmp_ejb


URI

A Uniform Resource Identifier (URI) pointing to the application component, usually found on the Admin server.

(Required.)

Valid string

Deployments: EJB: URI

VerboseEJBDeploymentEnabled

If true, verbose deployment of EJBs is enabled which will print out error messages with a stack trace.

true or false

Default: false


 


EJBContainer

Specifies EJB container-wide settings. These settings also exist in EJBComponentMBean and Server MBean; the order of precedence is

  1. this specific EJBComponentMBean,

  2. EJBContainerMBean, then

  3. Server MBean.

Thus, if an attribute is specified in more than one element, the setting of the attribute in the element with the highest order of precedence will be effective.

Attribute

Description

Range of Values

Default Value

ExtraRmicOptions

Extra options passed to rmic during server-side generation. If no value for this attribute is specified on this specific EJBComponent, default is pulled from this attribute in the Server element.

String

Null.

JavaCompiler

Path to the Java compiler to use to compile EJB's (e.g. "sj" or "javac").

If no JavaCompiler is specified on this specific EJBComponent, default is pulled in order: first EJBContainer, then Server elements.

String

Null

JavaCompilerPostClassPath

Options to append to the Java compiler classpath when compiling Java code.

String

Null

JavaCompilerPreClassPath

Options to pre-pend to the Java compiler classpath when compiling Java code.

String

Null

KeepGenerated

True if EJBContainer should keep its generated source files; false if it should delete them after compiling them.

true or false

true

TmpPath

Temporary directory where generated files are stored by EJBContainer.

Valid directory name

tmp_ejb

VerboseEJBDeploymentEnabled

Retrieves status of this value; if true, verbose feature of EJB's is enabled; otherwise returns "false".

true or false

false

 


ExecuteQueue

This MBean is used to configure an execute queue and its associated thread pool.

Attribute

Description

Range of Values and Default

Console Navigation

Name

The name of the default execute queue.



Notes

Optional user-supplied information about this configuration MBean.

String


ThreadCount

Returns the number of threads assigned to this queue.

Integer

Default: 15


 


FileRealm

This element holds the FileRealm's configuration properties. This MBean is associated with a RealmMBean.

Attribute

Description

Range of Value and Default

Console Navigation

MaxACLs

The maximum number of (positive) ACLs supported by the FileRealm. The maximum is not enforced, by a warning is issued when you reach it.

1-10000

Default: 1000

Security: Filerealm: Max ACLs

MaxGroups

The maximum number of groups supported by the FileRealm.

Default: 1000

Security: Filerealm: Max Groups

MaxUsers

The maximum number of users supported by the FileRealm.

Default: 1000

Security: Filerealm: Max Users

Name

The name of the MBean. (Required.)

String

Default: FileRealmMBean


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


 


FileT3

A File T3 configuration entry.

Attribute

Description

Range of Values and Default

Console Navigation

DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

Default: 1000


Name

The name of the MBean. (Required.)

String

Default: N/A

Services: FileT3: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


Path

The File T3 path.

Pathname (absolute paths allowed)

Services: FileT3: Path

Targets

The targets on which this deployment is deployed.



 


JDBCConnectionPool

This element defines a JDBC connection pool.

Attribute

Description

Range of Values and Default

Console Navigation

ACLName

Sets the ACL used to control access to this Connection Pool. Permissions available to this ACL are reserve and admin.

  • "Reserve" allows users to get logical connections from this Connection Pool.

  • "Admin" allows all other operations on this Connection Pool, including: reset, shrink, shutdown, disable, and enable. Lack of an ACL allows any user open access (provided that user passes other WebLogic Server security controls).



CapacityIncrement

The increment by which the pool capacity is expanded. When there are no more available physical connections to service requests, the pool will create this number of additional physical database connections and add them to the pool. The pool will ensure that it does not exceed the maximum number of physical connections as set by MaxCapacity.

0 to n

Default: 1

Services: JDBC: Connection Pools: Capacity Increment

ConnLeakProfilingEnabled

This property enables JDBC Connection leak profiling. A Connection leak occurs when a connection from the pool is not closed explicitly by calling close() on that connection.

When connection leak profiling is active, the pool will store the stack trace at the time the Connection object is allocated from the pool and given to the client. When a connection leak is detected (when the Connection object is garbage collected), this stack trace is reported.

Note: This feature uses extra resources and will likely slow down Connection Pool operations, so it is not recommended for production use.

true or false

Default: false


DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

Default: 1000


DriverName

The string containing the name of the JDBC driver class. This is the full package name of the JDBC two-tier driver class used to create the physical connections between the WebLogic Server and the DMBS for this connection pool. It must be the name of a c lass that implements the java.sql.Driver interface. Check the documentation for the JDBC driver to find the full path name.


Services: JDBC: Connection Pools: Driver Name

InitialCapacity

The number of physical database connections to create when configuring the pool. If unable to create this number of connections, creation of this Connection Pool will fail. This is also the minimum number of physical connections that the pool keeps available.

0 to n

Default: 1

Services: JDBC: Connection Pools: Initial Capacity

LoginDelaySeconds

The number of seconds to delay before creating each physical database connection, both during initial pool creation and during the lifetime of the pool. Some database servers cannot handle multiple requests for connections in rapid succession; therefore, this property allows you to build in a small delay to let the database server catch up.

Integer in seconds

Default: 0


MaxCapacity

This attribute sets maximum number of physical database connections that this connection pool can contain. Different JDBC drivers and database servers will likely limit the number of possible physical connections.

1 to n

Default: 1

Services: JDBC: Connection Pools: Max Capacity

Name

The name of the connection pool. (Required.)

Alphanumeric string, up to 256 characters, but may not contain commas or spaces.

Default: Null

Services: JDBC: Connection Pools: Name

Notes

A space for optional, user-supplied information.

Alphanumeric string.

Default: Null


Password

This value overrides any password defined in Properties (as a name/value pair). This attribute is passed to the two-tier JDBC driver when creating physical database connections. It is stored in an encrypted form in the config.xml file and can be used to avoid storing cleartext passwords in that file.



Properties

The list of the properties passed to this JDBC driver.



RefreshMinutes

This attribute sets the connection refresh interval. Every unused connection is tested using TestTableName. Connections that do not pass the test are closed and reopened in an attempt to reestablish a valid physical database connection. If TestTableName is not set then the test is not performed.

0-35791394, in minutes.

Default: 0


ShrinkingEnabled

Set to true to enable pool shrinking. Indicates whether or not the pool can shrink back to the value of InitialCapacity when connections are detected to not be in use.

true or false

Default: true


ShrinkPeriodMinutes

This attribute sets the number of minutes to wait before shrinking a connection pool that has incrementally increased to meet demand. ShrinkingEnabled must be true for shrinking to take place.

1-n, in minutes.

Default: 15


SupportsLocalTransaction

This attribute applies to XA connection pools only, and is ignored for non-XA driver. It is true if XA driver supports SQL with no global transaction.

true or false

Default: false


Targets

This attribute sets the target servers for this deployment

String

Default: [Lweblogic.management.configuration.TargetMBean;@2c84d9



TestConnectionsOnRelease

This attribute is used to determine if connections that are being released are tested. If true, the WebLogic Server tests a connection before returning it to the connection pool. If all connections in the pool are already in use and a client is waiting for a connection, the client's wait is slightly longer while the connection is tested.

true or false

Default: false


TestConnectionsOnReserve

This is attribute is used to determines if the connections on reserve are to be tested. When set to true, the WebLogic Server tests a connection before giving it to the client. The test adds a small delay in serving the client's request for a connection from the pool, but ensures that the client receives a working connection (assuming that the DBMS is available and accessible).

true or false

Default: false


TestTableName

This attribute sets the name of the table used when testing a physical database connection. The default SQL used to test a connection is "select count" from TestTableName. TestTableName must exist and be accessible to the database user for the connection. Most database servers optimize this SQL to avoid a table scan, but it is still a good idea to set TestTableName to the name of a table that is known to have few rows, or even no rows.

If TestTableName begins with "SQL", the rest of the string, after that leading token, is taken as a literal SQL statement used to test a connection.

String

Default: Null


URL

The URL for the database, as specified in the JDBC driver documentation. The URL is passed to the driver to create the physical database connections.


Services: JDBC: Connection Pools: URL

 


JDBCDataSource

Defines attributes for a data source.

Attribute

Description

Range of Values and Default

Console Navigation

DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

Default: 1000


JNDIName

Sets the JNDI name associated with the data source. Sets the JNDI path to where this DataSource is bound.

String

Default: Null

Services: JDBC: Data Sources: JNDI Name

Name

The name of the data source. (Required.) May be up to 256 characters, but may not contain commas or spaces.

Alphanumeric string

Default: Null

Services: JDBC: Data Sources: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


PoolName

Name of the JDBC connection pool that is associated with this DataSource. DataSource returns a connection from the associated connection pool.

String

Default: Null

Services: JDBC: Data Sources: Pool Name

Row Prefetch Enabled

Set to true to enable row prefetching between client and WebLogic Server for each ResultSet. When an external client does JDBC access through Weblogic Server, row prefetching improves performance by fetching multiple rows from the server to the client in one server access. The WebLogic Server ignores this setting and does not use row prefetching when the client and WebLogic Server are in the same JVM.

true or false

Default: false

Services: JDBC: Data Sources: Row Fetch Enabled

RowPrefetchSize

The number of rows that are prefetched between client and WebLogic Server for each ResultSet. The optimal value is very dependent on the particulars of the query. Generally, increasing this number increases performance, until a particular value is reached. At that point further increases do not result in any significant performance increase. Very rarely will increased performance result from exceeding 100 rows. The default value should be reasonable for most situations.

2-65536

Default: 48


StreamChunkSize

The number of rows that will be prefetched between client and WebLogic Server for each ResultSet.

The optimal value is very dependent on the particulars of the query. Generally, increasing this number will increase performance, until a particular value is reached. At that point further increases do not result in any significant performance increase.

Very rarely will increased performance result from exceeding 100 rows. The default value should be reasonable for most situations.

1 to 65,536

Default: 256

Services: JDBC: Data Sources: Stream Chunk Size

Targets

Targets for this datasource.

List

Default: Null


 


JDBCMultiPool

A MultiPool is a "pool of pools" that allows a configurable algorithm (either high-availability or load-balancing) for choosing among its list of pools, the pool that will be selected to provide the connection. MultiPools do not apply to multiple-server configurations.

Attribute

Description

Range of Values and Default

Console Navigation

ACLName

The ACL list for this meta-pool.



AlgorithmType

Select one of these two algorithms:

  • High Availability

  • Load Balancing


In "High-Availability", the connection pools are set up as an ordered list used in order. Every time the Multipool is asked for a connection, it tries to get a connection from the first pool in its list. If unable to get a valid connection, it tries the next pool in its list. The process is repeated until a valid connection is obtained, or until the end of the list is reached, in which case an exception occurs. Note that the Multipool will only move to the next pool in the list when there is a real problem with the pool, for example the database is down or the pool disabled. For the cases where all connections are busy, the Multipool behaves as a single pool and an exception occurs.


In "Load-Balancing," the MultiPool distributes the connection requests evenly to its member pools.

High-Availability

Load-Balancing

Default: High-Availability

Services: JDBC: Multi Pools: Load Balance

also:

Services: JDBC: Multi Pools: High Availability

DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

Default: 1000


Name

The name of the JDBCMultipool.The name can be up to 256 alphanumeric characters, but may not contain commas or spaces

Alphanumeric string.

Default: Null

Services: JDBC: Multi Pools: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


Pool List

The list of connection pools in the multi pool

List

Services: JDBC: Multi Pools: Pool List

Targets

The targets on which this deployment is deployed.



 


JDBCTxDataSource

Defines attributes for a TX data source.

Attribute

Description

Range of Values and Default

Console Navigation

DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

Default: 1000


EnableTwoPhaseCommit

This attribute allows the user to enable or disable the two phase commitment of transactions. EnableTwoPhaseCommit allows non-XA JDBC drivers to pretend to participate in the JDBC connection as the only participant in the transaction, but it is asking for trouble to have more than one resource participating in a transaction where one of them (the JDBC driver) is pretending to be an XA resource. There is a possibility of heuristic failures in such a situation. EnableTwoPhaseCommit should be set to true only if you have no option (for example, no decent XA driver available for a particular database).

If this TxDataSource is associated with an XA connection pool, or if there is only one resource participating in the distributed transaction, then this setting is ignored.

true or false

Default: false

Services: JDBC: Tx Data Sources: Enable Two Phase Commit

JNDIName

Sets the JNDI path to where this TxDataSource is bound. Applications that look up the JNDI path get a javax.sql.DataSource instance that corresponds to this TxDataSource. Note that the old style usage of DriverManager.getConnection() or Driver.Connect() has been deprecated in favor of looking up a datasource to obtain a connection.

Valid JNDI name

Default Null

Services: JDBC: Tx Data Sources: JNDI Name

Name

The name of this data source.

String

Services: JDBC: Tx Data Sources: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


PoolName

This attribute allows the user to set the name of the connection pool that is associated with this TxDataSource. Calls to getConnection() on this TxDataSource return a connection from the associated connection pool.

Valid connection pool name

Default: Null

Services: JDBC: Tx Data Sources: Pool Name

RowPrefetchEnabled

Set to True to enable row prefetching between client and WebLogic Server for each ResultSet. When an external client does JDBC access through WebLogic Server, row prefetching improves performance by fetching multiple rows from the server to the client in one server access. The WebLogic Server ignores this setting and does not use row prefetching when the client and WebLogic Server are in the same JVM.

true or false

Default: false

Services: JDBC: Tx Data Sources: Row Prefetch Enabled

RowPrefetchSize

The number of rows that are prefetched between client and WebLogic Server for each ResultSet. The optimal value is very dependent on the particulars of the query. Generally, increasing this number increases performance, until a particular value is reached. At that point further increases do not result in any significant performance increase. Very rarely will increased performance result from exceeding 100 rows. The default value should be reasonable for most situations.

2-65536

Default: 48


StreamChunkSize

Determines the data chunk size for streaming data types. Streaming data types (for example, resulting from a call to getBinaryStream()) are pulled in Stream Chunk Size-sized chunks from the WebLogic Server to the client as needed.

1-65,536

Default: 256

Stream Chunk Size

Targets

This attribute allows the user to select the servers (or clusters) to be used as targets for this datasource.

List

Default Null


 


JMSConnectionConsumer

The MBean defines a connection consumer.

Attribute

Description

Range of Values and Default

Console Navigation

Destination

The JNDI name of the destination for this connection consumer.

String


MessagesMaximum

The maximum number of messages that the connection consumer may load at one time into a ServerSession's session.

-1, n

n = 1 through 263 -1

Default: -1


Name

The name of the MBean. (Required.)

String

Default: JMSConnectionConsumerMBean


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


Selector

The defined selector of the connection consumer.

String

Default: Null


 


JMSConnectionFactory

This element represents a JMS Connection Factory.

Attribute

Description

Range of Values and Default

Console Navigation

AcknowledgePolicy

The value of the Acknowledge Policy attribute for the connection factory. This attribute works around a change in the JMS specification.

The value of:

  • All—causes all messages to be acknowledged.

  • Previous—causes previously received messages to be acknowledged.

Note: Defaulting to "All" represents a change from all versions of JMS prior to release 6.1 of WebLogic Server. The former default was "Previous". For more information about this feature, refer to "Migrating WebLogic JMS Applications" in Programming WebLogic JMS.

Previous

All

Default: All


AllowCloseInOnMessage

The allowCloseInOnMessage attribute for the connection factory. Setting the value to true allows you to issue a stop() method and a close() method from within its onMessage() method call, without hanging.

true or false.

Default: false


ClientId

The client ID for a durable subscriber that uses this connection factory.

String

Default: N/A

Services: JMS: Connection Factories: Client ID

DefaultDeliveryMode

Defines the default delivery mode for the connection factory. All messages with a deliveryMode of null that are produced on a connection created with this factory receive this value.

Persistent

Non-Persistent

Default: Persistent


DefaultPriority

Defines the default priority value for the connection factory. All messages with a priority of -1 that are produced on a connection created with this factory receive this value.

0-9

Default: 4

Services: JMS: Connection Factories: Default Priority

DefaultRedeliveryDelay

Defines the default delay, in milliseconds, before rolled-back or recovered messages are redelivered.

0-n

n=263 -1

Default: 0

Services: JMS: Connection Factories: Default Redelivery Delay

DefaultTime to Deliver

Defines the default delay, in milliseconds, between when a message is produced and when it is made visible on its destination.

0-n

n=263 -1

Default: 0


DefaultTimeToLive

Defines the default delay, in milliseconds, between when a message is produced and when it is made visible on its destination. All messages with a time-to-live value of -1 that are produced on a connection created with this factory receive this value.

0-n

n=263 -1

Default: 0

Services: JMS: Connection Factories: Default Time to Live

DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

Default: 1000


JNDIName

The JNDI name of the JMS ConnectionFactory. This is the name that is assigned to and used to look up the connection factory within the JNDI namespace.


String or null

Services: JMS: Connection Factories: JNDI Name

MessagesMaximum

The maximum number of messages that may exist for an asynchronous session and that have not yet been passed to the message listener. A value of -1 means that there is no limit.

-1, 0- n

n=231 -1

Default: 10


Name

The name of the MBean and of the JMSConnectionFactory. (Required.)

String

Default: N/A

Services: JMS: Connection Factories: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


OverrunPolicy

The value of the message overrun policy for the connection factory. This applies to multicast messages. When the number of outstanding messages reaches the Messages Maximum attribute value, messages are discarded based on the specified policy.

If set to KeepNew, the most recent messages are given priority over the oldest messages, and the oldest messages are discarded, as needed.

If set to KeepOld, the oldest messages are given priority over the most recent messages, and the most recent messages are discarded, as needed.

Message age is defined by the order of receipt, not by the JMSTimestamp value.

KeepNew

KeepOld

Default: KeepOld


Targets

Provides a list of potential targets. When a JMS client creates a connection, it will connect to one of these targets, using this factory.

TargetMBean[]

Default: No targets are chosen


TransactionTimeout

The value of the transaction timeout for the connection factory, as expressed in seconds.

0-n

n=231 -1

Default: 3600


UserTransactionsEnabled

Indicates whether or not a connection factory creates sessions that are JTA aware. If set to "true", the associated message producers and message consumers look into the running thread for a transaction context. However, if the XAConnectionFactoryEnabled attribute is enabled, the UserTransactionsEnabled attribute is ignored (since it is always considered true).

Note: Transacted sessions ignore the current threads transaction context in favor of their own internal transaction, regardless of the setting. This setting only affects non-transacted sessions.

true or false

Default: false


XAConnectionFactoryEnabled

The XAConnectionFactoryEnabled attribute for the connection factory. If true, an XAConnection Factory is returned instead of a ConnectionFactory.

true or false

Default: false


 


JMSDestCommon

This element does not actually appear in the config.xml file. The user cannot modify it. However, it is a store for attributes for other JMS elements. The attributes in this element are common to the following other JMS elements: JMSDestination, JMSQueue, JMSTemplate and JMSTopic. They inherit the following attributes from JMSDestCommon element.

Attribute

Description

Range of Values and Default

Console Navigation

BytesMaximum

This is the maximum number of bytes that may be stored in the destination at any one time. A value of -1 specifies that there is no limit.

-1, or n

n = 0 through 263 -1
BytesThresholdHigh

Default: -1

Services: JMS Template: Bytes Maximum

BytesThresholdHigh

The value of bytesThresholdHigh. If there is no threshold condition and the number of bytes stored in the destination exceeds this value, then the condition is set and a log message is generated. A value of -1 specifies that threshold log messages are disabled.

-1, or n

n = 0 through 263 -1

BytesMaximum

and

> BytesThresholdLow

Default: -1

Services: JMS Template: Bytes Threshold High

BytesThresholdLow

The value of bytesThresholdLow. If there is a threshold condition and the number of bytes stored in the destination drops below this value, then the condition is cleared and a log message is generated. A value of -1 specifies that threshold log messages are disabled.

-1, or n

n = 0 through 263 -1
<BytesThresholdHigh

Default: -1

Services: JMS Template: Bytes Threshold Low

DeliveryModeOverride

Defines the delivery mode assigned to all messages that arrive at the destination regardless of the delivery mode specified by the producer. The default value of "No-Delivery" means that there is no override.

The default value of "No-delivery", means that there is no override.

Persistent

Non-Persistent

No-Delivery

Default: No-Delivery

Services: JMS Template: Delivery Mode Override

DestinationKey

An array of the destination keys for sorting the destination, ordered from most significant to least significant. A key that is based on JMSMessageID can only be the last key.

Note: If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and set as "Ascending" (First In, First Out [FIFO]) for the sort order.

JMSDestinationKeyMBean[] values

Default: N/A


ErrorDestination

A JMSDestinationMBean for the error destination for messages that have reached their redelivery limit. If the error destination is null, such messages are simply deleted.

JMSDestinationMBean[]

Default: Null


MessagesMaximum

The maximum number of messages that can be stored in the destination at any one time. A value of -1 means that there is no limit.

-1 or n

n=0 through 263 -1
MessagesThresholdHigh

Default: -1

Services: JMS Template: Messages Maximum

MessagesThresholdHigh

The upper threshold that triggers log messages based on the number of messages stored in the destination. A value of -1 specifies that threshold log messages are disabled.

-1 or n

n=0 through 263 -1
MessagesMaximum

>MessagesThresholdLow

Default: -1

Services: JMS Template: Messages Threshold High

MessagesThresholdLow

If there is a threshold condition and the number of messages stored in the destination drops below this value, then the condition is cleared and a log message is generated. A value of -1 specifies that threshold log messages are disabled.

-1 or n

n=0 through 263 -1
<MessagesThresholdHigh

Services: JMS Template: Messages Threshold Low

Name

The name of the MBean. (Required.)

String

Default: N/A


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


PriorityOverride

The priority assigned to all messages that arrive at the destination regardless of the priority specified by the message producer. The default value of -1 means that there is no override.

-1 or n

n = 0 through 9

Default: -1

Services: JMS Template: Priority Override

RedeliveryDelayOverride

Defines the delay, in milliseconds, before rolled back or recovered messages are redelivered, regardless of the redelivery-delay specified by the consumer and/or connection factory. The default value of -1 means that there is no override.

-1 or n

n=0 through 263 -1

Default: -1


RedeliveryLimit

The number of redelivery tries a message can have before it is placed in the error destination. If this limit is reached and no error destination is configured, or the quota for the error destination would be exceeded, then the message is simply deleted.

A value of -1 means that there is no limit.

-1 or n

n=0 through 231 -1

Default: -1


TimeToDeliverOverride

The delay, in milliseconds, before a produced message is made visible on its target destination, regardless of the time-to-deliver specified by the producer and/or connection factory. The default value of -1 means that there is no override. For more information about implementing time-to-deliver values, see Programming WebLogic JMS.

A long integer -1.

Default: -1


TimeToLiveOverride

The time-to-live assigned to all messages that arrive at the destination, regardless of the time-to-live specified by the producer. The default value of -1 means that there is no override.

-1 or n

n=0 through 263 -1

Default: -1

Services: JMS Template: Time To Live Override

 


JMSDestination

This element does not actually appear in the file "config.xml". The user cannot modify it. However, it is a store for attributes for other JMS elements. This element represents a JMS destination, which can be either a queue or a topic. JMSDestination inherits attributes from JMSDestCommon. The JMSQueue and JMSTopic elements inherit attributes from JMSDestination.

Attribute

Description

Range of Values

Default Value

JNDIName

The JNDI name of the destination. This value is the name used to look up the destination within the JNDI namespace. If not specified, the destination name is not advertised through the JNDI namespace.

String

Null

Name

The name of the MBean. (Required.)

String

N/A

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Null

StoreEnabled

A string specifying whether or not the destination uses the backing store specified by the JMS server.

If the value is:

  • true, but no backing store is defined—the configuration fails to boot.

  • false—the destination does not support persistent messages (i.e. they are downgraded to non-persistent).

  • default—the destination uses the backing store, if one is defined.

true

false

default

default

Template

The template from which the destination is derived. If this attribute is not defined, the attributes for the destination must be specified as part of the destination.

Note: Attributes that are set to their default values inherit their destination values from the template at runtime.

JMSTemplateMBean[]

N/A

 


JMSDestinationKey

This element represents a key that is used for sorting a destination.

Attribute

Description

Range of Values and Default

Console Navigation

Direction

The direction in which to sort for this key. Choosing "Ascending" for JMSMessageID implies a first-in, first-out (FIFO) sort order (the default for destinations). To use a last-in, first-out (LIFO) sort order, set the value to "Descending".

Ascending

Descending

Default: Ascending

Services: JMS: Destination Keys: Direction

KeyType

The expected property type for this key.

Boolean

Byte

Short

Int

Long

Float

Double

String

Default: String

Services: JMS: Destination Keys: Key Type

Name

The name of the MBean and of the key. (Required.)

String

Default: N/A

Services: JMS: Destination Keys: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


Property

The property name for this key. This value indicates a message property name on which to sort. Message header fields that can be sorted on are:

  • JMSCorrelationID

  • JMSDeliveryTime

  • JMSExpiration

  • JMSMessageID

  • JMSPriority

  • JMSRedelivered

  • JMSTimestamp

  • JMSType

Message header field keys ignore the key type and reference message header fields rather than message properties.

To improve performance, it is recommended to use message header fields as sorting keys, rather than message properties.

String

Default: N/A

Services: JMS: Destination Keys: Property

 


JMSFileStore

This element represents a JMS file-based backing store. It extends JMSStoreMBean. A store may be associated with only one JMS server.

Attribute

Description

Range of Values

Default Value

Directory

The directory within which the file-based backing store exists.

String

N/A

Name

The name of the MBean and of the file store (or stores). This name is used as a prefix for names of the store files.

String

N/A

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Null

 


JMSJDBCStore

This element represents a JMS JDBC-based backing store. It extends the JMStore MBean. A store may be associated with only one JMS server. A store may be associated with only one JMS server

Attribute

Description

Range of Values

Default Value

ConnectionPool

The JDBC Connection Pool for this backing store.

JDBCConnectionPoolMBean[]

N/A

Name

The name of the MBean and of the store.

String

N/A

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Null

PrefixName

The prefix name of JMS tables in this backing store. Specifying unique prefixes allows multiple stores to exist in the same database.

The format of this string is as follows:

[schema.[catalog.]]prefix

Note: No two JMS stores should be allowed to use the same database tables, as this results in corruption.

String

N/A

 


JMSQueue

The element represents a JMS queue. Refer to JMSDestCommon to view these inherited element attributes: BytesMaximum, BytesThesholdLow, DeliveryModeOverride, Destinations, ErrorDestination, JNDIName, MessagesMaximum, MessagesThresholdHigh, MessagesThresholdLow, RedeliveryDelayOverride, StoreEnabled, Template, and TimeToLiveOverride.

 


JMSServer

This element represents a JMS server.

Attribute

Description

Range of Values and Default

Console Navigation

BytesMaximum

The maximum number of bytes that can be stored in the JMS Server at any one time. A value of -1 means that there is no limit.

Range of values: -1 or n

n= 0 through 263 - 1
Bytes Threshold High

Default: -1

Services: JMS: Servers: Bytes Maximum

BytesThresholdHigh

The upper threshold that triggers log messages based on the number of bytes stored in the JMS server. A value of -1 specifies that threshold log messages are disabled.

Range of values: -1 or n

n= 0 through 263 - 1
Bytes Maximum
> Bytes Threshold Low

Default: -1


BytesThresholdLow

If there is a threshold condition and the number of bytes stored in the JMS Server drops below this value, then the condition is cleared and a log message is generated. A value of -1 specifies that threshold log messages are disabled.

Range of values: -1 or n

n= 0 through 263 - 1
< Bytes Threshold High

Default: -1


DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

Default: 1000


Destinations

An array of destinations that are targeted to the JMS server.

JMSDestinationMBean[]

Default: N/A


MessagesMaximum

The maximum number of messages that may be stored in the JMS server at any one time. A value of -1 means that there is no limit.

Range of values: -1 or n

n= 0 through 263 - 1
Messages Threshold High

Default: -1

Services: JMS: Servers: Messages Maximum

MessagesThresholdHigh

The value of MessagesThresholdHigh. If there is no threshold condition and the number of messages stored in the JMS Server exceeds this value, then the condition is set and a log message is generated. A value of -1 specifies that threshold log messages are disabled.

-1 or n

n= 0 through 263 - 1
Messages Maximum
> Messages Threshold Low

Default: -1


MessagesThresholdLow

The value of MessagesThresholdLow. If there is a threshold condition and the number of messages stored in the JMS Server drops below this value, then the condition is cleared and a log message is generated. A value of -1 specifies that threshold log messages are disabled.

-1or n

n= 0 through 263 - 1
< Messages Threshold High

Default: -1


Name

The name of the MBean and of the JMS server.

String

Default: N/A

Services: JMS: Servers: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


SessionPools

An array of session pools defined for the JMS server.

JMSSesssionPoolMBean[]

Default: N/A


Store

The MBean for an existing backing store for the JMS server. A persistent store may only be used by one JMS server.

If no store is set, then the JMS server cannot support persistent messages or durable subscribers.

JMSStoreMBean or null

Default: Null

Services: JMS: Servers: Store

Targets

Provides a list of potential targets. Currently, a JMS server can have a maximum of one target.

TargetMBean[]

Default: No targets are chosen


TemporaryTemplate

The MBean for an existing temporary template that is used to create all temporary destinations on this JMS Server. The attributes for the temporary destinations are derived from the template. If no temporary template is defined for the JMS server, then temporary destinations cannot be created on the JMS server.

JMSTemplateMBean[] or null

Default: Null

Services: JMS: Servers: Temporary Template

 


JMSSessionPool

This MBean represents a JMS session pool.

Attribute

Description

Range of Values

Default Value

AcknowledgeMode

The acknowledge mode used by non-transacted sessions within a session pool.

For transacted sessions, messages are acknowledged automatically when the session is committed, and this field is ignored.

Auto

Client

Dups-Ok

None

Auto

ConnectionConsumers

An array of connection consumers for the session pool.

JMSConnectionConsumerMBean[]

N/A

ConnectionFactory

The JNDI name of the connection factory used by the session pool.

String

Null

ListenerClass

The listener class of the SessionPool.

String


Name

The name of the MBean. (Required.)

String

N/A

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Null

SessionsMaximum

The maximum number of sessions allowed for the SessionPool. This value is the number of concurrent sessions in the session pool.

A value of -1 indicates that there is no maximum.

This attribute is dynamic.

-1 or n

n=1 through 263 -1

-1

Transacted

Whether or not the session pool creates transacted sessions.

true or false

false

 


JMSStore

This element does not actually appear in the file "config.xml". The user cannot modify it. However, it is a store for attributes for other JMS elements. This element represents a JMS backing store, which is a physical repository for storing persistent data. JMSFileStore and JMSJDBCStore elements are dependent on JMSStoreMBean.

Attribute

Description

Range of Values

Default Value

JMSServer

The JMS Server for this store.

JMSServerMBean[]

N/A

Name

The name of the MBean and of the JMSStore.

String

N/A

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Null

 


JMSTemplate

Represents a list of JMS templates. Refer to JMSDestCommon element to view the inherited element attributes: BytesMaximum, BytesThesholdLow, DeliveryModeOverride, Destinations, ErrorDestination, JNDIName, MessagesMaximum, MessagesThresholdHigh, MessagesThresholdLow, RedeliveryDelayOverride, StoreEnabled, Template, and TimeToLiveOverride.

Attribute

Description

Range of Values

Default Value

Destinations

An array of JMSDestinationMBean values for destinations that depend on this template.

JMSDestinationMBean[]

N/A

 


JMSTopic

A type of JMS Destination.This MBean also inherits these attributes from JMSDestCommon: BytesMaximum, BytesThesholdLow, DeliveryModeOverride, Destinations, ErrorDestination, JNDIName, MessagesMaximum, MessagesThresholdHigh, MessagesThresholdLow, RedeliveryDelayOverride, StoreEnabled, Template, and TimeToLiveOverride.

Attribute

Description

Range of Values

Default Value

MulticastAddress

The multicast address used by the destination. A well-formed IP address used to transmit messages to multicast consumers.

A well-formed IP address.


MulticastPort

The multicast port for the destination. This value is the IP port used to transmit messages to multicast consumers.

1-65535

6001

MulticastTTL

The number of network hops that a multicast message is allowed to travel. The value is the "Time-to-Live" value used for multicasting, specifying the number of routers that the message can traverse en route to the consumers.

A value of 1 indicates that the message will not traverse any routers, and is limited to one subnet.

This value is independent of the JMSExpirationTime value.

This attribute is not dynamically configurable.

0-255 inclusive.

1

Name

The name of the MBean. (Required.)

String

N/A

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Null

 


JoltConnectionPool

This element defines a Jolt connection pool.

Attribute

Description

Range of Values and Default

Console Navigation

ApplicationPassword




DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

Default: 1000


FailoverAddresses

The list of failover JSL addresses.


Services: Jolt: Failover Addresses

MaximumPoolSize


Default: 1


MinimumPoolSize

Initial number of JCP connections.

Default: 0


Name

The name of the MBean. (Required.)

String

Default: N/A


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


PrimaryAddresses

The list of primary JSL addresses.


Services: Jolt: Primary Addresses

RecvTimeout


Default: 0


SecurityContextEnabled


true or false

Default: false

Services: Jolt: Security Context Enabled

Targets

The targets on which this deployment is deployed.



UserName




UserPassword

Password for the username user.



UserRole




 


JTA

This element provides access to the JTA configuration attributes. The attributes defined herein are applicable for JTA configuration at the domain level.

Attribute

Description

Range of Values and Default

Console Navigation

AbandonTimeoutSeconds

The transaction abandon timeout in seconds.

Integer, in seconds

Default: 86400

Services: JTA: Abandon Timeout Seconds

BeforeCompletionIterationLimit

The maximum number of cycles the transaction manager will perform the beforeCompletion synchronization callback among registered objects.

Integer

Default: 10

Services: JTA: Before Completion Iteration Limit

ForgetHeuristics

Indicates whether the transaction manager will automatically perform an XAResource forget operation for transaction heuristic completions.

true or false

Default: true

Services: JTA: Forget Heuristics

MaxTransactions

The maximum number of simultaneous in progress transactions allowed on a server.

Integer

Default: 10000

Services: JTA: Max Transactions

MaxUniqueNameStatistics

The maximum number of unique transaction names for which statistics will be maintained.

Integer

Default: 1000

Services: JTA: Max Unique Name Statistics

Name

The name of the MBean. (Required.)

String

Default: N/A


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


TimeoutSeconds

The transaction timeout in seconds.

Integer

Default: 30

Services: JTA: Timeout Seconds

 


LDAPRealm

This MBean holds the LDAPRealm's configuration properties. It is associated with a CachingRealmMBean.

Attribute

Description

Range of Values

Console Navigation

AuthProtocol

Defines the type of authentication used to authenticate the LDAP server. Set this attribute to one of the following:

  • None for no authentication

  • Simple for password authentication

  • CRAM-MD5 for certificate authentication

none

simple

CRAM-MD5

Default: none


Credential

The password that authenticates the LDAP user defined in the Principal attribute. This password is encrypted automatically.

Default: Null


GroupDN

The list of attributes that, when combined with the GroupNameAttribute attribute, uniquely identifies a Group in the LDAP directory.

When specifying this attribute, use the following format:

ou=Group, u=acme.com



GroupIsContext

Specifies how group membership is recorded in the LDAP directory. Set to true if each group entry contains one user. Set to false if there is one group entry containing an attribute for each group member.

true or false

Default: true


GroupNameAttribute

The name of a group in the LDAP directory. It is usually the common name.

Default: cn


GroupUsernameAttribute

Set this property to the name of the attribute that contains a group member in a group entry.


member

LdapProvider

The name of the class that implements an LDAP directory server. This attribute allows you to use an LDAP directory server other than the one supplied by Sun Microsystems. WebLogic Server supports the following LDAP directory servers:

  • Open LDAP

  • Netscape iPlanet

  • Microsoft Site Server

  • Novell NDS


com.sun.jndi.ldap.LdapCtxFactory

LDAPURL

The location of the LDAP server. Change the URL to the name of the computer on which the LDAP server is running and the number of the port at which the LDAP server is listening. If you want WebLogic Server to connect to the LDAP server using the SSL protocol, use the LDAP server's SSL port in the URL.


ldap://ldapserver:389

Name

The name of the MBean for the LDAP security realm attributes. (Required.)

String

LDAPRealmMBean

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Null

Principal

The distinguished name of the LDAP user that WebLogic Server uses to connect to the LDAP server. This user must be able to list LDAP users and groups.


Null

RealmClassName

The name of the Java class that implements the LDAP Security realm. This class should be included in the CLASSPATH of WebLogic Server.


Security: Realms: Realm Class Name

SSLEnable

Enables the use of the SSL protocol to protect communications between the LDAP server and WebLogic Server. Keep in mind the following guidelines:

  • Disable this attribute if the LDAP server is not configured to use the SSL protocol.

  • If you set the UserAuthentication attribute to external, this field must be enabled.

true or false

false

UserAuthentication

Determines the method for allowing or denying a user the right to communicate. Set this attribute to one of the following values:

  • Bind— specifies that the LDAP Security realm retrieves user data, including the password for the LDAP server, and checks the password in WebLogic Server.

  • External—specifies that the LDAP Security realm authenticates a User by attempting to bind to the LDAP server with the username and password supplied by the WebLogic Server client. If you choose the External value, you must also use the SSL protocol.

  • Local—specifies that the LDAP Security realm authenticates a User by looking up the UserPassword property in LDAP directory and checking its value against a set of passwords in WebLogic Server.

bind

external

local

bind

UserDN

A list of attributes that, when combined with the attributes in the UserNameAttribute attribute uniquely identifies a user in the LDAP directory.

When specifying this attribute, use the following format:

ou=Barb.Klock, u=acme.com



UserNameAttribute

The login name of a user for the LDAP directory. The value of this attribute can be the common name of user in the LDAP directory but usually it is an abbreviated string, such as the User ID.



UserPasswordAttribute

If the userAuthenticationProperty is set to "local", then this property is used to find out which property in the LDAP user objects contains the user's password.


userpassword

 


Log

Defines features of the log file.

Attribute

Description

Range of Values and Default

Console Navigation

FileCount


Default: 7


FileMinSize


Default: 500

Servers: servername: Logging: Rotation: File Min Size

FileName

The log file name. If the file path is not absolute, the path is assumed to be relative to the root directory of the machine on which the server is running.

Pathname and filename

Default: /config/domainname/logs/weblogic.log

Servers: servername: Logging: General: logfilename

FileTimeSpan


Default: 24

Servers: servername: Logging: Rotation: File Time Span

Name

The name of the MBean. (Required.)

String

Default: N/A


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


NumberOfFilesLimited


true or false

Default: false

Servers: servername: Logging: Rotation: Number of Files Limited

RotationType

The rotation type for this log file.

bySize, byTime, or none

Default: none

Servers: servername: Logging: Rotation: Rotation Type

 


Machine

This MBean represents a machine on which servers may be booted. A server is bound to a machine by calling to ServerMBean.setMachine(). Although it is typical that one MachineMBean refers to one physical machine and vice versa, it is possible to have a multi-homed machine represented by multiple MachineMBeans. The only restriction is that each MachineMBean be configured with non-overlapping addresses.

A configuration may contain one or more of MachineMBeans which may be looked up by their logical names.

Attribute

Description

Range of Values:

Default Value

Addresses

The addresses by which the machine is known.



Name

The name of the MBean.

String

N/A

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Null

StartdPort

The port number that the startd is configured to run on this machine.



 


MailSession

The MBean for a MailSession resource manager connection factory.

Attribute

Description

Range of Values and Default

Console Navigation

DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Default: 1000


JNDIName




Name

The name of the MBean. (Required.)

String

Default: MailSessionMBean

Services: Mail: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


Properties



Services: Mail: Properties

Targets

The targets on which this deployment is deployed.



 


MessagingBridge

This Mbean defines a Messaging Bridge.

Attribute

Description

Range of Values

Default Value

AsyncDisabled


true or false

false

DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

1000

DurabilityDisabled


true or false

false

ForwardingPolicy


Automatic

Manual

Scheduled

Automatic

MaximumIdleTimeMilliseconds



60

Name

The name of the MBean.

String

N/A

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Null

QOSDegradationAllowed


true or false

false

QualityOfService


Exactly-once

Atmost-once

Duplicate-okay

Exactly-once

ReconnectDelayIncrement



10000

ReconnectDelayInitialMilliseconds



50000

ReconnectDelayMaximumMilliseconds



500000

ScheduleTime




Selector




SourceDestination




TargetDestination




Targets




TransactionTimeoutSeconds



30

 


NodeManager

This MBean is used to represent a NodeManager that is associated with a machine.

Attribute

Description

Range of Values and Default

Console Navigation

Certificate


Default: config/mydomain/sslrsa.crt


CertificatePassword


Default: password


CertificateType


Default: RSA


ListenAddress


Default: localhost


ListenPort


Default: 5555


Logs




Name

The name of the MBean. (Required.)

String

Default: N/A


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null

Null

TrustedCertsFile


Default: config/mydomain/trusted.crt


 


NTRealm

This MBean holds the NT realm's configuration properties. This MBean is associated with CachingRealmMBean.

Attribute

Description

Range of Values

Default Value

Name

The name of the MBean for the WindowsNT SecurityRealm attributes. (Required.)

String

NTRealmMBean

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Null

PrimaryDomain

The host and port number of the Windows NT Primary Domain Controller where users and groups are defined for the domain. If entering multiple sets of host and port numbers, delimit them with commas. If the local computer (where the WebLogic Server executes) is the Primary Domain Controller, you can set the property to period (".").


Null

RealmClassName

The name of the Java class that implements the WindowsNT Security realm. This attribute is read-only.


Security: Realm: Realm Class Name

 


PasswordPolicy

Attribute

Description

Range of Values

Default Value

LockoutCacheSize

Specifies the intended cache size of unused, invalid login attempts.

1-99999

In bytes

Default: 5

Security: Passwords: Lockout Cache Size

LockoutDuration

Number of minutes that a user's account remains inaccessible after being locked in response to several invalid login attempts within the amount of time specified by LockoutRestDuration attribute. In order to unlock a user account, you must have the unlockuser permission for PasswordPolicy.

0-999999

In minutes

Default: 30

Security: Passwords: Lockout Duration

LockoutEnabled

Controls whether or not WebLogic Server tracks invalid login attempts and takes appropriate action.

true or false

Default: true

Security: Passwords: Lockout Enabled

LockoutGCThreshold

If the number of current invalid login attempts is equal to or greater than the value of this attribute, WebLogic Server deletes any expired records from the cache. The lower the value of this attribute, the more often WebLogic Server clears the cache which may impact the performance of WebLogic Server. Set the attribute accordingly.

0-99999

Default: 400


LockoutResetDuration

Number of minutes within which invalid login attempts must happen in order for the user's account to be locked.

An account is locked if the number of invalid login attempts defined in the Lockout Threshold attribute happens within the amount of time defined by this field. For example, if the value in this field is five minutes and three invalid login attempts are made within a six-minute interval, the account is not locked. However, if five invalid login attempts are made within a five-minute period, the account is locked.

1-99999 (minutes)

Default: 5

Security: Passwords: Lockout Reset Duration

LockoutThreshold

The number of failed logins for a user that can be tried before that account is locked. Any subsequent attempts to access the account (even if the username/password combination is correct) cause a Security exception, in which case, the account remains locked until it is explicitly unlocked by the system administrator or another login attempt is made after the lockout duration period ends. Note that invalid login attempts must be made within a span defined by the Lockout Reset Duration attribute to count toward the value of the LockoutThreshold attribute.

1-99999 (attempts)

Default: 5

Security: Passwords: Lockout Threshold

MinimumPasswordLength

The minimum number of characters in a password, domain-wide. Passwords must contain at least eight characters.

Integer 8 (characters)

Default: 8

Security: Passwords: Minimum Password Length

Name

The name of the MBean for the password policy attributes. (Required.)

String

Default: PasswordPolicyMBean


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


 


RDBMSRealm

This MBean holds the RDBMS realm's configuration properties. This MBean is associated with a CachingRealmMBean. The RDBMSRealms MBean is hard-coded and is part of the product while the rest of the RDBMSRealm is an example which customers are free to change. However, they must live within the configuration parameters of this MBean.

Attribute

Description

Range of Values

Default Value

DatabaseDriver

The Java class name for the database driver used with the RDBMS Security realm.

Default: COM.cloudscape.core.JDBCDriver


DatabasePassword

The password used to login into the database. The password is automatically encrypted.



DatabaseURL

The location of the database. Change the URL to the name of the computer on which the database is running and the number of the port at which the database is listening.

Default: jdbc:cloudscape


DatabaseUserName

Specifies a username used to login into the database.



Name

The name of the MBean for the RDBMS Security realm. (Required.)

String

Default: RDBMSRealmMBean


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


RealmClassName

The name of the Java class that implements the RDBMS Security realm. This class should be included in the CLASSPATH of WebLogic Server.

Default: examples.security.rdbmsrealm.RDBMSRealm

Security: Realm: Realm Class Name

SchemaProperties

Specifies the schema properties for manipulating the database.



 


Realm

This MBean represents the SecurityMBean's realm properties. It includes the following:

RealmMBean extends ConfigurationMBean. If any realm other than the FileRealm is used, it is specified by attaching it to a CachingRealmMBean, then attaching the CachingRealmMBean to the RealmMBean. If non-null, an alternate realm is to be used; if null, only the FileRealm is to be used.

Attribute

Description

Range of Values

Default Value

Name

The name of the MBean. (Required.)

String

Default: N/A


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


ResultsBatchSize

Specifies the batch size (number of users/groups/acls per rpc) for returning users/groups/acls. The purpose is to avoid having either have one rpc per user/group/acl or one very large rpc that causes overfill of memory.

0-n

Default: 200

Security: Advanced: Results Batch Size

 


Security

This MBean represents the security properties of an entire Domain.

Attribute

Description

Range of Value and Default

Console Navigation

AuditProviderClassName

The name of a Java class that implements an audit provider. The audit provider is an implementation of the weblogic.security.audit.
AuditProvider
interface.

Default: Null

Security: General: Audit Provider Class

GuestDisabled

Sets whether or not guest logins can be used to access WebLogic Server resources and services.

true or false

Default: true

Security: General: Guest Disabled

Name

The name of the MBean for the security properties. (Required.)

String

Default: SecurityMBean


Notes

Optional user-supplied information about the SecurityMBean.

Alphanumeric string

Default: Null


PasswordPolicy




Realm




SystemUser

The name of the system user. You must specify this attribute.

String

Default: system


 


Server

This class represents a WebLogic Server. A WebLogic Server is a Java process that is a container for J2EE applications.

Attribute

Description

Range of Values and Default

Console Navigation

AdministrationPort


Valid administration port

Default: 0

Servers: servername: Configuration: General: Administration Port

Cluster

The cluster to which this server belongs.


Servers: servername: Configuration: Cluster: Cluster

ClusterRuntime

Returns an Mbean containing runtime information about the cluster that was started from this configuration Mbean. Returns null if no such cluster exists.


Servers: servername:

ClusterWeight

The cluster weight (percent) for this server.

Integer

Default: 100

Servers: servername: Configuration: Cluster: Cluster Weight

DefaultIIOPPassword

The password for the default IIOP user.

Default: guest

Servers: servername: Configuration: Protocols: Default IIOP Password

DefaultIIOPUser

The default IIOP user.

Default: guest

Servers: servername: Configuration: Protocols: Default IIOP User

DefaultProtocol

The protocol to be used for connections when none is specified.

t3, t3s, http, https, or iiop

Default: t3

Servers: servername: Configuration: Protocols: Default Protocol

DefaultSecureProtocol

The protocol to be used for secure connections when none is specified.

t3s or https

Default: t3s

Servers: servername: Configuration: Protocols: Default Secure Protocol

DefaultTGIOPPassword


Default: guest

Servers: servername:

DefaultTGIOPUser


Default: guest

Servers: servername:

DomainLogFilter


Default: none

Servers: servername: Logging: Domain: Domain Log Filter

EnabledForDomainLog


true or false

Default: true

Servers: servername: Logging: Domain: Log to Domain Logfile

ExpectedToRun

Is this server expected to run if the domain is started?

true or false

Default: true

Servers: servername:

ExtraRmicOptions

The extra options passed to RMIC during server-side generation.


Servers: servername:

HelpPageURL


Default: /docs/admin/help

Servers: servername:

HttpdEnabled


true or false

Default: true

Servers: servername:

IIOPEnabled

Sets whether or not IIOP support is enabled.

true or false

Default: true

Servers: servername: Configuration: Protocols: Enable IIOP

IdleIIOPConnectionTimeout

Specify the maximum number of seconds an IIOP connection is allowed to be idle before it is closed by the server. This attribute helps guard against server deadlock through too many open connections.

Minimum: 0

Default: 60

Servers: servername: Configuration: Protocols: Enable IIOP

InstrumentStackTraceEnabled

If set to true, exception messages include the server-side stack trace.

true or false

Default: true

Servers: servername:

Instrument Stack Traces

InterfaceAddress



Servers: servername: Configuration: Cluster: Interface Address

JavaCompiler


Default: javac

Servers: servername:

JavaCompilerPostClassPath



Servers: servername:

JavaCompilerPreClassPath



Servers: servername:

JDBCLogFileName



Servers: servername:

JDBCLoggingEnabled

Turns on or off Java Database Connectivity (JDBC) logging. This is very helpful if you want to know what kind of JDBC statements that the WebLogic Server is issuing. The log file, jdbcxxxx.log, generally gets placed in the weblogic.Root Directory (make sure there is write permissions in that directory).

true or false

Default: false

Servers: servername:

JMSDefaultConnectionFactoriesEnabled


true or false

Default: true

Servers: servername: Services: JMS: Enable Default JMS Connection Factories

JMSThreadPoolSize


Default:15

Servers: servername: Services: JMS: JMS Thread Pool Size

JNDITransportableObjectFactoryList



Servers: servername:

ListenAddress



Servers: servername: Configuration: General: Listen Address

ListenDelaySecs


Default:0

Servers: servername:

ListenPort

The server's listen port.

Default:7001

Servers: servername: Configuration: General: Listen Port

LoginTimeout

The login timeout for the server.

In milliseconds. Default:1000

Servers: servername: Configuration: Tuning: Login Timeout

LoginTimeoutMillis

The interval to wait for a read to fail on login; 0 to disable.

Default:5000

Servers: servername:

LogRemoteExceptionsEnabled

Sets whether remote exceptions are to be reported to the log.

true or false

Default: false

Servers: servername:

Machine

The machine on which this server is meant to run. If the server is already running, this will migrate the server to a different machine. If the machine is the same as the machine is the server is already running on, this is a no-op.


Servers: servername: Configuration: General: Machine

Name

The name of the MBean. (Required.)

String

Default: N/A

Servers: servername: Configuration: General: Name

NativeIOEnabled

Sets whether or not native I/O should be enabled.

true or false

Default: true

Servers: servername: Configuration: Tuning: Enable Native IO

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null

Servers: servername: Notes

PreferredSecondaryGroup

The preferred replication group for the server's secondaries.


Servers: servername: Configuration: Cluster: Preferred Secondary Group

ReplicationGroup

The server's replication group.


Servers: servername: Configuration: Cluster: Replication Group

ReverseDNSAllowed

Returns whether or not the kernel is allowed to perform reverse DNS lookups.

true or false

Default: false

Servers: servername: Configuration: Tuning: Reverse DNS Allowed

RootDirectory

The root directory for the weblogic installation for this server.


Servers: servername:

StdoutDebugEnabled

Allows verbose display of server activity. If StdoutDebugEnabled="true", StdoutEnabled="true", and StdoutSeverityLevel="64" (INFO), all messages that would normally go to weblogic.log go to the screen where you started up WebLogic Server.

true or false

Default: false

Servers: servername: Logging: General: Debug to Stdout

StdoutEnabled

Determines if log messages should be logged to the standard out stream. Overrides StdoutSeverityLevel and StdoutDebugEnabled.

true or false

Default: true

Servers: servername: Logging: General: Log to Stdout

StdoutSeverityLevel

The minimum severity of a message that should be logged to the stand output device stream. All messages with given severity and higher, qualify.

  • 64 (INFO)

  • 32 (WARNING)

  • 16 (ERROR)

  • 8 (NOTICE)

  • 4 (CRITICAL)

  • 2 (ALERT)

  • 1 (EMERGENCY)

Note: The lower the number, the higher the severity.

See also StdoutDebugEnabled and StdoutEnabled.

64, 32, 16, 8, 4, 2, 1

Default:16

Servers: servername: Logging: General: Stdout Severity Threshold

TGIOPEnabled


true or false

Default: true

Servers: servername:

ThreadPoolPercentSocketReaders

The percentage (1-99) of execute threads that may be used as socket readers.

A percentage value from 1-99.

Default:33

Servers: servername: Configuration: Tuning: Socket Readers

TransactionLogFilePrefix


Default: ./

Servers: servername:

TunnelingClientPingSecs

Interval (in seconds) at which to ping an http-tunneled client to see if it is still alive

In seconds.

Default:45

Servers: servername: Configuration: Tuning: Tunneling Client Ping

TunnelingClientTimeoutSecs

Duration (in seconds) after which a missing http-tunneled client is considered dead.

In seconds. Default:40

Servers: servername: Configuration: Tuning: Tunneling Client Timeout

TunnelingEnabled

Enables tunneling via http.

true or false

Default: false

Servers: servername: Configuration: Tuning: Enable Tunneling

ValidProtocols

The collections of protocols supported by this kernel. The result is a map that maps strings to strings. The key is the protocol name and the value is the protocol description. This collection includes both secure and insecure protocols.


Servers: servername:

VerboseEJBDeploymentEnabled


true or false

Default: false

Servers: servername:

WeblogicPluginEnabled

Set to true if the server will receive requests from a proxy plug-in or HttpClusterServlet. When WeblogicPluginEnabled is true, a call to getRemoteAddr will return the address of the browser client from the proprietary WL-Proxy-Client-IP header, instead of from the web server.

WeblogicPluginEnabled is present in ClusterMBean and ServerMBean. The ClusterMBean value overrides the ServerMBean value.

true or false

Default: false

WebLogic Plug-in Enabled

WorkspaceShowUserKeysOnly

Controls whether user-inserted items are shown in the WebLogic console.

true or false

Default: false

Servers: servername: Configuration: Tuning: Show Only Workspace User Keys

XMLEntityCache



Servers: servername:

XMLRegistry

Return the XML Registry for the server.


Servers: servername: Services: XML: XML Registry

ZACEnabled

Sets whether or not the Zero Admin Client (ZAC) feature is enabled.

true or false

Default: true

Servers: servername:

ZACPublishRoot

The root (storage) directory on WebLogic for ZAC packages.

Default: exports

Servers: servername:

 


ServerStart

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

Attribute

Description

Range of Values and Default

Console Navigation

Arguments



Servers: servername: Configuration: Start: Arguments

ClassPath



Servers: servername: Configuration: Start: Class Path

DebugFlags



Servers: servername: Configuration: Start: Debug Flags

Name




Notes

The name of the MBean. (Required.)

String

Default: N/A


OutputFile

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


SecurityPolicyFile



Servers: servername: Configuration: Start: Security Policy File

 


ShutdownClass

Extends ClassDeploymentMBean.

Attribute

Description

Range of Values and Default

Console Navigation

Arguments



Deployments: Startup &#38; Shutdown: Arguments

ClassName




Name

The name of the MBean.

String

Default: N/A

Deployments: Startup &#38; Shutdown: Arguments

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


Targets

Returns targets on which this deployment is deployed.



 


SNMPAgent

The element representing the SNMP Agent Configuration. The SNMP Agent MBean is a singleton for the SNMP Agent Configuration and does not belong to any configuration.

Attribute

Description

Range of Values and Default

Console Navigation

CommunityPrefix

This string is used to form the SNMPCommunityName, which functions as a textual password to authenticate communication with SNMP managers. The community prefix sent by the SNMP manager must match the value configured in this attribute or the SNMP agent returns an error to the requestor.

When an SNMP manager sends a community name string to the WebLogic Server SNMP agent, it can take one of three possible forms:

  • community_prefix@server_name
    — the agent returns data only for the specified Managed Server.

  • community_prefix@domain_name
    —the agent returns data for every server in the domain.

  • community_prefix
    —the agent only retrieves data for the Administration Server.

String

Default: public

Services: SNMP: Community Prefix

DebugLevel

An integer value between 0 and 3. If it is zero (0), no debug messages are generated. If it is higher than zero, progressively more detailed debug messages are generated as the number gets higher.

  • 0 = NoDebug

  • 1 = Fatal

  • 2 = Critical

  • 3 = Non-Critical


0, 1, 2, 3

Default: 0

Services: SNMP: Debug Level

Enabled

If true, the SNMP Service is enabled. False is the default. The SNMP Service provides the SNMP agent functionality and is a part of the Administration Server. The agent monitors all WebLogic Server resources for the domain. In this release, the Administration Server must be restarted in order for configuration changes to take effect.

true or false

Default: false

Services: SNMP: Enabled

MIBDataRefreshInterval

The SNMP agent does not do a GET to obtain the current value of WebLogic Server attributes in response to requests from SNMP managers. Instead, it maintains a cache of all the attribute values and responds to manager requests by obtaining the attribute value from this cache. The MIBDataRefreshInterval is the interval, in seconds, at which the SNMP agent does a complete refresh of the cache. When it does a refresh, it does a GET on all the WebLogic Server attributes represented in the WebLogic Server SNMP MIB.

30-65535, in seconds

Default: 120

Services: SNMP: Mib Data Refresh Interval

Name

Name of the MBean. (Required.)



Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


ServerStatusCheckIntervalFactor

This is an integer value greater than zero. The SNMP agent multiplies this number by the MIBDataRefreshInterval to determine how frequently it should check to determine whether ManagedServers in the domain are up or down. The agent obtains this value from the MIB cache. If the ServerStatusCheckIntervalFactor is 1, the WebLogic Server SNMP agent checks whether ManagedServers are up or down at the interval defined in MIBDataRefreshInterval.

Integer, in range from 1-65535, representing seconds.

Default: 1

Services: SNMP: Server Status Check Interval Factor

SNMPPort

The port on which the WebLogic Server SNMP agent listens for incoming requests from SNMP managers.

Integer, in range of 1-65535

Default: 161

Services: SNMP: SNMP Port

 


SNMPAttributeChange

This class describes the settings to receive MBean-attribute change trap. SNMPAttributeChangeMBean extends SNMPTrapSourceMBean

Attribute

Description

Range of Values

Default Value

AttributeMBeanName


String or null.

Services: SNMP: Traps: Attribute Changes: Attribute MBean Name

AttributeMBeanType


String or null.

Services: SNMP: Traps: Attribute Changes: Attribute MBean Type

AttributeName


String or null.

Services: SNMP: Traps: Attribute Changes: Attribute Name

EnabledServers

A list of WebLogic servers for which traps can be generated. If no server is specified, no trap is generated. The syntax for specifying this attribute in config.xml is:

ServersEnabled="Server1,Server2"

Names of servers to be enabled.


Name

The name of the MBean. (Required.)


Services: SNMP: Traps: Attribute Changes: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


 


SNMPCounterMonitor

This class describes the criteria for a Counter-based Monitor. A trap is generated when this criteria is satisfied. SNMPCounterMonitorMBean extends SNMPJMXMonitorMBean

Attribute

Description

Range of Values and Default

Console Navigation

EnabledServers

A list of WebLogic servers, traps can be generated for. If no server is specified, no trap is generated. The syntax for specifying this attribute in config.xml is: ServersEnabled="Server1,Server2"


Services: SNMP: Traps: Monitors: Counter Monitors: Enabled Servers

Modulus

The Modulus value. If the counter can wrap around its maximum value, then the modulus must be specified. The modulus is the value at which the counter is reset to zero.

Integer, in range of 0-n

Default: 0

Services: SNMP: Traps: Monitors: Counter Monitors: Modulus

MonitoredAttributeName

The name of an attribute, for JMX Monitor to monitor.

String or null.

Services: SNMP: Traps: Monitors: Counter Monitors: Monitored Attribute Name

MonitoredMBeanName

The name of the MBean, to set JMX Monitor on.

String or null.

Services: SNMP: Traps: Monitors: Counter Monitors: Monitored Bean Name

MonitoredMBeanType

The type of the MBean, to set JMX Monitor on.

String or null.

Services: SNMP: Traps: Monitors: Counter Monitors: Monitored Bean Type

Name

The name of the MBean. (Required.)


Services: SNMP: Traps: Monitors: Counter Monitors: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


Offset

The Offset value. Whenever the threshold is triggered by the counter value reaching a comparison level, that comparison level is increased by the offset value.

Integer, in range of 0-n

Default: 0

Services: SNMP: Traps: Monitors: Counter Monitors: Offset

PollingInterval

The time interval for monitoring, in seconds.

Integer in range of 0-65535, representing seconds.

Default: 0

Services: SNMP: Traps: Monitors: Counter Monitors: Polling Interval

Threshold

The Threshold value of an attribute which, when crossed, a trap is generated.

Integer, in range of 0-n

Default: 0

Services: SNMP: Traps: Monitors: Counter Monitors: Threshold

 


SNMPGaugeMonitor

This class describes the criteria for a Gauge-based Monitor. A trap is generated when this criteria is satisfied.

Attribute

Description

Range of Values and Default

Console Navigation

EnabledServers

A list of WebLogic servers, traps can be generated for. If no server is specified, no trap is generated. The syntax for specifying this attribute in config.xml is: ServersEnabled="Server1,Server2"


Services: SNMP: Traps: Monitors: Gauge Monitors: Enabled Servers

MonitoredAttributeName

The name of an attribute, for JMX Monitor to monitor.

String or null.

Services: SNMP: Traps: Monitors: Gauge Monitors: Monitored Attribute Name

MonitoredMBeanName

The name of the MBean, to set JMX Monitor on.

String or null.

Services: SNMP: Traps: Monitors: Gauge Monitors: Monitored Bean Name

MonitoredMBeanType

The type of the MBean, to set JMX Monitor on.

String or null.

Services: SNMP: Traps: Monitors: Gauge Monitors: Monitored Bean Type

Name

Name of the MBean. (Required.)


Services: SNMP: Traps: Monitors: Gauge Monitors: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


PollingInterval


Default: 0

Services: SNMP: Traps: Monitors: Gauge Monitors: Polling Interval

ThresholdHigh

The high threshold value.

The Threshold value of an attribute which, when crossed, a trap is generated.

Default: 0

Services: SNMP: Traps: Monitors: Gauge Monitors: Threshold High

ThresholdLow

The low threshold value.

The Threshold value of an attribute which, when crossed, a trap is generated.

Default: 0

Services: SNMP: Traps: Monitors: Gauge Monitors: Threshold Low

 


SNMPLogFilter

This element represents a filter to qualify log messages which are logged to the server log file. A message must qualify criteria specified as a filter in order to generate a trap. Multiple instances of this element can be defined, if needed. If there are multiple instances, a message must qualify at least one filter to qualify for the server log file.

Attribute

Description

Range of Values and Default

Console Navigation

EnabledServers




MessageIds

The list of message IDs or ID ranges whose messages qualify for this filter. If no IDs are specified, messages from all IDs qualify.

Sample values are 20,50-100,300

Services: SNMP: Traps: Log Filters: Message Ids

MessageSubstring

A substring which qualifying messages must contain. If no substring is specified, all messages qualify.

String

Services: SNMP: Traps: Log Filters: Message Substring

Name

Name of the MBean. (Required.)


Services: SNMP: Traps: Log Filters: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


SeverityLevel

The minimum severity of a message which qualifies this filter. All messages with given severity and higher, qualify.

The ascending order of severities is

  • 64 (INFO)

  • 32 (WARNING)

  • 16 (ERROR)

  • 8 (NOTICE)

  • 4 (CRITICAL)

  • 2 (ALERT)

  • 1 (EMERGENCY)


64, 32, 16, 8, 4, 2,

1

Default: 16

Services: SNMP: Traps: Log Filters: Severity Level

SubsystemNames

The list of subsystems whose messages qualify for this filter. If none are specified, messages from all subsystems qualify.

String

Services: SNMP: Traps: Log Filters: Subsystem Names

UserIds

The list of users whose messages qualify for this filter. If no IDs are specified, messages from all user IDs qualify.

String

Services: SNMP: Traps: Log Filters: User Ids

 


SNMPProxy

The element representing the SNMP agents to be proxied by the current one.

Attribute

Description

Range of Values and Default

Console Navigation

Community

SNMP community to be passed on for all requests to the proxied agent. This is optional. By default, same as the community contained in the incoming SNMP requests to this Master SNMP agent.

Valid string or null.

Default: N/A

Services: SNMP: Proxies: Community

oidRoot

The root OID on which the proxied agent will be responding. This is mandatory.

Valid OID or null.

Services: SNMP: Proxies: Oid Root

Port

The port on which the proxied agent will be listen for SNMP requests. This is mandatory.

0-65535

Default: 0

Services: SNMP: Proxies: Port

Timeout

An interval, in milliseconds, at which the requests made to the proxied agent would time out.

0-n milliseconds

Default: 5000

Services: SNMP: Proxies: Timeout

 


SNMPStringMonitor

Describes the criteria for a String-based Monitor. A trap will be generated when this criteria is satisfied. SNMPStringMonitor extends SNMPJMXMonitor.

Attribute

Description

Range of Values and Default

Console Navigation

EnabledServers



Services: SNMP: Traps: Monitors: String Monitors: Enabled Servers

MonitoredAttributeName

The name of an attribute, for JMX Monitor to monitor.

String or null.

Services: SNMP: Traps: Monitors: String Monitors: Monitored Attribute Name

MonitoredMBeanName

The name of the MBean, on which to set JMX Monitor.

String or null.

Services: SNMP: Traps: Monitors: String Monitors: Monitored MBean Name

MonitoredMBeanType

The type of the MBean, on which to set JMX Monitor.

String or null.

Services: SNMP: Traps: Monitors: String Monitors: Monitored Bean Type

Name

Name of the MBean. (Required.)


Services: SNMP: Traps: Monitors: String Monitors: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


NotifyDiffer

If true, then send trap when strings compared mismatch.

true or false.

Default:

Services: SNMP: Traps: Monitors: String Monitors: Notify Differ

NotifyMatch


true or false

Default: false

Services: SNMP: Traps: Monitors: String Monitors: Notify Match

PollingInterval


Default: 0

Services: SNMP: Traps: Monitors: String Monitors: Polling Interval

StringToCompare

The string which will be compared against the value of the specified element attribute.

String or null.

Services: SNMP: Traps: Monitors: String Monitors: String To Compare

 


SNMPTrapDestination

This element holds all the destinations to which SNMP traps can be sent.

Attribute

Description

Range of Values

Default Value

Community

The SNMP trap community name. It functions as a password for sending trap notifications to the target SNMP manager.

Valid string or null

Default: public

Services: SNMP: Trap Destinations: Community

Host

A string that contains either host name or IP address of the machine of the SNMP manager that is a target for SNMP trap notifications sent by the WebLogic Server SNMP Agent.

Valid hostname or null.

Default: localhost

Services: SNMP: Trap Destinations: Host

Name

User-provided name for this destination.

String

Default: N/A

Services: SNMP: Trap Destinations: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


Port

The port that is used for sending SNMP trap notifications to the target SNMP manager.

1-65535

Default: 162

Services: SNMP: Trap Destinations: Port

 


SSL

This element represents the configuration of Secure Socket Layer (SSL) for clients.

Attribute

Description

Range of Values and Default

Console Navigation

CertAuthenticator

Specifies the name of the Java class that implements the weblogic.security.acl.
CertAuthenticator
class. The class maps the digital certificate of a client to a WebLogic Server User. The weblogic.security.acl.
CertAuthenticator
class has an authenticate() method that WebLogic Server calls after validating the digital certificate presented by the client.


Server: servername: Configuration: SSL: Cert Authenticator

CertificateCacheSize

The number of certificates held that have not been redeemed by tokens.

1-java.lang.Integer.MAX_VALUE

Default: 3

Server: servername: Configuration: SSL: Certificate Cache Size

Ciphersuites

Specifies the cipher suite being used on a particular WebLogic Server.

SSL_NULL_WITH_NULL_NULL

SSL_RSA_EXPORT_WITH_
RC4_40_MD5

SSL_RSA_WITH_NULL_SHA

SSL_RSA_EXPORT_WITH_
RC4_40_MD5

SSL_RSA_WITH_RC4_128_MD5

SSL_RSA_WITH_RC4_128_SHA

SSL_RSA_EXPORT_WITH_
DES_40_CBC_SHA

SSL_RSA_WITH_DES_CBC_SHA

SSL_RSA_WITH_3DES_EDE_
CBC_SHA

SSL_DH_anon_EXPORT_WITH_
RC4_40_MD5

SSL_DH_anon_WITH_
RC4_128_MD5

SSL_DH_anon_EXPORT_WITH_
DES_40_CBC_SHA

SSL_DH_anon_WITH_
DES_CBC_SHA

SSL_DH_anon_WITH_
3DES_EDE_CBC_SHA

Default: SSL_RSA_EXPORT_WITH_RC4_40_MD5


ClientCertificateEnforced

Defines whether or not clients must present digital certificates from a trusted certificate authority to WebLogic Server.

true or false

Default: false

Server: servername: Configuration: SSL: Client Certificate Enforced

Enabled

Enables the use of the SSL protocol on a particular WebLogic Server.

true or false

Default: false

Server: servername: Configuration: SSL: Enabled

ExportKeyLifespan

Specifies the number of times WebLogic Server can use an exportable key between a domestic server and an exportable client before generating a new key. The more secure you want WebLogic Server to be, the fewer times the key should be used before generating a new one.

1-java.lang.Integer.MAX_VALUE

Default: Use the key 500 times

Server: servername: Configuration: SSL: Export Key Lifespan

HandlerEnabled

Specifies whether or not WebLogic Server rejects SSL connections that fail client authentication for one of the following reasons:

  • The requested client digital certificate was not furnished.

  • The client did not submit a digital certificate

  • The digital certificate from the client was not issued by a certificate authority specified by the Trusted CA Filename attribute.

By default, the SSL Handler allows one WebLogic Server to make outgoing SSL connections to another WebLogic Server. For example, an EJB in WebLogic Server may open an HTTPS stream on another web server. With the HandlerEnabled attribute enabled, WebLogic Server acts as a client in an SSL connection.

true or false

Default: true

Server: servername: Configuration: SSL: Handler Enabled

HostnameVerificationIgnored

Disables the installed HostnameVerifier when WebLogic Server is acting as a client to another WebLogic Server.

true or false

Default: false


HostnameVerifier

The name of the Java class that implements the Hostname Verifier interface.


Server: servername: Configuration: SSL: Hostname Verifier

KeyEncrypted

Specifies whether or not the private key for the WebLogic Server has been encrypted with a password.

  • If the attribute is set to true, the private key requires a pass phrase be supplied to use the key.

  • If the attribute is set to false, the private key is unencrypted and may be used without providing a pass phrase.

true or false

Default: false

Server: servername: Configuration: SSL: Key Encrypted

ListenPort

The dedicated port at which the WebLogic Server listens for SSL connection requests.

1-java.lang.Integer.MAX_VALUE

Default: 7002

Server: servername: Configuration: SSL: Listen Port

LoginTimeoutMillis

The number of milliseconds that WebLogic Server should wait for an SSL connection before timing out. SSL connections take longer to negotiate than regular connections. If clients are connecting over the Internet, raise the default number to accommodate additional network latency. A value of 0 disables the attribute.

1-java.lang.Integer.MAX_VALUE, in milliseconds.

Default: 25000

Server: servername: Configuration: SSL: Login Timeout Millis

Name

The name of the MBean. (Required.)

String

Default: SSLMBean


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


ServerCertificateChainFileName

The full directory location and name of the file containing an ordered list of certificate authorities trusted by WebLogic Server. The PEM file extension indicates the method that should be used to read the file. Note that the digital certificate for WebLogic Server should not be stored in this file.

Pathname

Default: server-certchain.pem

Note: You cannot use absolute pathname for SSL Certificate files. You must use a pathname relative to weblogic.RootDirectory or by default the directory where you started the WebLogic Server

Server: servername: Configuration: SSL: Server Certificate Chain File Name

ServerCertificateFileName

The full directory location and name of the digital certificate for WebLogic Server. The file extension (.DER or .PEM) indicates the method that should be used to read the contents of the file.

Pathname

Default: server-cert.der

Note: You cannot use absolute pathname for SSL Certificate files. You must use a pathname relative to weblogic.RootDirectory or by default the directory where you started the WebLogic Server

Server: servername: Configuration: SSL: Server Certificate File Name

ServerKeyFileName

The full directory location and name of the private key file for WebLogic Server. The file extension (.PEM) indicates the method that should be used to read the file.

Pathname

Default: server-key.der

Note: You cannot use absolute pathname for SSL Certificate files. You must use a pathname relative to weblogic.RootDirectory or by default the directory where you started the WebLogic Server


Server: servername: Configuration: SSL: Server Key File Name

TrustedCAFileName

The name of the file that contains the digital certificate(s) for the certificate authority(s) trusted by WebLogic Server. The file specified in this attribute can contain a single digital certificate or multiple digital certificates for certificates. The file extension (.DER or .PEM) tells WebLogic Server how to read the contents of the file.

String

Default: trusted-ca.pem

Note: You cannot use absolute pathname for SSL Certificate files. You must use a pathname relative to weblogic.RootDirectory or by default the directory where you started the WebLogic Server

Server: servername: Configuration: SSL: Trusted CA File Name

UseJava

Enables the use of native Java libraries. WebLogic Server provides a pure-Java implementation of the SSL protocol. Native libraries enhance the performance for SSL operations on the Solaris, Windows NT, and IBM AIX platforms.

true or false

Default: true

Server: servername: Configuration: SSL: Use Java

 


StartupClass

Extends ClassDeploymentMBean. Returns true or false if a startup failure is fatal, when starting the server.

Attribute

Description

Range of Values and Default

Console Navigation

Arguments



Deployments: Startup &#38; Shutdown: Arguments

ClassName




DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Default: 1000

Deployments: Startup &#38; Shutdown: Deployment Order

FailureIsFatal


true or false

Default: false


Name



Deployments: Startup &#38; Shutdown: Name

Notes




Targets




 


UnixMachine

This element represents a machine that is running the UNIX operating system. It extends MachineMBean with properties specific to the UNIX platform.

For more information about how to use the Administration Console to set the attributes for configuring and managing machines, see the UnixMachine Console help.

Attribute

Description

Range of Values and Default

Console Navigation

Addresses

The addresses by which the machine is known.



Name

The name of the MBean.

String

Default: N/A


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: null


PostBindGID

The UNIX GID a server running on this machine will run under after it has carried out all privileged startup actions.

Unix GID or null

Default: null


PostBindGIDEnabled

This attribute allows the user to enable or disable the post-bind GID.

Boolean

True = Selected

False = Not Selected

Default value: Not Selected


PostBindUID

The UNIX UID a server running on this machine will run under after it has carried out all privileged startup actions.

Unix UID or null

Default value: null



PostBindUIDEnabled

This attribute allows the user to enable or disable the post-bind UID.

Boolean

True = Selected

False = Not Selected

Default value: Not Selected


StartdPort

The port number that the startd is configured to run on this machine.



 


UnixRealm

This MBean holds the UnixRealm's configuration properties. It is associated with CachingRealmMBean.

Attribute

Description

Range of Values and Default

Console Navigation

AuthProgram

The name of the program used to authenticate users in the UNIX security realm. In most cases, the name of the program is wlauth. The authentication program must run setuid root.

  • If the program name is wlauth and is in the CLASSPATH, you need not explicitly set this attribute; leave this property blank.

  • If the program name is different than wlauth, or if it is not in the CLASSPATH of WebLogic Server, specify this property.

Default: wlauth


Name

The name of the MBean for the UNIX security realm attributes. (Required.)

String

Default: UnixRealmMBean


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


RealmClassName

The name of the Java class that implements the UNIX Security Realm. This attribute is read-only.


Security: Realms: Realm Class Name

 


VirtualHost

This MBean represents the configuration of virtual web server within a WebLogic Server. Note that a server may define multiple web servers to support virtual hosts.

Note: This element represents a virtual host.

Attribute

Description

Range of Values and Default

Console Navigation

AuthCookieEnabled

Enables use of additional secure AuthCookie to make access to https pages with security constraints more secure. The session cookie will not be sufficient to gain access.

Required: no

Default: false

Secure value: true


Charsets




ClusteringEnabled


true or false

Default: false


DefaultServerName



Servers: servername: Configuration: HTTP: Default Server Name

DefaultWebApp



Servers: servername: Configuration: HTTP: Default Web Application

DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

Default: 1000


HttpsKeepAliveSecs


In seconds.

Default: 60

Servers: servername: Configuration: HTTP: HTTPS Duration

KeepAliveEnabled

Returns whether or not HTTP keep-alive is enabled.

true or false

Default: true

Servers: servername: Configuration: HTTP: Enable Keep Alives

KeepAliveSecs


Default: 30

Servers: servername: Configuration: HTTP: Duration

LogFileBufferKBytes

Sets HTTP request log buffer size.

Default: 8


LogFileFlushSecs

Frequency (seconds) with which the log file should be flushed.

Integer

Default: 60

Server: servername: Logging: HTTP: Flush Every

LogFileFormat

The format of the HTTP log file, common or extended.

common, extended

Default: common

Services: Virtual Host: Log File Format

LogFileName

The HTTP request log file

Default: access.log

Services: Virtual Host: Log File Name

LoggingEnabled


true or false

Default: true


LogRotationPeriodMins


Default: 1440


LogRotationTimeBegin




LogRotationType

The method by which to rotate the log file.

size or date

Default: size

Servers: servername: Logging: Rotation: Rotation Type

MaxLogFileSizeKBytes


Default: 0

Servers: servername: Logging: HTTP: Max Log File Size K Bytes

MaxPostSize


Default: -1

Servers: servername: Configuration: HTTP: Max Post Size

MaxPostTimeSecs


Default: -1

Servers: servername: Configuration: HTTP: Max Post Time

Name

The name of the MBean. (Required.)

String

Default: Null


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


PostTimeoutSecs

Timeout (in seconds) for reading HTTP POST data in a servlet request.

Integer

Default: 30

Servers: servername: Configuration: HTTP: Post Timeout Secs

SendServerHeaderEnabled

When true, WebLogic Server version information is included in the HTTP "Server" header.

true or false

Default: true


Targets

The targets on which this deployment is deployed.



URLResource




VirtualHostNames

The host name for which this web server will serve requests.


Services: Virtual Hosts: Virtual Host Names

WAPEnabled


true or false

Default: false

Servers: servername: Configuration: HTTP: WAP Enabled

 


WebAppComponent

Extends Component and WebDeployment elements

Attribute

Description

Range of Values and Default

Console Navigation

Application

The application this component is a part of. This is guaranteed to never be null.



AuthRealmName


Default: weblogic

Deployments: Web Applications: applicationname: Configuration: Other: Auth Realm Name

DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

Default: 1000

Deployments: Web Applications: applicationname: Configuration: General: Deployment Order

IndexDirectoryEnabled

Return whether or not to automatically generate an HTML directory listing if no suitable index file is found.

true or false

Default: false

Deployments: Web Applications: applicationname: Configuration: Files: Index Directories

Name

The name of the MBean. (Required.)

String

Default: N/A

Deployments: Web Applications: applicationname: Configuration: General: Name

Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null

Deployments: Web Applications: Notes

PreferWebInfClasses

Set this flag to true to cause classes in WEB-INF to be loaded before classes in the system CLASSPATH.

true or false

Default: false


ServletExtensionCaseSensitive


true or false

Default: false

Deployments: Web Applications: applicationname: Configuration: Files: Case Sensitive Extensions

ServletReloadCheckSecs


Default: 1

Deployments: Web Applications: applicationname: Configuration: Files: Reload Period

SessionMonitoringEnabled

If true, runtime Mbeans will be created for sessions, otherwise, they will not.



SingleThreadedServletPoolSize


Default: 5

Deployments: Web Applications: applicationname: Configuration: Files: Single Threaded Servlet Pool Size

Targets

The targets on which this deployment is deployed.



URI

A Uniform Resource Identifier (URI) pointing to the application component, usually found on the Admin server.

(Required.)

Valid string

Deployments: Web Applications: applicationname: Configuration: General: URI

WebDescriptor




WebServers




 


WebServer

This element represents the configuration of a virtual web server within a WebLogic server. Note that a server may define multiple web servers to support virtual hosts.

Note: This element represents a virtual host.

Attribute

Description

Range of Values and Default

Console Navigation

AuthCookieEnabled

Enables use of additional secure AuthCookie to make access to https pages with security constraints more secure. The session cookie will not be sufficient to gain access.

Required: no

Default: false

Secure value: true


Charsets

User-defined mapping between internet and Java charset names.



ClusteringEnabled

Enables HTTP clustering.

true or false

Default: false


DefaultServerName

This attribute allows you to set the HTTP default server name. You can thus specify the servername for any HTTP request/response. Otherwise, the hostname passed in the HTTP header is used. If the hostname is not present in the header it defaults to system name. This feature is especially useful when using proxy servers that might change the HTTP request going to WebLogicServer. If the header is changed or not set, then the client will not be directed back to the proxy, but rather to the actual WebLogicServer instance.

The name of a valid server

Servers: servername: Configuration: HTTP: Default Server Name

DefaultWebApp



Servers: servername: Configuration: HTTP: Default Web Application

DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

Default: 1000


HttpsKeepAliveSecs

Number of seconds to maintain HTTPS keep-alive before timing out the request.

Default: 60

Servers: servername: Configuration: HTTP: HTTPS Duration

KeepAliveEnabled


true or false

Default: true

Servers: servername: Configuration: HTTP: Enable Keep Alives

KeepAliveSecs

Number of seconds to maintain HTTP keep-alive before timing out the request.

Default: 30


LogFileBufferKBytes


Default: 8


LogFileFlushSecs

Frequency (seconds) with which the log file should be flushed.

Default: 60

Server: servername: Logging: HTTP: Flush Every

LogFileFormat

The format of the HTTP log file, common or extended.

common or extended

Default: common


LogFileName

The HTTP request log file.

Default: access.log


LoggingEnabled


true or false

Default: true


LogRotationPeriodMins


Default: 1440


LogRotationTimeBegin




LogRotationType

The methodology by which the log file is turned over.

size, date

Default: size

Servers: servername: Logging: HTTP: Rotation Type

MaxLogFileSizeKBytes


Default: 0

Servers: servername: Logging: HTTP: Max Log File Size Kbytes

MaxPostSize


Default: -1

Servers: servername: Configuration: HTTP: Max Post Size

MaxPostTimeSecs


Default: -1

Servers: servername: Configuration: HTTP: Max Post Time

Name

The name of the MBean. (Required.)

String

Default: N/A


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


PostTimeoutSecs

Timeout (in seconds) for reading HTTP POST data in a servlet request.

Default: 30

Servers: servername: Configuration: HTTP: Post Timeout Secs

SendServerHeaderEnabled


true or false

Default: true


Targets

Returns targets on which this deployment is deployed.



URLResource




WAPEnabled


true or false

Default: false


 


WLECConnectionPool

This MBbean defines a WLEC connection pool.

Attribute

Description

Range of Values and Default

Console Navigation

ApplicationPassword

The password for the WebLogic Enterprise application. This attribute is required when the security level in the WLE domain is APP_PW, USER_AUTH, ACL, or MANDATORY_ACL.



CertificateAuthenticationEnabled

Set to true to enable certificate-based authentication.

true or false

Default: false


DeploymentOrder

The order to be used for deployment. Ordering is with respect to other deployable units within the same class only. A lower deployment order value deploys before a higher one.

There is no guarantee of the order of deployments with equal DeploymentOrder values. There is no guarantee of ordering deployments across clusters.

Minimum:

MIN_ORDER

Maximum: MAX_ORDER

Default: 1000


FailoverAddresses

A list of addresses for IIOP Listener/Handlers that are used if connections cannot be established with the addresses defined in the Primary Addresses field. Multiple addresses are separated by semicolons.


Services: WLEC: Failover Addresses

MaximumEncryptionLevel

  • q

0,40,56,128

Default: 40


MaximumPoolSize

The maximum number of IIOP connections that can be made from the WLEC connection pool when WebLogic Server starts.

Default: 1

Services: WLEC: Maximum Pool Size

MinimumEncryptionLevel

The minimum SSL encryption level used between the WLE domain and WebLogic Server. If this minimum level of encryption is not met, the SSL connection between the WLE domain and WebLogic Server fails.

  • Zero (0) indicates that the data is signed but not sealed.

  • 40, 56, and 128 specify the length, in bits, of the encryption key.

Default: 40


MinimumPoolSize

The number of IIOP connections to be added to the WLEC connection pool when WebLogic Server starts.

Default: 1

Services: WLEC: Minimum Pool Size

Name

The name of the MBean for WLEC connection pools. (Required.)

String

Default: WLECConnectionPoolMBean


Notes

Optional user-supplied information about the WLECConnectionPoolMBean.

Alphanumeric string

Default: Null


PrimaryAddresses

A list of addresses for IIOP Listener/Handlers that can be used to establish a connection between the WLEC connection pool and the WLE domain. The format of each address is //hostname:port.

The addresses must be match the ISL addresses defined in the UBBCONFIG file. Multiple addresses are separated by commas. For example: //main1.com:1024, //main2.com:1044.

To configure the WLEC connection pool to use the SSL protocol, use the corbalocs prefix with the address of the IIOP Listener/Handler. For example: corbalocs://hostname:port.


Services: WLEC: Primary Addresses

SecurityContextEnabled

Enables the passing of the security context of the WebLogic Server User to the WLE domain.

true or false

Default: false


Targets

The targets on which this deployment is deployed.



UserName

The user name for the BEA Tuxedo CORBA application. Whether or not this attribute is required depends on the security level of the CORBA application. This attribute is required only when the security level in the BEA Tuxedo domain is USER_AUTH, ACL, or MANDATORY_ACL.



UserPassword

The password for the user defined in the UserName attribute. This attribute is required only when you define the UserName attribute.



UserRole

The WebLogic Enterprise user role. This attribute is required when the security level in the WebLogic Enterprise domain is APP_PW, USER_AUTH, ACL, or MANDATORY_ACL.



WLEDomain

The name of the WLE domain to which this WLEC connection pool connects. You can have only one WLEC connection pool per WLE domain. The domain name must match the domainid parameter in the RESOURCES section of the UBBCONFIG file for the WLE domain.



 


XMLEntityCache

Used to configure WebLogic Server to retrieve and cache external entities from external repositories that support an HTTP interface, such as a URL. You can configure WebLogic Server to cache the external entity in memory or on the disk and specify how long the entity should remain cached before it is considered out of date.

Attribute

Description

Range of Values and Default

Console Navigation

CacheDiskSize

Size, MB, of the persistent disk cache.

Zero (0) to the maximum disk size of your computer.

Default: 5

Servers: servername: Services: XML: Cache Disk Size

CacheLocation

Pathname of the directory that contains the persistent entity files. If you specify a relative pathname, it is relative to the main WebLogic Server installation directory.

Pathname

Default: xmlcache


CacheMemorySize

Size, in KB, of the cache memory.

Zero (0) to the maximum memory size of your computer.

Default: 500

Servers: servername: Services: XML: Cache Memory Size

CacheTimeoutInterval

Number of seconds after which external entities in the cache become stale after they have been cached by WebLogic Server.

Integer

Default: 120

Servers: servername: Services: XML: Cache Timeout Interval

Name

Name of the entity cache.

String

Default: XMLCacheMbean


Notes

Optional user-defined comments about this element.

String

Default: N/A


 


XMLEntitySpecRegistryEntry

This is an entry in the XML registry. An XML registry entry is configuration information associated with a particular XML document type. Entries accessed through this interface are used to specify a local instance for a remote entity reference.

For this type of registry entry the document type is identified by either or both of the following:

Note: This configuration information is used by the WebLogic JAXP implementation to set up SAX EntityResolvers.

Attribute

Description

Range of Values and Default

Console Navigation

CacheTimeoutInterval

Number of seconds after which external entities in the cache become stale after they have been cached by WebLogic Server.

Integer

Default: -1
(defer to global caching setting)


EntityURI

Either the URL of an external entity on the Web or stored in a repository, or the pathname of a copy of the entity file in the Administration Server.

String

Default: N/A


Name

Internal name of the registry entry to configure external entities.

String

Default: N/A


Notes

Optional user-defined comments about this element.

String

Default: N/A


PublicId

The Public ID used to identify the external entity.

String

Default: N/A


SystemId

The System ID used to identify the external entity.

String

Default: N/A


WhenToCache

Specifies whether you want WebLogic Server to cache an external entity referenced by a URL the first time the entity is referenced in an XML document, when WebLogic Server starts, or to use the global caching setting.

cache-on-reference, cache-at-initialization, defer-to-registry-setting

Default: defer-to-registry-setting


 


XmlFileRepository

Extends Repository element. Repository element is defined as an interface implemented by all configuration repository. A repository is an element that knows how to access and store configurations to a type of back-end, such as a file system or a database.

Attributes

Description

Range of Values and Default

Console Navigation

Directory

The directory in which the Domain Configuration (.dom) files are found.

An existing directory.


Domains




Name

The name of the MBean. (Required.)

String

Default: N/A


Notes

Optional user-supplied information about this configuration MBean.

Alphanumeric string

Default: Null


 


XMLParserSelectRegistryEntry

This is an entry in the XML registry. An XML registry entry is configuration information associated with a particular XML document type. Entries accessed through this interface are used to specify a default parser or transformation factory for WebLogic server, or a parser for a particular document type.

The document type is identified by one or more of the following:

Note: This configuration information is used by the WebLogic JAXP implementation to choose the appropriate parser and transformation factories.

Attribute

Description

Range of Values and Default

Console Navigation

DocumentBuilderFactory

The DocumentBuilderFactory implementation classes used to do DOM-style parsing for this XML document type.

String

Default: N//A

Services: XML Registries: Document Builder Factory

Name

Internal name of the registry entry to configure parsers and transformers.

String

Default: N/A


Notes

Optional user-defined comments about this element.

String

Default: N/A


ParserClassName

Note: Do NOT use this attribute. It is deprecated.



PublicId

Public ID of the XML document type for which the parser is being configured.

String

Default: N/A


RootElementTag

Root element name of the XML document type for which the parser is being configured.

String

Default: N/A


SaxParserFactory

The SaxParserFactory implementation classes used to do SAX-style parsing for this XML document type.

String

Default: N/A

Services: XML Registries: Sax Parser Factory

SystemId

System ID of the XML document type for which the parser is being configured.

String

Default: N/A


TransformerFactory

Not used by WebLogic Server.



 


XMLRegistry

Used to configure default parsers and transformers for WebLogic Server, the parser used by a particular document type, and external entity resolution for a particular document type.

Attribute

Description

Range of Values and Default

Console Navigation

DocumentBuilderFactory

This attribute allows the user to set the default Document Builder Factory for the server.

This attribute determines the default factory for all server applications that use DOM to parse documents. To override the default factory for a particular document type definition (DTD), use the Parser Name Class attribute in the XML Registry Entries element.

String

Default: weblogic.apache.xerces.jaxp.DocumentBuilderFactoryImpl

Services: XML Registries: Document Builder Factory

Name

Name of the XML Registry.

String

Default: N/A


Notes

Optional user-defined comments about this element.

String

Default: N/A


SaxParserFactory

This attribute allows the user to set the default SAX Parser Factory for the server.

This attribute determines the default factory for all server applications that use SAX to parse documents.

To override the default factory for a particular document type definition (DTD) or to use a custom-generated SAX parser, use the Parser Name Class attribute on the XML Registry Entries element.

String

Default: weblogic.apache.xerces.jaxp.SAXParserFactoryImpl

Services: XML Registries: Sax Parser Factory

TransformerFactory

The TransformerFactory classes that implement the JAXP interfaces for transforming XML documents.

String

weblogic.apache.xalan.processor.TransformerFactoryImpl


WhenToCache

Specifies whether you want WebLogic Server to cache an external entity referenced by a URL the first time the entity is referenced in an XML document or when WebLogic Server starts.

cache-on-reference,

cache-at-initialization

Default: cache-on-reference


 


XMLRegistryEntry (deprecated)

Note: You should not specify this element in your config.xml file.The XMLRegistryEntry element of the config.xml file is deprecated, which means that although it is still supported in WebLogic Server version 6.1, future versions will not support it.

The XMLRegistryEntry element has been replaced by the following two elements:

Attribute

Description

Range of Values

Default Value

Console Navigation

DocumentBuilderFactory

The DocumentBuilderFactory implementation classes used to do DOM-style parsing for this XML document type.

q

Services: XML Registries: Document Builder Factory

EntityPath

The pathname of a copy of the entity file in the Administration Server.

Pathname

Default: N/A


Name

Name of the XML Registry entry.

String

Default: N/A


Notes

Optional user-defined comments about this element.

String

Default: N/A


ParserClassName

The class name of the generated custom parser used to parser this XML document type.

String

Default: N/A


PublicId

Public ID of the XML document type for which the parser or external entity is being configured.

String

Default: N/A


RootElementTag

Root element name of the XML document type for which the parser or external entity is being configured.

String

Default: N/A


SaxParserFactory

The SaxParserFactory implementation classes used to do SAX-style parsing for this XML document type.

String

Default: N/A

Services: XML Registries: Sax Parser Factory

SystemId

System ID of the XML document type for which the parser or external entity is being configured.

String

Default: N/A


 

back to top previous page next page