com.sun.jbi.framework

Interface ComponentLoggerMBean

public interface ComponentLoggerMBean

This interface defines the LoggerMBean for a Component (BC or SE). This MBean acts as an agent between the JMX management service and the UI runtime to provide operations for displaying and modifying the logger levels for all loggers created by a component.

Author:

Sun Microsystems, Inc.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName(String logName) Get the localized display name of the specified logger.
String	getLevel(String logName) Get the log level of the specified logger.
String[]	getLoggerNames() Get the names of all loggers controlled by this MBean.
int	setAll(String logName) Set the log level of the specified logger to ALL.
int	setConfig(String logName) Set the log level of the specified logger to CONFIG.
int	setDefault(String logName) Set the log level of the specified logger to the default, which is null to inherit the parent logger's level.
int	setFine(String logName) Set the log level of the specified logger to FINE.
int	setFiner(String logName) Set the log level of the specified logger to FINER.
int	setFinest(String logName) Set the log level of the specified logger to FINEST.
int	setInfo(String logName) Set the log level of the specified logger to INFO.
int	setOff(String logName) Set the log level of the specified logger to OFF.
int	setSevere(String logName) Set the log level of the specified logger to SEVERE.
int	setWarning(String logName) Set the log level of the specified logger to WARNING.

Method Detail

getDisplayName

String getDisplayName(String logName)

Get the localized display name of the specified logger.

Returns:

String representing the localized display name.

getLevel

String getLevel(String logName)
                throws JBIException

Get the log level of the specified logger. If the level is not set, search the parent logger chain until a logger is found with a level set.

Parameters:

logName - the name of the logger.

Returns:

String representing log level or null if no level is set.

Throws:

JBIException - if the logger is not found.

getLoggerNames

String[] getLoggerNames()

Get the names of all loggers controlled by this MBean.

Returns:

List a list of logger names as String objects.

setAll

int setAll(String logName)
           throws JBIException

Set the log level of the specified logger to ALL.

Parameters:

logName - the logger name.

Returns:

0 if operation is successful.

Throws:

JBIException - if the logger is not found.

setConfig

int setConfig(String logName)
              throws JBIException

Set the log level of the specified logger to CONFIG.

Parameters:

logName - the logger name.

Returns:

0 if operation is successful.

Throws:

JBIException - if the logger is not found.

setDefault

int setDefault(String logName)
               throws JBIException

Set the log level of the specified logger to the default, which is null to inherit the parent logger's level.

Parameters:

logName - the logger name.

Returns:

0 if operation is successful.

Throws:

JBIException - if the logger is not found.

setFine

int setFine(String logName)
            throws JBIException

Set the log level of the specified logger to FINE.

Parameters:

logName - the logger name.

Returns:

0 if operation is successful.

Throws:

JBIException - if the logger is not found.

setFiner

int setFiner(String logName)
             throws JBIException

Set the log level of the specified logger to FINER.

Parameters:

logName - the logger name.

Returns:

0 if operation is successful.

Throws:

JBIException - if the logger is not found.

setFinest

int setFinest(String logName)
              throws JBIException

Set the log level of the specified logger to FINEST.

Parameters:

logName - the logger name.

Returns:

0 if operation is successful.

Throws:

JBIException - if the logger is not found.

setInfo

int setInfo(String logName)
            throws JBIException

Set the log level of the specified logger to INFO.

Parameters:

logName - the logger name.

Returns:

0 if operation is successful.

Throws:

JBIException - if the logger is not found.

setOff

int setOff(String logName)
           throws JBIException

Set the log level of the specified logger to OFF.

Parameters:

logName - the logger name.

Returns:

0 if operation is successful.

Throws:

JBIException - if the logger is not found.

setSevere

int setSevere(String logName)
              throws JBIException

Set the log level of the specified logger to SEVERE.

Parameters:

logName - the logger name.

Returns:

0 if operation is successful.

Throws:

JBIException - if the logger is not found.

setWarning

int setWarning(String logName)
               throws JBIException

Set the log level of the specified logger to WARNING.

Parameters:

logName - the logger name.

Returns:

0 if operation is successful.

Throws:

JBIException - if the logger is not found.