BEA Systems, Inc.

weblogic.management.configuration
Interface LogMBean

All Superinterfaces:
weblogic.management.configuration.CommonLogMBean, ConfigurationMBean, weblogic.descriptor.DescriptorBean, DynamicMBean, LogFileMBean, MBeanRegistration, NotificationBroadcaster, weblogic.descriptor.SettableBean, weblogic.management.WebLogicMBean

public interface LogMBean
extends weblogic.management.configuration.CommonLogMBean

Configures the threshold severity level and filter settings for logging output.

Specifies whether the server logging is based on a Log4j implementation or the default Java Logging APIs.

Redirects the JVM stdout and stderr output to the registered log destinations.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.


Field Summary
 
Fields inherited from interface weblogic.management.configuration.CommonLogMBean
STDOUT_NOID, STDOUT_STANDARD
 
Fields inherited from interface weblogic.management.configuration.LogFileMBean
DEFAULT_FILE_NAME, MAX_ROTATED_FILES, NONE, SIZE, TIME, TIME_FORMAT
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 int getDomainLogBroadcasterBufferSize()
          Broadcasts log messages to the domain log in batch mode.
 weblogic.management.configuration.LogFilterMBean getDomainLogBroadcastFilter()
          The filter configuration for log events being sent to the domain log.
 String getDomainLogBroadcastSeverity()
          The minimum severity of log messages going to the domain log from this server's log broadcaster.
 weblogic.management.configuration.LogFilterMBean getLogFileFilter()
          The filter configuration for the server log file.
 weblogic.management.configuration.LogFilterMBean getMemoryBufferFilter()
          The filter configuration for messages that are stored in the log memory buffer.
 String getMemoryBufferSeverity()
          The minimum severity of log messages going to the memory buffer of recent log events.
 int getMemoryBufferSize()
          The size of the memory buffer that holds the last n log records.
 weblogic.management.configuration.LogFilterMBean getStdoutFilter()
          The filter configuration for log events being sent to the standard out.
 boolean isLog4jLoggingEnabled()
          Specifies whether the server logging is based on a Log4j implementation.
 boolean isRedirectStderrToServerLogEnabled()
          When enabled, this redirects the stderr of the JVM in which a WebLogic Server instance runs, to the WebLogic Logging system.
 boolean isRedirectStdoutToServerLogEnabled()
          When enabled, this redirects the stdout of the JVM in which a WebLogic Server instance runs, to the WebLogic logging system.
 void setDomainLogBroadcasterBufferSize(int bufferSize)
          Sets the size of the log message buffer for broadcasting to the domain log.
 void setDomainLogBroadcastFilter(weblogic.management.configuration.LogFilterMBean filter)
          Sets the filtering criteria for log events going to the domain log.
 void setDomainLogBroadcastSeverity(String severity)
           
 void setLog4jLoggingEnabled(boolean enableLog4j)
          Sets the value of the Log4jLoggingEnabled attribute.
 void setLogFileFilter(weblogic.management.configuration.LogFilterMBean filter)
          Sets the value of the LogFileFilter attribute.
 void setMemoryBufferFilter(weblogic.management.configuration.LogFilterMBean filter)
           
 void setMemoryBufferSeverity(String severity)
           
 void setMemoryBufferSize(int size)
           
 void setRedirectStderrToServerLogEnabled(boolean captureStderr)
           
 void setRedirectStdoutToServerLogEnabled(boolean captureStdout)
           
 void setStdoutFilter(weblogic.management.configuration.LogFilterMBean filter)
          Sets the value of the StdoutFilter attribute.
 
Methods inherited from interface weblogic.management.configuration.CommonLogMBean
getLogFileSeverity, getLoggerSeverity, getStacktraceDepth, getStdoutFormat, getStdoutSeverity, isStdoutLogStack, setLogFileSeverity, setLoggerSeverity, setStacktraceDepth, setStdoutFormat, setStdoutLogStack, setStdoutSeverity
 
Methods inherited from interface weblogic.management.configuration.LogFileMBean
getBufferSizeKB, getDateFormatPattern, getFileCount, getFileMinSize, getFileName, getFileTimeSpan, getLogFileRotationDir, getRotateLogOnStartup, getRotationTime, getRotationType, isNumberOfFilesLimited, setBufferSizeKB, setDateFormatPattern, setFileCount, setFileMinSize, setFileName, setFileTimeSpan, setFileTimeSpanFactor, setLogFileRotationDir, setNumberOfFilesLimited, setRotateLogOnStartup, setRotationTime, setRotationType
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getName, getNotes, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet
 
Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
 
Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes
 
Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister
 
Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener
 
Methods inherited from interface weblogic.descriptor.DescriptorBean
addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener
 

Method Detail

getLogFileFilter

weblogic.management.configuration.LogFilterMBean getLogFileFilter()

The filter configuration for the server log file.

A filter configuration defines simple filtering rules to limit the volume of log messages written to the log file.

Returns:
The LogFilterMBean configuration for the log file.
Since:
9.0.0.0

setLogFileFilter

void setLogFileFilter(weblogic.management.configuration.LogFilterMBean filter)

Sets the value of the LogFileFilter attribute.

Parameters:
filter - The filter configuration for filtering messages being written to the log file.
See Also:
LogMBean.getLogFileFilter()

getStdoutFilter

weblogic.management.configuration.LogFilterMBean getStdoutFilter()

The filter configuration for log events being sent to the standard out.

Returns:
The LogFilterMBean configuration for stdout.
Since:
9.0.0.0

setStdoutFilter

void setStdoutFilter(weblogic.management.configuration.LogFilterMBean filter)

Sets the value of the StdoutFilter attribute.

Parameters:
filter - The filter configuration for filtering messages being written to the stdout.
See Also:
LogMBean.getStdoutFilter()

getDomainLogBroadcastSeverity

String getDomainLogBroadcastSeverity()
The minimum severity of log messages going to the domain log from this server's log broadcaster. Messages with a lower severity than the specified value will not be published to the domain log.

Since:
9.0.0.0
Default Value:
weblogic.logging.Severities.NOTICE_TEXT
Valid Values:
weblogic.logging.Severities.DEBUG_TEXT, weblogic.logging.Severities.INFO_TEXT, weblogic.logging.Severities.WARNING_TEXT, weblogic.logging.Severities.ERROR_TEXT, weblogic.logging.Severities.NOTICE_TEXT, weblogic.logging.Severities.CRITICAL_TEXT, weblogic.logging.Severities.ALERT_TEXT, weblogic.logging.Severities.EMERGENCY_TEXT, weblogic.logging.Severities.OFF_TEXT

setDomainLogBroadcastSeverity

void setDomainLogBroadcastSeverity(String severity)

getDomainLogBroadcastFilter

weblogic.management.configuration.LogFilterMBean getDomainLogBroadcastFilter()
The filter configuration for log events being sent to the domain log.

Returns:
The LogFilterMBean configuration for broadcast to the domain log.
Since:
9.0.0.0

setDomainLogBroadcastFilter

void setDomainLogBroadcastFilter(weblogic.management.configuration.LogFilterMBean filter)
Sets the filtering criteria for log events going to the domain log.

Parameters:
filter - The filter configuration for filtering messages being broadcast to the domain log.

getMemoryBufferSeverity

String getMemoryBufferSeverity()

The minimum severity of log messages going to the memory buffer of recent log events. Messages with a lower severity than the specified value will not be cached in the buffer.

Since:
9.0.0.0
Default Value:
weblogic.logging.Severities.TRACE_TEXT
Valid Values:
weblogic.logging.Severities.TRACE_TEXT, weblogic.logging.Severities.DEBUG_TEXT, weblogic.logging.Severities.INFO_TEXT, weblogic.logging.Severities.WARNING_TEXT, weblogic.logging.Severities.ERROR_TEXT, weblogic.logging.Severities.NOTICE_TEXT, weblogic.logging.Severities.CRITICAL_TEXT, weblogic.logging.Severities.ALERT_TEXT, weblogic.logging.Severities.EMERGENCY_TEXT, weblogic.logging.Severities.OFF_TEXT

setMemoryBufferSeverity

void setMemoryBufferSeverity(String severity)

getMemoryBufferFilter

weblogic.management.configuration.LogFilterMBean getMemoryBufferFilter()

The filter configuration for messages that are stored in the log memory buffer. By default, all log messages are cached.

Since:
9.0.0.0

setMemoryBufferFilter

void setMemoryBufferFilter(weblogic.management.configuration.LogFilterMBean filter)

getMemoryBufferSize

int getMemoryBufferSize()

The size of the memory buffer that holds the last n log records. This is used to support viewing the most recent log record entries (tail viewing) from the WebLogic Administration Console.

Since:
9.0.0.0
Default Value:
LogMBean.DEFAULT_MEMORY_BUFFER_SIZE
Maximum Value:
5000
Minimum Value:
100

setMemoryBufferSize

void setMemoryBufferSize(int size)

isLog4jLoggingEnabled

boolean isLog4jLoggingEnabled()

Specifies whether the server logging is based on a Log4j implementation. By default, WebLogic logging uses an implementation based on the Java Logging APIs which are part of the JDK.

Applications that use the WebLogic Message Catalog framework or the NonCatalogLogger will not be affected by the underlying Logging implementation.

Since:
9.0.0.0
Default Value:
false

setLog4jLoggingEnabled

void setLog4jLoggingEnabled(boolean enableLog4j)

Sets the value of the Log4jLoggingEnabled attribute.

See Also:
LogMBean.isLog4jLoggingEnabled()

isRedirectStdoutToServerLogEnabled

boolean isRedirectStdoutToServerLogEnabled()
When enabled, this redirects the stdout of the JVM in which a WebLogic Server instance runs, to the WebLogic logging system. The stdout content is published to all the registered log destinations, like the server terminal console and log file.

Since:
9.0.0.0

setRedirectStdoutToServerLogEnabled

void setRedirectStdoutToServerLogEnabled(boolean captureStdout)

isRedirectStderrToServerLogEnabled

boolean isRedirectStderrToServerLogEnabled()
When enabled, this redirects the stderr of the JVM in which a WebLogic Server instance runs, to the WebLogic Logging system. The stderr content is published to all the registered log destinations, like the server terminal console and log file.

Since:
9.0.0.0

setRedirectStderrToServerLogEnabled

void setRedirectStderrToServerLogEnabled(boolean captureStderr)

getDomainLogBroadcasterBufferSize

int getDomainLogBroadcasterBufferSize()

Broadcasts log messages to the domain log in batch mode.

The size of the buffer for log messages that are sent to the domain log. The buffer is maintained on the Managed Server and gets broadcasted to the domain log when it gets full.

Returns:
Since:
9.0.0.0
Default Value:
1
Maximum Value:
100
Minimum Value:
1
Default value in production mode:
10

setDomainLogBroadcasterBufferSize

void setDomainLogBroadcasterBufferSize(int bufferSize)
Sets the size of the log message buffer for broadcasting to the domain log.

Parameters:
bufferSize -

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs100
Copyright 2006 BEA Systems Inc.