Type-Safe Access to BEA WebLogic Server 9.0 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated MBeanHome interface.)

weblogic.management.configuration
Interface WebServerLogMBean

All Superinterfaces:

ConfigurationMBean, weblogic.descriptor.DescriptorBean, DynamicMBean, LogFileMBean, MBeanRegistration, NotificationBroadcaster, weblogic.descriptor.SettableBean, weblogic.management.WebLogicMBean

public interface WebServerLogMBean

extends LogFileMBean

Aggregates the logging attributes for the WebServerMBean.

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.

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Field Summary

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

String	getELFFields() Returns the list of fields specified for the extended logging format for access.log.
String	getFileName() The name of the log file.
String	getLogFileFormat() The format of the HTTP log file.
boolean	isLoggingEnabled() Indicates whether this server logs HTTP requests.
boolean	isLogTimeInGMT() Specifies whether the time stamps for HTTP log messages are in Greenwich Mean Time (GMT) regardless of the local time zone that the host computer specifies.
void	setELFFields(String fields) Sets the fields for the extended logging format for access.log.
void	setFileName(String fileName) Sets the value of the fileName attribute.
void	setLogFileFormat(String format) Sets the value of the logFileFormat attribute.
void	setLoggingEnabled(boolean enable) Sets the value of the loggingEnabled attribute.
void	setLogTimeInGMT(boolean useGMT) Sets the value of the logTimeInGMT attribute.

Methods inherited from interface weblogic.management.configuration.LogFileMBean

getFileCount, getFileMinSize, getFileTimeSpan, getLogFileRotationDir, getRotateLogOnStartup, getRotationTime, getRotationType, isNumberOfFilesLimited, setFileCount, setFileMinSize, 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

getELFFields

public String getELFFields()

Returns the list of fields specified for the extended logging format for access.log.

Returns:

"Fields" for extended logging format

Default value:

"date time cs-method cs-uri sc-status"

A configurable MBean attribute.

getFileName

public String getFileName()

The name of the log file.

Specified by:

getFileName in interface LogFileMBean

Returns:

The fileName value

A configurable MBean attribute.

getLogFileFormat

public String getLogFileFormat()

The format of the HTTP log file. Both formats are defined by the W3C. With the extended log format, you use server directives in the log file to customize the information that the server records.

Returns:

The logFileFormat value

Default value:

WebServerLogMBean.COMMON_LOG_FORMAT

Legal values:

WebServerLogMBean.COMMON_LOG_FORMAT, WebServerLogMBean.EXTENDED_LOG_FORMAT

A configurable MBean attribute.

isLoggingEnabled

public boolean isLoggingEnabled()

Indicates whether this server logs HTTP requests. (The remaining fields on this page are relevant only if you select this check box.)

Gets the loggingEnabled attribute of the WebServerMBean object.

Returns:

The loggingEnabled value

isLogTimeInGMT

public boolean isLogTimeInGMT()

Specifies whether the time stamps for HTTP log messages are in Greenwich Mean Time (GMT) regardless of the local time zone that the host computer specifies.

Use this method to comply with the W3C specification for Extended Format log files. The specification states that all time stamps for Extended Format log entries be in GMT.

This method applies only if you have specified the extended message format.

Returns:

The logTimeInGMT value

Default value:

false

A configurable MBean attribute.

setELFFields

public void setELFFields(String fields)
                  throws InvalidAttributeValueException,
                         weblogic.management.DistributedManagementException

Sets the fields for the extended logging format for access.log. The string passed in must be a space delimited list of fields. For example: "time cs-method cs-uri sc-status". Please check the documentation for supported fields.

Parameters:

fields - (eg: "time cs-method cs-uri sc-status")

Throws:

InvalidAttributeValueException

weblogic.management.DistributedManagementException

See Also:

getELFFields()

setFileName

public void setFileName(String fileName)
                 throws InvalidAttributeValueException

Sets the value of the fileName attribute.

Specified by:

setFileName in interface LogFileMBean

Parameters:

fileName - The new fileName value

Throws:

InvalidAttributeValueException

See Also:

getFileName(), MachineMBean

setLogFileFormat

public void setLogFileFormat(String format)
                      throws InvalidAttributeValueException,
                             weblogic.management.DistributedManagementException

Sets the value of the logFileFormat attribute.

Parameters:

format - The new logFileFormat value

Throws:

InvalidAttributeValueException

weblogic.management.DistributedManagementException

See Also:

getLogFileFormat()

setLoggingEnabled

public void setLoggingEnabled(boolean enable)

Sets the value of the loggingEnabled attribute.

Parameters:

enable - The new loggingEnabled value

See Also:

isLoggingEnabled()

Default value:

true

A configurable MBean attribute.

setLogTimeInGMT

public void setLogTimeInGMT(boolean useGMT)

Sets the value of the logTimeInGMT attribute.

Parameters:

useGMT - The new logTimeInGMT value

See Also:

isLogTimeInGMT()