org.apache.qpid.management.common.mbeans
Interface LoggingManagement


public interface LoggingManagement

Interface for the LoggingManagement MBean

Since:
Qpid JMX API 1.2

Field Summary
static List<String> COMPOSITE_ITEM_DESCRIPTIONS
           
static List<String> COMPOSITE_ITEM_NAMES
           
static String LOGGER_LEVEL
           
static String LOGGER_NAME
           
static List<String> TABULAR_UNIQUE_INDEX
           
static String TYPE
           
 
Method Summary
 String[] getAvailableLoggerLevels()
          Attribute to represent the available log4j logger output levels.
 String getConfigFileRootLoggerLevel()
          Attribute to represent the level of the Log4J RootLogger within the xml configuration file
 Integer getLog4jLogWatchInterval()
          Attribute to represent the log4j xml configuration file's LogWatch interval.
 String getRuntimeRootLoggerLevel()
          Attribute to represent the level of the active Log4J RootLogger
 void reloadConfigFile()
          Reloads the log4j configuration file, applying any changes made.
 boolean setConfigFileLoggerLevel(String logger, String level)
          Updates the level of an existing Log4J logger within the xml configuration file
 boolean setConfigFileRootLoggerLevel(String level)
          Updates the level of the Log4J RootLogger within the xml configuration file if it is present
 boolean setRuntimeLoggerLevel(String logger, String level)
          Sets the level of an active Log4J logger
 boolean setRuntimeRootLoggerLevel(String level)
          Sets the level of the active Log4J RootLogger
 TabularData viewConfigFileLoggerLevels()
          Retrieves a TabularData set of the existing Log4J loggers within the xml configuration file
 TabularData viewEffectiveRuntimeLoggerLevels()
          Retrieves a TabularData set of the active log4j loggers and their levels
 

Field Detail

TYPE

static final String TYPE
See Also:
Constant Field Values

LOGGER_NAME

static final String LOGGER_NAME
See Also:
Constant Field Values

LOGGER_LEVEL

static final String LOGGER_LEVEL
See Also:
Constant Field Values

COMPOSITE_ITEM_NAMES

static final List<String> COMPOSITE_ITEM_NAMES

COMPOSITE_ITEM_DESCRIPTIONS

static final List<String> COMPOSITE_ITEM_DESCRIPTIONS

TABULAR_UNIQUE_INDEX

static final List<String> TABULAR_UNIQUE_INDEX
Method Detail

getLog4jLogWatchInterval

Integer getLog4jLogWatchInterval()
Attribute to represent the log4j xml configuration file's LogWatch interval.

Returns:
The logwatch interval in seconds.
Since:
Qpid JMX API 1.2

getAvailableLoggerLevels

String[] getAvailableLoggerLevels()
Attribute to represent the available log4j logger output levels.

Returns:
The logging level names.
Since:
Qpid JMX API 1.2

setRuntimeLoggerLevel

boolean setRuntimeLoggerLevel(String logger,
                              String level)
Sets the level of an active Log4J logger

Parameters:
logger - The name of the logger
level - The level to set the logger to
Returns:
True if successful, false if unsuccessful (eg if an invalid level is specified)
Since:
Qpid JMX API 1.2

viewEffectiveRuntimeLoggerLevels

TabularData viewEffectiveRuntimeLoggerLevels()
Retrieves a TabularData set of the active log4j loggers and their levels

Returns:
TabularData set of CompositeData rows with logger name and level, or null if there is a problem with the TabularData type
Since:
Qpid JMX API 1.2

setRuntimeRootLoggerLevel

boolean setRuntimeRootLoggerLevel(String level)
Sets the level of the active Log4J RootLogger

Parameters:
level - The level to set the RootLogger to
Returns:
True if successful, false if unsuccessful (eg if an invalid level is specified)
Since:
Qpid JMX API 1.2

getRuntimeRootLoggerLevel

String getRuntimeRootLoggerLevel()
Attribute to represent the level of the active Log4J RootLogger

Returns:
The level of the RootLogger.
Since:
Qpid JMX API 1.2

reloadConfigFile

void reloadConfigFile()
                      throws IOException
Reloads the log4j configuration file, applying any changes made.

Throws:
IOException
Since:
Qpid JMX API 1.4

setConfigFileLoggerLevel

boolean setConfigFileLoggerLevel(String logger,
                                 String level)
                                 throws IOException
Updates the level of an existing Log4J logger within the xml configuration file

Parameters:
logger - The name of the logger
level - The level to set the logger to
Returns:
True if successful, false if unsuccessful (eg if an invalid logger or level is specified)
Throws:
IOException - if there is an error parsing the configuration file.
Since:
Qpid JMX API 1.2

viewConfigFileLoggerLevels

TabularData viewConfigFileLoggerLevels()
                                       throws IOException
Retrieves a TabularData set of the existing Log4J loggers within the xml configuration file

Returns:
TabularData set of CompositeData rows with logger name and level, or null if there is a problem with the TabularData type
Throws:
IOException - if there is an error parsing the configuration file.
Since:
Qpid JMX API 1.2

setConfigFileRootLoggerLevel

boolean setConfigFileRootLoggerLevel(String level)
                                     throws IOException
Updates the level of the Log4J RootLogger within the xml configuration file if it is present

Parameters:
level - The level to set the logger to
Returns:
True if successful, false if not (eg an invalid level is specified, or root logger level isnt already defined)
Throws:
IOException - if there is an error parsing the configuration file.
Since:
Qpid JMX API 1.2

getConfigFileRootLoggerLevel

String getConfigFileRootLoggerLevel()
                                    throws IOException
Attribute to represent the level of the Log4J RootLogger within the xml configuration file

Returns:
The level of the RootLogger, or null if it is not present
Throws:
IOException
Since:
Qpid JMX API 1.2


Licensed to the Apache Software Foundation