KernelMBean

Overview

This bean represents the configuration of the core message passing kernel on both WebLogic clients and servers.

ServerMBean extends this bean to represent the configuration of a server.

Related MBeans

This section describes attributes that provide access to other MBeans.

ExecuteQueues

Returns the execute queues configured for this server.

IIOP

Returns the kernel's IIOP configuration. An IIOP MBean is always linked to a particular kernel and cannot be changed. Individual attributes on the IIOP MBean may be changed, as documented, but the MBean itself may not.

Log

Returns the log settings for this kernel. A Log MBean is always linked to a particular kernel and cannot be changed. Individual attributes on the Log MBean may be changed, as documented, but the MBean itself may not.

SSL

Returns the kernel's SSL configuration. An SSL MBean is always linked to a particular kernel and cannot be changed. Individual attributes on the SSL MBean may be changed, as documented, but the MBean itself may not.

Attributes

This section describes the following attributes:

AddWorkManagerThreadsByCpuCount

Enables increased efficiency of the self-tuning thread pool by aligning it with the Exalogic processor architecture threading capabilities. Use only when configuring a WebLogic domain for Oracle Exalogic.

• Enabling this attribute increases efficiency during I/O in environments with high network throughput.

• Disabling this attribute allows the thread pool to self-tune to match the demand of the workload at the expense of longer ramp up time.

AdministrationProtocol

Returns the protocol to be used for administrative connections when none is specified.

AllowShrinkingPriorityRequestQueue

Specifies whether self-tuning should allow shrinking of its priority based queue for pending requests after it has grown in size due to busy workload, and whether it should try to purge work requests that have already been picked up for processing due to minimum threads constraints before growing the queue. Setting this to true would help reduce memory footprint after the busy work period has ended, at the expense of the overhead of growing the request queue again at the next period of busy workload. It would also help to reduce the amount of memory allocated for the request queue, at the expense of the overhead required in purging already processed work requests from the queue.

CachingDisabled

Private property that disables caching in proxies.

CompleteCOMMessageTimeout

The maximum number of seconds spent waiting for a complete COM message to be received. This setting does not apply to any network channels that you have configured for this server.

This timeout helps guard against a denial of service attack in which a caller indicates that they will be sending a message of a certain size which they never finish sending.

Deprecated. 8.1.0.0 use NetworkAccessPointMBean#getCompleteMessageTimeout()

For more information, see:

• NetworkAccessPointMBean#getCompleteMessageTimeout

CompleteHTTPMessageTimeout

The maximum number of seconds spent waiting for a complete HTTP message to be received. If you configure network channels for this server, each channel can override this HTTP message timeout.

This timeout helps guard against a denial of service attack in which a caller indicates that it will be sending a message of a certain size which it never finishes sending.

A value of -1 indicates that this value should be obtained from network channels configured for this server.

Deprecated. 8.1.0.0 use NetworkAccessPointMBean#getCompleteMessageTimeout()

For more information, see:

• NetworkAccessPointMBean#getCompleteMessageTimeout

CompleteIIOPMessageTimeout

The maximum number of seconds spent waiting for a complete IIOP message to be received. This timeout helps guard against denial of service attacks in which a caller indicates that they will be sending a message of a certain size which they never finish sending.

Deprecated. 8.1.0.0 use NetworkAccessPointMBean#getCompleteMessageTimeout()

CompleteMessageTimeout

The maximum number of seconds that this server waits for a complete message to be received. If you configure network channels for this server, each channel can override this message timeout.

This timeout helps guard against a denial of service attack in which a caller indicates that it will be sending a message of a certain size which it never finishes sending.

CompleteMessageTimeout affects the HTTP Response, such that if WebLogic Server discovers sockets inactive for longer than the CompleteMessageTimeout, the server will close these sockets.

For more information, see:

• NetworkAccessPointMBean#getCompleteMessageTimeout

CompleteT3MessageTimeout

The maximum number of seconds spent waiting for a complete T3 message to be received. If you configure network channels for this server, each channel can override this T3 message timeout.

This timeout helps guard against a denial of service attack in which a caller indicates that it will be sending a message of a certain size which it never finishes sending.

Deprecated. 8.1.0.0 use NetworkAccessPointMBean#getCompleteMessageTimeout()

For more information, see:

• NetworkAccessPointMBean#getCompleteMessageTimeout

CompleteWriteTimeout

The maximum number of seconds that this server waits for a complete HTTP response to be sent.

A value of 0 disables the complete write timeout. The default value is derived from the CompleteHTTPMessageTimeout. If it is -1, then the CompleteMessageTimeout value is used for the default value.

ConnectTimeout

The amount of time that this server should wait to establish an outbound socket connection before timing out. A value of 0 disables server connect timeout.

For more information, see:

• NetworkAccessPointMBean#getConnectTimeout

DefaultProtocol

The protocol to use for connections when none is specified.

DefaultSecureProtocol

The protocol to use for secure connections when none is specified.

DGCIdlePeriodsUntilTimeout

The number of idle periods allowed before the object is collected.

DynamicallyCreated

Return whether the MBean was created dynamically or is persisted to config.xml

EagerThreadLocalCleanup

Specifies whether to clean up all ThreadLocals storage from self-tuning thread pool threads after they have finished processing each work request. By default, the self-tuning thread pool only cleans up ThreadLocal storage in its threads after an application is undeployed to avoid ClassLoader memory leak.

GatheredWritesEnabled

Enables gathered writes over NIO socket channels. Enabling this attribute increases efficiency during I/O in environments with high network throughput and should be used only when configuring a WebLogic domain for Oracle Exalogic.

Id

Return the unique id of this MBean instance

IdleConnectionTimeout

The maximum number of seconds that a connection is allowed to be idle before it is closed by the server. The T3 and T3S protocols ignore this attribute. If you configure network channels for this server, each channel can override this idle connection message timeout.

This timeout helps guard against server deadlock through too many open connections.

For more information, see:

• NetworkAccessPointMBean#getIdleConnectionTimeout

IdleIIOPConnectionTimeout

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

Deprecated. 8.1.0.0 use NetworkAccessPointMBean#getIdleConnectionTimeout()

IdlePeriodsUntilTimeout

The number of idle periods until peer is considered unreachable.

IIOPTxMechanism

Configures IIOP propagate transactions using either WebLogic-specific JTA or the OMG-specified OTS.

It is not possible to use both because it affects the way transactions are negotiated.

Deprecated. 8.1.0.0 use IIOPMBean#getTxMechanism()

InstrumentStackTraceEnabled

Specifies whether the server returns stack traces for RMI calls that generate exceptions.

With RMI stack tracking enabled, if a client issues an RMI call to a server subsystem or to a module running within the server, and if the subsystem or module generates an exception that includes a stack trace, the server will return the exception as well as the stack trace. With it disabled, the server will return the exception without the stack trace details.

LogRemoteExceptionsEnabled

Specifies whether the server message log includes exceptions that are raised in remote systems.

MaxCOMMessageSize

The maximum number of bytes allowed in messages that are received over the COM protocol. If you configure custom network channels for this server, each channel can override this maximum message size.

This maximum message size helps guard against a denial of service attack in which a caller attempts to force the server to allocate more memory than is available thereby keeping the server from responding quickly to other requests.

A value of -1 causes the COM protocol to use the maximums that are specified elsewhere along the order of precedence.

Deprecated. 8.1.0.0 use NetworkAccessPointMBean#getMaxMessageSize()

For more information, see:

• KernelMBean#getMaxMessageSize
• NetworkAccessPointMBean#getMaxMessageSize

MaxHTTPMessageSize

The maximum number of bytes allowed in messages that are received over the HTTP protocol. If you configure custom network channels for this server, each channel can override this maximum message size.

This maximum message size helps guard against a denial of service attack in which a caller attempts to force the server to allocate more memory than is available thereby keeping the server from responding quickly to other requests.

A value of -1 causes the HTTP protocol to use the maximums that are specified elsewhere along the order of precedence.

Deprecated. 8.1.0.0 use NetworkAccessPointMBean#getMaxMessageSize()

For more information, see:

• KernelMBean#getMaxMessageSize
• NetworkAccessPointMBean#getMaxMessageSize

MaxIIOPMessageSize

The maximum number of bytes allowed in messages that are received over the IIOP protocol. If you configure custom network channels for this server, each channel can override this maximum message size.

This maximum message size helps guard against a denial of service attack in which a caller attempts to force the server to allocate more memory than is available thereby keeping the server from responding quickly to other requests.

A value of -1 causes the IIOP protocol to use the maximums that are specified elsewhere along the order of precedence.

Deprecated. 8.1.0.0 use NetworkAccessPointMBean#getMaxMessageSize()

For more information, see:

• KernelMBean#getMaxMessageSize
• NetworkAccessPointMBean#getMaxMessageSize

MaxMessageSize

The maximum number of bytes allowed in messages that are received over all supported protocols, unless overridden by a protocol-specific setting or a custom channel setting.

The order of precedence for setting message size maximums is as follows:

1. A channel-wide maximum in a custom network channel.

2. A protocol-specific setting in the default network channel.

   See

   • getMaxCOMMessageSize

   • getMaxHTTPMessageSize

   • getMaxIIOPessageSize

   • getMaxT3MessageSize

3. The message maximum in this attribute.

This maximum message size helps guard against a denial of service attack in which a caller attempts to force the server to allocate more memory than is available thereby keeping the server from responding quickly to other requests.

A client can set this value using the -Dweblogic.MaxMessageSize property.

For more information, see:

• NetworkAccessPointMBean

MaxOpenSockCount

The maximum number of open sockets allowed in server at a given point of time.

When the maximum threshold is reached, the server stops accepting new requests until the number of sockets drops below the threshold.

A value less than 0 indicates an unlimited size.

MaxT3MessageSize

The maximum number of bytes allowed in messages that are received over the T3 protocol. If you configure custom network channels for this server, each channel can override this maximum message size.

This maximum message size helps guard against a denial of service attack in which a caller attempts to force the server to allocate more memory than is available thereby keeping the server from responding quickly to other requests.

A value of -1 causes the T3 protocol to use the maximums that are specified elsewhere along the order of precedence.

Deprecated. 8.1.0.0 use NetworkAccessPointMBean#getMaxMessageSize()

For more information, see:

• KernelMBean#getMaxMessageSize
• NetworkAccessPointMBean#getMaxMessageSize

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

MessagingBridgeThreadPoolSize

Returns the size of the messaging bridge execute thread pool.

Deprecated. 9.0.0.0 replaced by a Work Manager named weblogic.jms.MessagingBridge

MuxerClass

Non-blocking IO is enabled by default on the server side.

The default value is weblogic.socket.NIOSocketMuxer.

The Certicom SSL implementation is not supported with NIOSocketMuxer. If you need to secure internet communication, Oracle recommends enabling JSSE (Java Secure Socket Extension).

Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:

Name=user-specified-name

NativeIOEnabled

Specifies whether native I/O is enabled for the server.

For more information, see:

• getSocketReaderTimeoutMaxMillis

Notes

Optional information that you can include to describe this configuration.

WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.

Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

ObjectName

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

Deprecated.

OutboundEnabled

Specifies whether new server-to-server connections may consider the default server channel when initiating a connection. This is only relevant if the connection needs to be bound to the default listen address. This will only work for binary protocols that support both outbound and inbound traffic.

When this feature is not enabled, connections are initiated using a local address selected by the underlying hardware. For the default channel this is usually what is wanted for IP-routing to be effective. Note that since the default is false, other outbound channels will be considered in preference to the default channel.

Default administration channels, created when the domain-wide administration port is turned on, are always considered and bound when initiating an administrative connection. To allow IP-routing for administration traffic create custom admin with isOutboundEnabled set to false instead of enabling the domain-wide ADMIN port.

For more information, see:

• NetworkAccessPointMBean#isOutboundEnabled

OutboundPrivateKeyEnabled

Specifies whether the SSL identity specified by getSSLMBean#ServerPrivateKeyAlias for this server should be used for outbound SSL connections on the default server channel. In normal circumstances the outbound identity is determined by the caller's environment.

For more information, see:

• isOutboundEnabled

Parent

Return the immediate parent for this MBean

PeriodLength

The time interval in milliseconds of the heartbeat period. A value of 0 indicates that heartbeats are turned off.

PrintStackTraceInProduction

Specifies whether the server message log includes exception stack trace that are raised in remote systems.

Registered

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

Deprecated.

ReverseDNSAllowed

Specifies whether the kernel is allowed to perform reverse DNS lookups.

ScatteredReadsEnabled

Enables scattered reads over NIO socket channels. Enabling this attribute increases efficiency during I/O in environments with high network throughput and should be used only when configuring a WebLogic domain for Oracle Exalogic.

SocketBufferSizeAsChunkSize

Specifies whether the server's buffer size for sending or receiving data through a raw socket should be set to 4KB.

Otherwise, the server does not impose a limit to the buffer size and defers to the operating system. This option is useful only on some operating systems for improving performance. It should be disabled in most environments.

SocketReaders

The number of socket reader threads.

StdoutDebugEnabled

Specifies whether the server sends messages of the DEBUG severity to standard out in addition to the log file. (Requires you to enable sending messages to standard out.)

Deprecated. 9.0.0.0 replaced by LogMBean.StdoutSeverity For backward compatibility the changes to this attribute will be propagated to the LogMBean.

StdoutEnabled

Specifies whether the server sends messages to standard out in addition to the log file.

Other settings configure the minimum severity of a message that the server sends to standard out.

Deprecated. 9.0.0.0 replaced by LogMBean.StdoutSeverity, for backward compatibility the changes to this attribute will be propagated to the LogMBean.

For more information, see:

• isStdoutDebugEnabled
• getStdoutSeverityLevel

StdoutFormat

The output format to use when logging to the console.

Deprecated.

StdoutLogStack

Specifies whether to dump stack traces to the console when included in logged message.

Deprecated. 9.0.0.0

StdoutSeverityLevel

The minimum severity of a message that the server sends to standard out. (Requires you to enable sending messages to standard out.)

Deprecated. 9.0.0.0 Replaced by LogMBean.StdoutSeverity. For backward compatibility the changes to this attribute will be propagated to the LogMBean.

For more information, see:

• isStdoutEnabled

StuckThreadMaxTime

The number of seconds that a thread must be continually working before this server considers the thread stuck.

For example, if you set this to 600 seconds, WebLogic Server considers a thread to be "stuck" after 600 seconds of continuous use.

In WebLogic Server 9.x and later, it is recommended that you use the ServerFailureTriggerMBean in the OverloadProtectionMBean. The ServerFailureTriggerMBean transitions the server to a FAILED state after the specified number of stuck threads are detected. The OverloadProtectionMBean has options to suspend or shutdown a failed server.

Deprecated. 9.0.0.0 replaced by ServerFailureTriggerMBean.getMaxStuckThreadTime()

StuckThreadTimerInterval

The number of seconds after which WebLogic Server periodically scans threads to see if they have been continually working for the configured maximum length of time.

For more information, see:

• getStuckThreadMaxTime

Tags

Return all tags on this Configuration MBean

ThreadPoolPercentSocketReaders

The percentage of execute threads from the default queue that can be used as socket readers.

Type

Returns the type of the MBean.

Use81StyleExecuteQueues

Backward compatibility mode to switch to 8.1 execute queues instead of WorkManagers. Each of the WorkManagers is converted to an individual execute queue. Setting this attribute requires a server restart.

For more information, see:

• getUse81StyleExecuteQueues

UseConcurrentQueueForRequestManager

Reduces lock contention by using concurrent buffer queue to park incoming requests. Enabling this attribute increases throughput as requests are scheduled without acquiring any locks.

UseDetailedThreadName

Specifies whether to includes detailed information in self-tuning thread pool thread names. Setting this flag as true would include additional information, such as the name of the Work Manager for which the execute thread is executing the task, but at the expense of overhead in keeping the thread name updated with such information.

UseEnhancedIncrementAdvisor

Specifies whether self-tuning should use the enhanced IncrementAdvisor implementation that uses a different algorithm to adjust the size of the self-tuning thread pool.

UseEnhancedPriorityQueueForRequestManager

Reduces lock contention by using the enhanced ConcurrentCalendarQueue as the priority based queue for pending requests that are waiting for a thread.

This attribute should be enabled only in an Oracle Exalogic environment.

Operations

This section describes the following operations:

addTag

Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.

freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note: To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

getInheritedProperties

Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

isInherited

Check if the value of a property is inherited from template mbean or not.

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

removeTag

Remove a tag from this Configuration MBean

restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

unSet

Restore the given property to its default value.