org.apache.qpid.server.jmx.mbeans

Class LoggingManagementMBean

java.lang.Object

javax.management.StandardMBean

org.apache.qpid.server.jmx.DefaultManagedObject

org.apache.qpid.server.jmx.AMQManagedObject

org.apache.qpid.server.jmx.mbeans.LoggingManagementMBean

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, LoggingManagement, ManagedObject

public class LoggingManagementMBean
extends AMQManagedObject
implements LoggingManagement

MBean class for LoggingManagement. It implements all the management features exposed for managing logging.

Field Summary

Fields inherited from interface org.apache.qpid.management.common.mbeans.LoggingManagement

COMPOSITE_ITEM_DESCRIPTIONS, COMPOSITE_ITEM_NAMES, LOGGER_LEVEL, LOGGER_NAME, TABULAR_UNIQUE_INDEX, TYPE

Fields inherited from interface org.apache.qpid.server.jmx.ManagedObject

DOMAIN

Constructor Summary

Constructors

Constructor and Description
LoggingManagementMBean(BrokerFileLogger brokerFileLogger, ManagedObjectRegistry registry)

Method Summary

Modifier and Type	Method and Description
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	getObjectInstanceName()
ManagedObject	getParentObject()
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

Methods inherited from class org.apache.qpid.server.jmx.AMQManagedObject

addNotificationListener, getBroadcaster, incrementAndGetSequenceNumber, removeNotificationListener

Methods inherited from class org.apache.qpid.server.jmx.DefaultManagedObject

getHierarchicalName, getHierarchicalType, getManagementInterface, getMBeanInfo, getNotificationInfo, getObjectName, getObjectNameForSingleInstanceMBean, getRegistry, getType, register, toString, unregister

Methods inherited from class javax.management.StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInterface, getParameterName, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.management.NotificationBroadcaster

getNotificationInfo

Constructor Detail

LoggingManagementMBean

public LoggingManagementMBean(BrokerFileLogger brokerFileLogger,
                              ManagedObjectRegistry registry)
                       throws JMException

Throws:

JMException

Method Detail

getObjectInstanceName

public String getObjectInstanceName()

Specified by:

getObjectInstanceName in interface ManagedObject

Returns:

the name that uniquely identifies this object instance. It must be unique only among objects of this type at this level in the hierarchy so the uniqueness should not be too difficult to ensure.

getParentObject

public ManagedObject getParentObject()

Specified by:

getParentObject in interface ManagedObject

Specified by:

getParentObject in class DefaultManagedObject

getLog4jLogWatchInterval

public Integer getLog4jLogWatchInterval()

Description copied from interface: LoggingManagement

Attribute to represent the log4j xml configuration file's LogWatch interval.

Specified by:

getLog4jLogWatchInterval in interface LoggingManagement

Returns:

The logwatch interval in seconds.

getAvailableLoggerLevels

public String[] getAvailableLoggerLevels()

Description copied from interface: LoggingManagement

Attribute to represent the available log4j logger output levels.

Specified by:

getAvailableLoggerLevels in interface LoggingManagement

Returns:

The logging level names.

viewEffectiveRuntimeLoggerLevels

public TabularData viewEffectiveRuntimeLoggerLevels()

Description copied from interface: LoggingManagement

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

Specified by:

viewEffectiveRuntimeLoggerLevels in interface LoggingManagement

Returns:

TabularData set of CompositeData rows with logger name and level, or null if there is a problem with the TabularData type

getRuntimeRootLoggerLevel

public String getRuntimeRootLoggerLevel()

Description copied from interface: LoggingManagement

Attribute to represent the level of the active Log4J RootLogger

Specified by:

getRuntimeRootLoggerLevel in interface LoggingManagement

Returns:

The level of the RootLogger.

setRuntimeRootLoggerLevel

public boolean setRuntimeRootLoggerLevel(String level)

Description copied from interface: LoggingManagement

Sets the level of the active Log4J RootLogger

Specified by:

setRuntimeRootLoggerLevel in interface LoggingManagement

Parameters:

level - The level to set the RootLogger to

Returns:

True if successful, false if unsuccessful (eg if an invalid level is specified)

setRuntimeLoggerLevel

public boolean setRuntimeLoggerLevel(String logger,
                                     String level)

Description copied from interface: LoggingManagement

Sets the level of an active Log4J logger

Specified by:

setRuntimeLoggerLevel in interface LoggingManagement

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)

viewConfigFileLoggerLevels

public TabularData viewConfigFileLoggerLevels()

Description copied from interface: LoggingManagement

Retrieves a TabularData set of the existing Log4J loggers within the xml configuration file

Specified by:

viewConfigFileLoggerLevels in interface LoggingManagement

Returns:

TabularData set of CompositeData rows with logger name and level, or null if there is a problem with the TabularData type

getConfigFileRootLoggerLevel

public String getConfigFileRootLoggerLevel()
                                    throws IOException

Description copied from interface: LoggingManagement

Attribute to represent the level of the Log4J RootLogger within the xml configuration file

Specified by:

getConfigFileRootLoggerLevel in interface LoggingManagement

Returns:

The level of the RootLogger, or null if it is not present

Throws:

IOException

setConfigFileLoggerLevel

public boolean setConfigFileLoggerLevel(String logger,
                                        String level)

Description copied from interface: LoggingManagement

Updates the level of an existing Log4J logger within the xml configuration file

Specified by:

setConfigFileLoggerLevel in interface LoggingManagement

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)

setConfigFileRootLoggerLevel

public boolean setConfigFileRootLoggerLevel(String level)

Description copied from interface: LoggingManagement

Updates the level of the Log4J RootLogger within the xml configuration file if it is present

Specified by:

setConfigFileRootLoggerLevel in interface LoggingManagement

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)

reloadConfigFile

public void reloadConfigFile()
                      throws IOException

Description copied from interface: LoggingManagement

Reloads the log4j configuration file, applying any changes made.

Specified by:

reloadConfigFile in interface LoggingManagement

Throws:

IOException