org.apache.geronimo.system.logging
Interface SystemLog

All Known Implementing Classes:
Log4jService

public interface SystemLog


Nested Class Summary
static class SystemLog.LogMessage
           
static class SystemLog.SearchResults
           
 
Field Summary
static int MAX_SEARCH_RESULTS
          The most search lines that will ever be returned, no matter what you ask for.
 
Method Summary
 String getConfigFileName()
          Gets the name of the file that configures the log system
 String[] getLogFileNames()
          Gets the name of all log files used by this log system.
 SystemLog.SearchResults getMatchingItems(String logFile, Integer firstLine, Integer lastLine, String minLevel, String regex, int maxResults, boolean includeStackTraces)
          Searches the log for records matching the specified parameters.
 int getRefreshPeriodSeconds()
          Indicates how often the log system should check to see if its configuration file has been updated.
 String getRootLoggerLevel()
          Gets the name of the log level used for the root logger.
 void setConfigFileName(String fileName)
          Sets the name of the file that the log system should configure itself from.
 void setRefreshPeriodSeconds(int seconds)
          Sets how often the log system should check to see if its configuration file has been updated.
 void setRootLoggerLevel(String level)
          Sets the name of the log level used for the root logger.
 

Field Detail

MAX_SEARCH_RESULTS

static final int MAX_SEARCH_RESULTS
The most search lines that will ever be returned, no matter what you ask for. This is to conserve memory and transfer bandwidth.

See Also:
Constant Field Values
Method Detail

getConfigFileName

String getConfigFileName()
Gets the name of the file that configures the log system


setConfigFileName

void setConfigFileName(String fileName)
Sets the name of the file that the log system should configure itself from.


getRootLoggerLevel

String getRootLoggerLevel()
Gets the name of the log level used for the root logger.


setRootLoggerLevel

void setRootLoggerLevel(String level)
Sets the name of the log level used for the root logger. Legal values are defined in GeronimoLogging.java (currently TRACE, DEBUG, INFO, WARN, ERROR, FATAL)


getRefreshPeriodSeconds

int getRefreshPeriodSeconds()
Indicates how often the log system should check to see if its configuration file has been updated.


setRefreshPeriodSeconds

void setRefreshPeriodSeconds(int seconds)
Sets how often the log system should check to see if its configuration file has been updated.


getLogFileNames

String[] getLogFileNames()
Gets the name of all log files used by this log system. Typically there is only one, but specialized cases may use more.


getMatchingItems

SystemLog.SearchResults getMatchingItems(String logFile,
                                         Integer firstLine,
                                         Integer lastLine,
                                         String minLevel,
                                         String regex,
                                         int maxResults,
                                         boolean includeStackTraces)
Searches the log for records matching the specified parameters. The maximum results returned will be the lesser of 1000 and the provided maxResults argument.

See Also:
MAX_SEARCH_RESULTS


Copyright © 2003-2008 The Apache Geronimo development community. All Rights Reserved.