Oracle

weblogic.management.configuration
Interface WebServerLogMBean

All Superinterfaces:
ConfigurationMBean, LogFileMBean

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://edocs.bea.com.


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
getBufferSizeKB, getDateFormatPattern, getFileCount, getFileMinSize, getFileTimeSpan, getLogFileRotationDir, getRotateLogOnStartup, getRotationTime, getRotationType, isNumberOfFilesLimited, setBufferSizeKB, setDateFormatPattern, 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
 

Method Detail

getFileName

String getFileName()

The name of the log file.

Specified by:
getFileName in interface LogFileMBean
Returns:
The fileName value

setFileName

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:
WebServerLogMBean.getFileName(), MachineMBean

setLoggingEnabled

void setLoggingEnabled(boolean enable)

Sets the value of the loggingEnabled attribute.

Parameters:
enable - The new loggingEnabled value
See Also:
WebServerLogMBean.isLoggingEnabled()
Default Value:
true

isLoggingEnabled

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

getELFFields

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"

setELFFields

void setELFFields(String fields)
                  throws InvalidAttributeValueException,
                         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
DistributedManagementException
See Also:
WebServerLogMBean.getELFFields()
This method can NOT set a value of zero length.

getLogFileFormat

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
Valid Values:
WebServerLogMBean.COMMON_LOG_FORMAT, WebServerLogMBean.EXTENDED_LOG_FORMAT

setLogFileFormat

void setLogFileFormat(String format)
                      throws InvalidAttributeValueException,
                             DistributedManagementException

Sets the value of the logFileFormat attribute.

Parameters:
format - The new logFileFormat value
Throws:
InvalidAttributeValueException
DistributedManagementException
See Also:
WebServerLogMBean.getLogFileFormat()

isLogTimeInGMT

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

setLogTimeInGMT

void setLogTimeInGMT(boolean useGMT)

Sets the value of the logTimeInGMT attribute.

Parameters:
useGMT - The new logTimeInGMT value
See Also:
WebServerLogMBean.isLogTimeInGMT()

Documentation is available at
http://edocs.bea.com/wls/docs103
Copyright 2008 Oracle