com.sun.enterprise.config.serverbeans
Interface LogService

All Superinterfaces:

org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.component.Injectable

public interface LogService
extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.component.Injectable

By default, logs would be kept in $INSTANCE-ROOT/logs. The following log files will be stored under the logs directory. access.log keeps default virtual server HTTP access messages. server.log keeps log messages from default virtual server. Messages from other configured virtual servers also go here, unless log-file is explicitly specified in the virtual-server element.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

org.jvnet.hk2.config.ConfigBeanProxy.Duck

Method Summary

String	getAlarms() Gets the value of the alarms property.
String	getFile() Gets the value of the file property.
String	getLogFilter() Gets the value of the logFilter property.
String	getLogHandler() Gets the value of the logHandler property.
String	getLogRotationLimitInBytes() Gets the value of the logRotationLimitInBytes property.
String	getLogRotationTimelimitInMinutes() Gets the value of the logRotationTimelimitInMinutes property.
String	getLogToConsole() Gets the value of the logToConsole property.
ModuleLogLevels	getModuleLogLevels() Gets the value of the moduleLogLevels property.
String	getRetainErrorStatisticsForHours() Gets the value of the retainErrorStatisticsForHours property.
String	getUseSystemLogging() Gets the value of the useSystemLogging property.
void	setAlarms(String value) Sets the value of the alarms property.
void	setFile(String value) Sets the value of the file property.
void	setLogFilter(String value) Sets the value of the logFilter property.
void	setLogHandler(String value) Sets the value of the logHandler property.
void	setLogRotationLimitInBytes(String value) Sets the value of the logRotationLimitInBytes property.
void	setLogRotationTimelimitInMinutes(String value) Sets the value of the logRotationTimelimitInMinutes property.
void	setLogToConsole(String value) Sets the value of the logToConsole property.
void	setModuleLogLevels(ModuleLogLevels value) Sets the value of the moduleLogLevels property.
void	setRetainErrorStatisticsForHours(String value) Sets the value of the retainErrorStatisticsForHours property.
void	setUseSystemLogging(String value) Sets the value of the useSystemLogging property.

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

createChild, deepCopy, getParent, getParent

Methods inherited from interface org.jvnet.hk2.component.Injectable

injectedInto

Method Detail

getFile

String getFile()

Gets the value of the file property. Can be used to rename or relocate server.log using absolute path.

Returns:

possible object is String

setFile

void setFile(String value)
             throws PropertyVetoException

Sets the value of the file property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getUseSystemLogging

String getUseSystemLogging()

Gets the value of the useSystemLogging property. If true, will utilize Unix syslog service or Windows Event Logging to produce and manage logs.

Returns:

possible object is String

setUseSystemLogging

void setUseSystemLogging(String value)
                         throws PropertyVetoException

Sets the value of the useSystemLogging property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getLogHandler

String getLogHandler()

Gets the value of the logHandler property. Can plug in a custom log handler to add it to the chain of handlers to log into a different log destination than the default ones given by the system (which are Console, File and Syslog). It is a requirement that customers use the log formatter provided by the the system to maintain uniformity in log messages. The custom log handler will be added at the end of the handler chain after File + Syslog Handler, Console Handler and JMX Handler. User cannot replace the handler provided by the system, because of loosing precious log statements. The Server Initialization will take care of installing the custom handler with the system formatter initialized. The user need to use JSR 047 Log Handler Interface to implement the custom handler.

Returns:

possible object is String

setLogHandler

void setLogHandler(String value)
                   throws PropertyVetoException

Sets the value of the logHandler property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getLogFilter

String getLogFilter()

Gets the value of the logFilter property. Can plug in a log filter to do custom filtering of log records. By default there is no log filter other than the log level filtering provided by JSR 047 log API.

Returns:

possible object is String

setLogFilter

void setLogFilter(String value)
                  throws PropertyVetoException

Sets the value of the logFilter property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getLogToConsole

String getLogToConsole()

Gets the value of the logToConsole property. logs will be sent to stderr when asadmin start-domain verbose is used

Returns:

possible object is String

setLogToConsole

void setLogToConsole(String value)
                     throws PropertyVetoException

Sets the value of the logToConsole property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getLogRotationLimitInBytes

@Min(value=1L)
String getLogRotationLimitInBytes()

Gets the value of the logRotationLimitInBytes property. Log Files will be rotated when the file size reaches the limit.

Returns:

possible object is String

setLogRotationLimitInBytes

void setLogRotationLimitInBytes(String value)
                                throws PropertyVetoException

Sets the value of the logRotationLimitInBytes property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getLogRotationTimelimitInMinutes

@Min(value=0L)
@Max(value=14400L)
String getLogRotationTimelimitInMinutes()

Gets the value of the logRotationTimelimitInMinutes property. This is a new attribute to enable time based log rotation. The Log File will be rotated only if this value is non-zero and the valid range is 60 minutes (1 hour) to 10*24*60 minutes (10 days). If the value is zero then the files will be rotated based on size specified in log-rotation-limit-in-bytes.

Returns:

possible object is String

setLogRotationTimelimitInMinutes

void setLogRotationTimelimitInMinutes(String value)
                                      throws PropertyVetoException

Sets the value of the logRotationTimelimitInMinutes property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAlarms

String getAlarms()

Gets the value of the alarms property. if true, will turn on alarms for the logger. The SEVERE and WARNING messages can be routed through the JMX framework to raise SEVERE and WARNING alerts. Alarms are turned off by default.

Returns:

possible object is String

setAlarms

void setAlarms(String value)
               throws PropertyVetoException

Sets the value of the alarms property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getRetainErrorStatisticsForHours

@Min(value=5L)
@Max(value=500L)
String getRetainErrorStatisticsForHours()

Gets the value of the retainErrorStatisticsForHours property. The number of hours since server start, for which error statistics should be retained in memory. The default and minimum value is 5 hours. The maximum value allowed is 500 hours. Note that larger values will incur additional memory overhead.

Returns:

possible object is String

setRetainErrorStatisticsForHours

void setRetainErrorStatisticsForHours(String value)
                                      throws PropertyVetoException

Sets the value of the retainErrorStatisticsForHours property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getModuleLogLevels

ModuleLogLevels getModuleLogLevels()

Gets the value of the moduleLogLevels property.

Returns:

possible object is ModuleLogLevels

setModuleLogLevels

void setModuleLogLevels(ModuleLogLevels value)
                        throws PropertyVetoException

Sets the value of the moduleLogLevels property.

Parameters:

value - allowed object is ModuleLogLevels

Throws:

PropertyVetoException