weblogic.management.configuration

Interface WebServerLogMBean

All Superinterfaces:

ConfigurationMBean, DescriptorBean, javax.management.DynamicMBean, LogFileMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, WebLogicMBean

public interface WebServerLogMBean
extends LogFileMBean

Aggregates the logging attributes for the WebServerMBean.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMON_LOG_FORMAT
static java.lang.String	DATE_COLUMN_NAME
static java.lang.String	DEFAULT_ACCESS_LOG_FILE_NAME
static java.lang.String	EXTENDED_LOG_FORMAT
static java.lang.String	TIME_COLUMN_NAME

Fields inherited from interface weblogic.management.configuration.LogFileMBean

DEFAULT_FILE_EXTENSION, DEFAULT_FILE_NAME, FILE_SEP, LOGS_DIR, MAX_ROTATED_FILES, NONE, SIZE, TIME, TIME_FORMAT

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

Modifier and Type	Method and Description
java.lang.String	getELFFields() Returns the list of fields specified for the extended logging format for access.log.
java.lang.String	getFileName() The name of the log file.
java.lang.String	getLogFileFormat() The format of the HTTP log file.
boolean	isLoggingEnabled() Indicates whether this server logs HTTP requests.
boolean	isLogMilliSeconds() Specifies if HTTP log messages should contain MilliSeconds.
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(java.lang.String fields) Sets the fields for the extended logging format for access.log.
void	setFileName(java.lang.String fileName) Sets the value of the fileName attribute.
void	setLogFileFormat(java.lang.String format) Sets the value of the logFileFormat attribute.
void	setLoggingEnabled(boolean enable) Sets the value of the loggingEnabled attribute.
void	setLogMilliSeconds(boolean logMillis) Sets the value of LogMilliSeconds attribute.
void	setLogTimeInGMT(boolean useGMT) Sets the value of the logTimeInGMT attribute.

Methods inherited from interface weblogic.management.configuration.LogFileMBean

computeLogFilePath, getBufferSizeKB, getDateFormatPattern, getFileCount, getFileMinSize, getFileTimeSpan, getFileTimeSpanFactor, getLogFilePath, getLogFileRotationDir, getLogRotationDirPath, getOutputStream, getRotateLogOnStartup, getRotationTime, getRotationType, isNumberOfFilesLimited, setBufferSizeKB, setDateFormatPattern, setFileCount, setFileMinSize, setFileTimeSpan, setFileTimeSpanFactor, setLogFileRotationDir, setNumberOfFilesLimited, setOutputStream, setRotateLogOnStartup, setRotationTime, setRotationType

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

addTag, freezeCurrentValue, getComments, getId, getInheritedProperties, getName, getNotes, getTags, isDefaultedMBean, isDynamicallyCreated, isInherited, isPersistenceEnabled, isSet, removeTag, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, setTags, touch, 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

Field Detail

DEFAULT_ACCESS_LOG_FILE_NAME

static final java.lang.String DEFAULT_ACCESS_LOG_FILE_NAME

See Also:

Constant Field Values

Excluded in public API Reference.

Excluded in public API Reference (Marked as @internal).

COMMON_LOG_FORMAT

static final java.lang.String COMMON_LOG_FORMAT

See Also:

Constant Field Values

Excluded in public API Reference.

Excluded in public API Reference (Marked as @internal).

EXTENDED_LOG_FORMAT

static final java.lang.String EXTENDED_LOG_FORMAT

See Also:

Constant Field Values

Excluded in public API Reference.

Excluded in public API Reference (Marked as @internal).

DATE_COLUMN_NAME

static final java.lang.String DATE_COLUMN_NAME

See Also:

Constant Field Values

Excluded in public API Reference.

Excluded in public API Reference (Marked as @internal).

TIME_COLUMN_NAME

static final java.lang.String TIME_COLUMN_NAME

See Also:

Constant Field Values

Excluded in public API Reference.

Excluded in public API Reference (Marked as @internal).

Method Detail

getFileName

java.lang.String getFileName()

The name of the log file.

Specified by:

getFileName in interface LogFileMBean

Returns:

The fileName value

setFileName

void setFileName(java.lang.String fileName)
          throws javax.management.InvalidAttributeValueException

Sets the value of the fileName attribute.

Specified by:

setFileName in interface LogFileMBean

Parameters:

fileName - The new fileName value

Throws:

javax.management.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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

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

java.lang.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"

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setELFFields

void setELFFields(java.lang.String fields)
           throws javax.management.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:

javax.management.InvalidAttributeValueException

DistributedManagementException

See Also:

WebServerLogMBean.getELFFields()

This property cannot have a value of length zero.

getLogFileFormat

java.lang.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(java.lang.String format)
               throws javax.management.InvalidAttributeValueException,
                      DistributedManagementException

Sets the value of the logFileFormat attribute.

Parameters:

format - The new logFileFormat value

Throws:

javax.management.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()

isLogMilliSeconds

boolean isLogMilliSeconds()

Specifies if HTTP log messages should contain MilliSeconds.

Returns:

the logMilliSeconds value

Default Value:

false

Excluded in public API Reference.

Excluded in public API Reference (Marked as @internal).

setLogMilliSeconds

void setLogMilliSeconds(boolean logMillis)

Sets the value of LogMilliSeconds attribute.

Parameters:

logMillis - - The new logMilliSeconds value

Excluded in public API Reference.

Excluded in public API Reference (Marked as @internal).