com.sun.jbi.management.support

Class MBeanHelper

java.lang.Object

com.sun.jbi.management.support.MBeanHelper

All Implemented Interfaces:

MBeanHelper, Constants

public class MBeanHelper
extends Object
implements MBeanHelper, Constants

Implementation of MBeanHelper interface.

Author:

Sun Microsystems, Inc.

Field Summary

Fields inherited from interface com.sun.jbi.util.Constants

ADMIN_RUNNING_FILE, ADMIN_STOPPED_FILE, CONFIG_NAME_KEY, LOG_LEVEL_DEFAULT, TMP_FOLDER

Constructor Summary

Constructors

Constructor and Description
MBeanHelper(MBeanServer aMBeanServer, MBeanNames aMBeanNames, Logger aLogger) Constructs a MBeanHelper.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	createSystemServiceLoggerMBean(String aService, Logger aLogger) Create a LoggerMBean and associate it with aLogger.
boolean	destroySystemServiceLoggerMBean(String aService) Destroy the LoggerMBean registered for aService.
boolean	destroySystemServiceLoggerMBean(String aService, Logger aLogger) Destroy a LoggerMBean registered for aService.
static ObjectName	getLoggerConfigMBeanName()
static Level	getLogLevel(String attrName, EnvironmentContext envCtx) Get the value of the management log level
static ObjectName	getSystemConfigMBeanName()
static void	revertToGlobalLogLevel(String logName, EnvironmentContext envCtx, Logger aLogger) Revert to the global log level.
static void	setLogLevel(String logName, String logLevel, EnvironmentContext envCtx, Logger aLogger) Set the value of the management log level

Methods inherited from class java.lang.Object

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

Constructor Detail

MBeanHelper

public MBeanHelper(MBeanServer aMBeanServer,
           MBeanNames aMBeanNames,
           Logger aLogger)

Constructs a MBeanHelper. This class is meant to be instantiated only once by the framework.

Parameters:

aMBeanServer - is the MBean server provided by the framework.

aMBeanNames - is the MBeanNames instance created by the framework.

aLogger - is where this class should log messages.

Method Detail

createSystemServiceLoggerMBean

public boolean createSystemServiceLoggerMBean(String aService,
                                     Logger aLogger)

Create a LoggerMBean and associate it with aLogger.

Specified by:

createSystemServiceLoggerMBean in interface MBeanHelper

Parameters:

aService - is the name of the schemaorg_apache_xmlbeans.system service that owns the logger.

aLogger - is the Logger to associate with the LoggerMBean.

Returns:

true if successful, otherwise false.

destroySystemServiceLoggerMBean

public boolean destroySystemServiceLoggerMBean(String aService)

Destroy the LoggerMBean registered for aService.

Specified by:

destroySystemServiceLoggerMBean in interface MBeanHelper

Parameters:

aService - is the name of the schemaorg_apache_xmlbeans.system service that owns the logger.

Returns:

true if successful, otherwise false.

destroySystemServiceLoggerMBean

public boolean destroySystemServiceLoggerMBean(String aService,
                                      Logger aLogger)

Destroy a LoggerMBean registered for aService.

Specified by:

destroySystemServiceLoggerMBean in interface MBeanHelper

Parameters:

aService - is the name of the schemaorg_apache_xmlbeans.system service that owns the logger.

aLogger - is the Logger associated with the LoggerMBean.

Returns:

true if successful, otherwise false.

getLogLevel

public static Level getLogLevel(String attrName,
                EnvironmentContext envCtx)

Get the value of the management log level

Parameters:

envCtx - - management context

attrName - - name of the logger

Returns:

the log level of the requested logger or null if logger not found

setLogLevel

public static void setLogLevel(String logName,
               String logLevel,
               EnvironmentContext envCtx,
               Logger aLogger)

Set the value of the management log level

Parameters:

envCtx - - environment context

logName - - name of the logger

logLevel - - the log level string

revertToGlobalLogLevel

public static void revertToGlobalLogLevel(String logName,
                          EnvironmentContext envCtx,
                          Logger aLogger)

Revert to the global log level. This causes the persisted attribute to be deleted from the target for the instance. The global log level ( which is the same as the default / com.sun.jbi log level.

Parameters:

loggerName - - name of the logger whose override is to be deleted

envCtx - - environment context

aLogger - - logger to log any warnings to

getLoggerConfigMBeanName

public static ObjectName getLoggerConfigMBeanName()

Returns:

the object name of the Logger Configuration MBean on the instance

getSystemConfigMBeanName

public static ObjectName getSystemConfigMBeanName()

Returns:

the object name of the System Configuration MBean on the instance