ch.elca.el4j.services.monitoring.jmx
Interface Log4jConfigMBean

All Known Implementing Classes:
Log4jConfig

public interface Log4jConfigMBean

The interface of the logging proxy class, for setting logging properties via JMX.

Author:
Rashid Waraich (RWA)
File-location:
Log4jConfigMBean
Last check-in date:
2010-01-15 14:26:34 +0100 (Fr, 15. Jan 2010) by jonasha for revision 4093

Method Summary
 void addAppender(String category, String appenderName)
          Add appender to the specified logger category.
 void changeLogLevel(String category, String level)
          Changes the log level for a category or creates a new category if the supplied category name doesn't exist.
 String[] getAvailableAppendersList()
          For all loaded appenders, a String representaion of the appenderName and appenderObject is returned.
 String getInitialConfigurationPath()
          Get the path of the log4j configuration file, which was loaded initially (at application start).
 String getName()
          Getter method for the name member variable.
 String getRootLoggerLevel()
          Gives back the level of the root logger.
 void removeAppender(String category, String appenderName)
          Remove appender from the specified logger category.
 void setRootLoggerLevel(String level)
          Sets the level of the root logger.
 org.apache.log4j.Appender[] showAppenders(String category)
          Return the appenders of the specified Logger category.
 org.apache.log4j.Level showLogLevel(String category)
          Return the log level of the Logger category.
 String showLogLevelCache()
          Shows the XML representation of all changes made to any logger level through the JMX interface.
 

Method Detail

getName

String getName()
Getter method for the name member variable.

Returns:
Returns the name.

changeLogLevel

void changeLogLevel(String category,
                    String level)
Changes the log level for a category or creates a new category if the supplied category name doesn't exist.

Parameters:
category - The category of the logger.
level - The level of the logger to be set.

addAppender

void addAppender(String category,
                 String appenderName)
Add appender to the specified logger category.

Parameters:
category - The category of the logger.
appenderName - The name of the appender to be removed.

removeAppender

void removeAppender(String category,
                    String appenderName)
Remove appender from the specified logger category.

Parameters:
category - The category of the logger.
appenderName - The name of the appender to be removed.

getAvailableAppendersList

String[] getAvailableAppendersList()
For all loaded appenders, a String representaion of the appenderName and appenderObject is returned.

Returns:
The available appenders.

showLogLevel

org.apache.log4j.Level showLogLevel(String category)
Return the log level of the Logger category.

Parameters:
category - The category.
Returns:
The level.

showAppenders

org.apache.log4j.Appender[] showAppenders(String category)
Return the appenders of the specified Logger category.

Parameters:
category - The category.
Returns:
The appenders.

setRootLoggerLevel

void setRootLoggerLevel(String level)
Sets the level of the root logger.

Parameters:
level - The logging level.

getRootLoggerLevel

String getRootLoggerLevel()
Gives back the level of the root logger.

Returns:
The logging level.

showLogLevelCache

String showLogLevelCache()
Shows the XML representation of all changes made to any logger level through the JMX interface.

Returns:
HTML embeddable XML (suitable for pasting in log4j.xml)

getInitialConfigurationPath

String getInitialConfigurationPath()
Get the path of the log4j configuration file, which was loaded initially (at application start).

Returns:
The path of the configuration file.


Copyright © 2005-2011 ELCA. All Rights Reserved.