WebServerLogMBean (Java API Reference for Oracle WebLogic Server)

Class

Use

Tree

Help

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.configuration
Interface WebServerLogMBean

All Superinterfaces:: ConfigurationMBean, DescriptorBean, DynamicMBean, LogFileMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

public interface WebServerLogMBean

extends LogFileMBean

Aggregates the logging attributes for the WebServerMBean.

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
`abstract String`	`getELFFields()` Returns the list of fields specified for the `extended` logging format for access.log.
`abstract String`	`getFileName()` The name of the log file.
`abstract String`	`getLogFileFormat()` The format of the HTTP log file.
`abstract boolean`	`isLoggingEnabled()` Indicates whether this server logs HTTP requests.
`abstract 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.
`abstract void`	`setELFFields(String fields)` Sets the fields for the extended logging format for access.log.
`abstract void`	`setFileName(String fileName)` Sets the value of the fileName attribute.
`abstract void`	`setLogFileFormat(String format)` Sets the value of the logFileFormat attribute.
`abstract void`	`setLoggingEnabled(boolean enable)` Sets the value of the loggingEnabled attribute.
`abstract 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.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, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, 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
`addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener`

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()

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

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()

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

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

setLogTimeInGMT

void setLogTimeInGMT(boolean useGMT)

Sets the value of the logTimeInGMT attribute.

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

Overview

Package