org.mobicents.slee.container.management.console.server.mbeans

Class LogManagementMBeanUtils

java.lang.Object

org.mobicents.slee.container.management.console.server.mbeans.LogManagementMBeanUtils

public class LogManagementMBeanUtils
extends Object

Author:

baranowb

Constructor Summary

Constructors

Constructor and Description
LogManagementMBeanUtils(MBeanServerConnection mbeanServer, ObjectName sleeManagementMBean)

Method Summary

Methods

Modifier and Type	Method and Description
Level	_getDefaultHandlerLevel()
Level	_getDefaultLoggerLevel()
void	_setDefaultHandlerLevel(Level l)
void	_setDefaultLoggerLevel(Level l)
void	addHandler(String loggerName, String handlerName, String handlerClassName, String formaterClass, String filterClass, String[] constructorParameters, String[] paramValues)
boolean	addLogger(String name, Level level) Tries to add logger if it doesnt exist
boolean	addLogger(String name, String level) Tries to add logger if it doesnt exist
void	addNotificationHandler(String loggerName, int numberOfEntries, Level level, String formaterClassName, String filterClassName) Adds notification handler to logger if it exists.
void	addNotificationHandler(String loggerName, int numberOfEntries, String level, String formaterClassName, String filterClassName)
void	addSocketHandler(String loggerName, Level handlerLevel, String handlerName, String formaterClassName, String filterClassName, String host, int port) Adds SocketHandler to certain logger, this logger must exist prior this function is called
void	addSocketHandler(String loggerName, String handlerLevel, String handlerName, String formaterClassName, String filterClassName, String host, int port) Adds SocketHandler to certain logger, this logger must exist prior this function is called
void	clearLoggers() Removes(set level to Level.OFF, handlers are removed) all loggers that were created by this MBean - this will usually include loggers for whole packages.
void	clearLoggers(String name) Removes all loggers under certain branch.
String	fetchLog(String loggerName)
String	getDefaultHandlerLevel()
String	getDefaultLoggerLevel()
int	getDefaultNotificationInterval()
String	getGenericHandlerFilterClassName(String loggerName, int index)
String	getGenericHandlerFormatterClassName(String loggerName, int index)
String	getGenericHandlerLevel(String loggerName, int index)
String	getHandlerClassName(String loggerName, int index)
String	getHandlerClassName(String loggerName, String handlerName)
String	getHandlerFilterClassName(String loggerName, String handlerName)
String	getHandlerFormaterClassName(String loggerName, String handlerName)
String	getHandlerLevel(String loggerName, String handlerName) Fetches level of particular handler
String	getHandlerName(String loggerName, int index)
List	getHandlerNamesForLogger(String loggerName) Returns names of handlers for logger
int	getHandlerNotificationInterval(String loggerName)
String	getLoggerFilterClassName(String loggerName)
String	getLoggerLevel(String loggerName)
List<String>	getLoggerNames(String regex) SImilar to LoggingMXBean, return list of available loggers.
boolean	getUseParentHandlersFlag(String loggerName)
int	numberOfHandlers(String loggerName)
boolean	removeHandler(String loggerName, int index)
boolean	removeHandler(String loggerName, String handlerName) Tries to remove handler from logger.
void	reReadConf(String uri) Triggers reareadigng configuration file.
void	resetLoggerLevel(String loggerName) Resets loggers under certain name to log on certain level.
void	resetLoggerLevels() Resets all loggers level to default one
void	setDefaultHandlerLevel(String l)
void	setDefaultLoggerLevel(String l)
void	setDefaultNotificationInterval(int numberOfEntries)
void	setGenericHandlerFilterClassName(String loggerName, int index, String className)
void	setGenericHandlerFormatterClassName(String loggerName, int index, String className)
void	setGenericHandlerLevel(String loggerName, int index, String level)
void	setHandlerFilterClassName(String loggerName, String handlerName, String className)
void	setHandlerFormaterClassName(String loggerName, String handlerName, String className)
void	setHandlerLevel(String loggerName, String handlerName, Level level) Fetches level of particular handler
void	setHandlerLevel(String loggerName, String handlerName, String level) Fetches level of particular handler
void	setHandlerName(String loggerName, int index, String newName)
void	setHandlerNotificationInterval(String loggerName, int numberOfEntries)
void	setLoggerFilterClassName(String loggerName, String className, String[] constructorParameters, String[] paramValues)
void	setLoggerLevel(String loggerName, Level level) Same as LoggingMXBean - sets level for certain logger.
void	setLoggerLevel(String loggerName, String level) Same as LoggingMXBean - sets level for certain logger.
void	setUseParentHandlersFlag(String loggerName, boolean flag)

Methods inherited from class java.lang.Object

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

Constructor Detail

LogManagementMBeanUtils

public LogManagementMBeanUtils(MBeanServerConnection mbeanServer,
                       ObjectName sleeManagementMBean)
                        throws ManagementConsoleException

Throws:

ManagementConsoleException

Method Detail

_setDefaultLoggerLevel

public void _setDefaultLoggerLevel(Level l)
                            throws ManagementConsoleException

Throws:

ManagementConsoleException

_getDefaultLoggerLevel

public Level _getDefaultLoggerLevel()
                             throws ManagementConsoleException

Throws:

ManagementConsoleException

setDefaultLoggerLevel

public void setDefaultLoggerLevel(String l)
                           throws ManagementConsoleException

Throws:

ManagementConsoleException

getDefaultLoggerLevel

public String getDefaultLoggerLevel()
                             throws ManagementConsoleException

Throws:

ManagementConsoleException

_setDefaultHandlerLevel

public void _setDefaultHandlerLevel(Level l)
                             throws ManagementConsoleException

Throws:

ManagementConsoleException

_getDefaultHandlerLevel

public Level _getDefaultHandlerLevel()
                              throws ManagementConsoleException

Throws:

ManagementConsoleException

setDefaultHandlerLevel

public void setDefaultHandlerLevel(String l)
                            throws ManagementConsoleException

Throws:

ManagementConsoleException

getDefaultHandlerLevel

public String getDefaultHandlerLevel()
                              throws ManagementConsoleException

Throws:

ManagementConsoleException

setDefaultNotificationInterval

public void setDefaultNotificationInterval(int numberOfEntries)
                                    throws ManagementConsoleException

Throws:

ManagementConsoleException

getDefaultNotificationInterval

public int getDefaultNotificationInterval()
                                   throws ManagementConsoleException

Throws:

ManagementConsoleException

getLoggerNames

public List<String> getLoggerNames(String regex)
                            throws ManagementConsoleException

SImilar to LoggingMXBean, return list of available loggers. Filter is string that has to occur in loggers name.

Parameters:

- - specifies string that has to occur in loggers name, if null - all names are returned. (Simply regex)

Returns:

Throws:

ManagementConsoleException

setLoggerLevel

public void setLoggerLevel(String loggerName,
                  Level level)
                    throws ManagementConsoleException

Same as LoggingMXBean - sets level for certain logger.

Parameters:

loggerName - - name of the logger

level - - level to be set

Throws:

IllegalArgumentException - - thrown when there is no logger under certain name.

ManagementConsoleException

setLoggerLevel

public void setLoggerLevel(String loggerName,
                  String level)
                    throws ManagementConsoleException

Same as LoggingMXBean - sets level for certain logger. This method accepts String representation of logger level.

Parameters:

loggerName - - name of the logger

level - - level to be set

Throws:

IllegalArgumentException - - thrown when there is no logger under certain name or String dose not represent valid logger level.

ManagementConsoleException

resetLoggerLevels

public void resetLoggerLevels()
                       throws ManagementConsoleException

Resets all loggers level to default one

Throws:

ManagementConsoleException

resetLoggerLevel

public void resetLoggerLevel(String loggerName)
                      throws ManagementConsoleException

Resets loggers under certain name to log on certain level.

Parameters:

loggerName -

Throws:

ManagementConsoleException

clearLoggers

public void clearLoggers()
                  throws ManagementConsoleException

Removes(set level to Level.OFF, handlers are removed) all loggers that were created by this MBean - this will usually include loggers for whole packages. It also removes all handlers - either NotificationHandler and SocketHandler for each defined logger(either by this MBean or by source code).

Throws:

ManagementConsoleException

clearLoggers

public void clearLoggers(String name)
                  throws ManagementConsoleException

Removes all loggers under certain branch.

Parameters:

name - - logger name(branch name)

Throws:

ManagementConsoleException

addLogger

public boolean addLogger(String name,
                Level level)
                  throws NullPointerException,
                         ManagementConsoleException

Tries to add logger if it doesnt exist

Parameters:

name - - name of logger

level - - level for this logger, if null than default level for logger is used

Returns:

• true - if logger didnt exist and it was created
• false - if logger did exist and it was not created

Throws:

NullPointerException - - when arg is null{}

ManagementConsoleException

addLogger

public boolean addLogger(String name,
                String level)
                  throws ManagementConsoleException

Tries to add logger if it doesnt exist

Parameters:

name - - name of logger

level - - level for this logger, if null than default level for logger is used

Returns:

• true - if logger didnt exist and it was created
• false - if logger did exist and it was not created

Throws:

IllegalArgumentException - - when level is not valid string representation of logging level

NullPointerException - - when arg is null{}

ManagementConsoleException

addSocketHandler

public void addSocketHandler(String loggerName,
                    Level handlerLevel,
                    String handlerName,
                    String formaterClassName,
                    String filterClassName,
                    String host,
                    int port)
                      throws ManagementConsoleException

Adds SocketHandler to certain logger, this logger must exist prior this function is called

Parameters:

loggerName - - name of the logger, cant be null

handlerLevel - - level for this handler, if its null default level for handlers will be used

handlerName - - name for this handler, cant be duplicate.

formaterClassName - - name of formater class for this handler, can be null.

filterClassName - - name of filter class for this handler, can be null.

host - - host address

port - - port address

Throws:

IllegalArgumentException - - thrown when:

• host is not a valid inet address
• port <0

NullPointerException - - if arg other than:

• formaterClassName
• filterClassName
• handlerLevel

is null.

IllegalStateException - :- thrown when:

• Logger under certain name doesnt exist
• handler name is duplicate of another handler for this logger or is reserved one ->NOTIFICATION

ManagementConsoleException

addSocketHandler

public void addSocketHandler(String loggerName,
                    String handlerLevel,
                    String handlerName,
                    String formaterClassName,
                    String filterClassName,
                    String host,
                    int port)
                      throws ManagementConsoleException

Adds SocketHandler to certain logger, this logger must exist prior this function is called

Parameters:

loggerName - - name of the logger, cant be null

handlerLevel - - level for this handler, if its null default level for handlers will be used

handlerName - - name for this handler, cant be duplicate.

formaterClassName - - name of formater class for this handler, can be null.

filterClassName - - name of filter class for this handler, can be null.

host - - host address

port - - port address

Throws:

IllegalArgumentException - - thrown when:

• host is not a valid inet address
• port <0
• handlerLevel!=null and does not represent valid logging level
• formaterClassName is not valid formater class
• filterClassName is not valid filter class

NullPointerException - - if arg other than:

• formaterClassName
• filterClassName
• handlerLevel

is null.

IllegalStateException - :- thrown when:

• Logger under certain name doesnt exist
• handler name is duplicate of another handler for this logger or is reserved one ->NOTIFICATION

ManagementConsoleException

removeHandler

public boolean removeHandler(String loggerName,
                    String handlerName)
                      throws ManagementConsoleException

Tries to remove handler from logger.

Parameters:

loggerName - - name of the logger

handlerName - - handler name that has been added by this MBean

Returns:

• true - if logger exists, and it was removed
• false - otherwise

Throws:

ManagementConsoleException

removeHandler

public boolean removeHandler(String loggerName,
                    int index)
                      throws ManagementConsoleException

Throws:

ManagementConsoleException

addNotificationHandler

public void addNotificationHandler(String loggerName,
                          int numberOfEntries,
                          Level level,
                          String formaterClassName,
                          String filterClassName)
                            throws IllegalArgumentException,
                                   IllegalStateException,
                                   NullPointerException,
                                   ManagementConsoleException

Adds notification handler to logger if it exists. Its name is set to NOTIFICATION. There can be only one notification handler. This handler holds reference to up to numberOfEntries log entries and fires notification. Notification can be triggered prematurely in case when someone calls fetchLogContent function, this will cause notification to be fired along with log entries return as outcome of invocation.

Parameters:

loggerName - - name of the logger, it must exists prior this function call

numberOfEntries - - number of log entries after notification is sent. If <=0 default value is used

level - - level for this handler, if null, default value is used

formaterClassName - - name of formater class for this handler, can be null.

filterClassName - - name of filter class for this handler, can be null.

Throws:

IllegalArgumentException - thrown when:

• logger under certain name does not exist
• formaterClassName is not valid formater class
• filterClassName is not valid filter class

IllegalStateException - - logger under that name already has notification handler

NullPointerException - - loggerName is null

ManagementConsoleException

addNotificationHandler

public void addNotificationHandler(String loggerName,
                          int numberOfEntries,
                          String level,
                          String formaterClassName,
                          String filterClassName)
                            throws ManagementConsoleException

Throws:

ManagementConsoleException

getHandlerNamesForLogger

public List getHandlerNamesForLogger(String loggerName)
                              throws ManagementConsoleException

Returns names of handlers for logger

Parameters:

loggerName - - logger name, cant be null, must be valid

Returns:

List with names of handlers for this loggers

Throws:

IllegalArgumentException - - logger does not exist

ManagementConsoleException

getHandlerLevel

public String getHandlerLevel(String loggerName,
                     String handlerName)
                       throws ManagementConsoleException

Fetches level of particular handler

Parameters:

loggerName - - name of the logger, cant be null and logger must exist

handlerName - - valid name of handler, cant be null

Returns:

Throws:

IllegalArgumentException - thrown when:

• handler does not exist

NullPointerException - thrown when:

• arg is null

ManagementConsoleException

getHandlerFilterClassName

public String getHandlerFilterClassName(String loggerName,
                               String handlerName)
                                 throws IllegalArgumentException,
                                        NullPointerException,
                                        ManagementConsoleException

Parameters:

loggerName - - name of the logger, cant be null and logger must exist

handlerName - - name of the handler, cant be null and handler ust exist

Returns:

Throws:

IllegalArgumentException - thrown when:

• logger does not exist
• handler under specific name does not exist

NullPointerException - thrown when:

• arg is null

ManagementConsoleException

getHandlerFormaterClassName

public String getHandlerFormaterClassName(String loggerName,
                                 String handlerName)
                                   throws IllegalArgumentException,
                                          NullPointerException,
                                          ManagementConsoleException

Parameters:

loggerName - - name of the logger, cant be null and logger must exist

handlerName - - name of the handler, cant be null and handler ust exist

Returns:

Throws:

IllegalArgumentException - thrown when:

• logger does not exist
• handler under specific name does not exist

NullPointerException - thrown when:

• arg is null

ManagementConsoleException

getHandlerNotificationInterval

public int getHandlerNotificationInterval(String loggerName)
                                   throws ManagementConsoleException

Parameters:

loggerName - - name of the logger, cant be null and logger must exist

Returns:

Throws:

IllegalArgumentException - thrown when:

• logger does not exist

NullPointerException - thrown when:

• args is null

IllegalStateException - thrown when:

• logger does not have notification handler

ManagementConsoleException

getHandlerClassName

public String getHandlerClassName(String loggerName,
                         String handlerName)
                           throws IllegalArgumentException,
                                  NullPointerException,
                                  IllegalStateException,
                                  ManagementConsoleException

Throws:

IllegalArgumentException

NullPointerException

IllegalStateException

ManagementConsoleException

getHandlerClassName

public String getHandlerClassName(String loggerName,
                         int index)
                           throws IllegalArgumentException,
                                  NullPointerException,
                                  IllegalStateException,
                                  ManagementConsoleException

Throws:

IllegalArgumentException

NullPointerException

IllegalStateException

ManagementConsoleException

setHandlerLevel

public void setHandlerLevel(String loggerName,
                   String handlerName,
                   String level)
                     throws IllegalArgumentException,
                            NullPointerException,
                            ManagementConsoleException

Fetches level of particular handler

Parameters:

loggerName - - name of the logger, cant be null and logger must exist

handlerName - - valid name of handler, cant be null

level - - new handelr level

Throws:

IllegalArgumentException - thrown when:

• handler does not exist
• logger does not exist
• level is not valid string representation of logging level

NullPointerException - thrown when:

• arg is null

ManagementConsoleException

setHandlerLevel

public void setHandlerLevel(String loggerName,
                   String handlerName,
                   Level level)
                     throws ManagementConsoleException

Fetches level of particular handler

Parameters:

loggerName - - name of the logger, cant be null and logger must exist

handlerName - - valid name of handler, cant be null

level - - new handelr level

Throws:

IllegalArgumentException - thrown when:

• handler does not exist
• logger does not exist

NullPointerException - thrown when:

• arg is null

ManagementConsoleException

setHandlerFilterClassName

public void setHandlerFilterClassName(String loggerName,
                             String handlerName,
                             String className)
                               throws ManagementConsoleException

Parameters:

loggerName - - name of the logger, cant be null and logger must exist

handlerName - - name of the handler, cant be null and handler ust exist

Throws:

IllegalArgumentException - thrown when:

• logger does not exist
• handler under specific name does not exist
• className is not valid filter class name

NullPointerException - thrown when:

• args is null

ManagementConsoleException

setHandlerFormaterClassName

public void setHandlerFormaterClassName(String loggerName,
                               String handlerName,
                               String className)
                                 throws ManagementConsoleException

Parameters:

loggerName - - name of the logger, cant be null and logger must exist

handlerName - - name of the handler, cant be null and handler ust exist

Throws:

IllegalArgumentException - thrown when:

• logger does not exist
• handler under specific name does not exist
• className is not a valid formater class name

NullPointerException - thrown when:

• args is null

ManagementConsoleException

setHandlerNotificationInterval

public void setHandlerNotificationInterval(String loggerName,
                                  int numberOfEntries)
                                    throws ManagementConsoleException

Parameters:

loggerName - - name of the logger, cant be null and logger must exist

Throws:

IllegalArgumentException - thrown when:

• logger does not exist

NullPointerException - thrown when:

• args is null

IllegalStateException - thrown when:

• logger does not have notification handler

ManagementConsoleException

fetchLog

public String fetchLog(String loggerName)
                throws ManagementConsoleException

Parameters:

loggerName - - name of the logger, cant be null and logger must exist

Throws:

IllegalArgumentException - thrown when:

• logger does not exist

NullPointerException - thrown when:

• args is null

IllegalStateException - thrown when:

• logger does not have notification handler

ManagementConsoleException

reReadConf

public void reReadConf(String uri)
                throws ManagementConsoleException

Triggers reareadigng configuration file.

Parameters:

uri - - target configuration file in Properties format, if null, local file is read(jre local)

Throws:

ManagementConsoleException

addHandler

public void addHandler(String loggerName,
              String handlerName,
              String handlerClassName,
              String formaterClass,
              String filterClass,
              String[] constructorParameters,
              String[] paramValues)
                throws ManagementConsoleException

Throws:

ManagementConsoleException

numberOfHandlers

public int numberOfHandlers(String loggerName)
                     throws ManagementConsoleException

Throws:

ManagementConsoleException

getGenericHandlerLevel

public String getGenericHandlerLevel(String loggerName,
                            int index)
                              throws ManagementConsoleException

Throws:

ManagementConsoleException

getGenericHandlerFilterClassName

public String getGenericHandlerFilterClassName(String loggerName,
                                      int index)
                                        throws NullPointerException,
                                               IllegalArgumentException,
                                               ManagementConsoleException

Throws:

NullPointerException

IllegalArgumentException

ManagementConsoleException

getGenericHandlerFormatterClassName

public String getGenericHandlerFormatterClassName(String loggerName,
                                         int index)
                                           throws ManagementConsoleException

Throws:

ManagementConsoleException

setGenericHandlerLevel

public void setGenericHandlerLevel(String loggerName,
                          int index,
                          String level)
                            throws ManagementConsoleException

Throws:

ManagementConsoleException

setGenericHandlerFilterClassName

public void setGenericHandlerFilterClassName(String loggerName,
                                    int index,
                                    String className)
                                      throws ManagementConsoleException

Throws:

ManagementConsoleException

setGenericHandlerFormatterClassName

public void setGenericHandlerFormatterClassName(String loggerName,
                                       int index,
                                       String className)
                                         throws ManagementConsoleException

Throws:

ManagementConsoleException

getHandlerName

public String getHandlerName(String loggerName,
                    int index)
                      throws ManagementConsoleException

Throws:

ManagementConsoleException

setHandlerName

public void setHandlerName(String loggerName,
                  int index,
                  String newName)
                    throws ManagementConsoleException

Throws:

ManagementConsoleException

setUseParentHandlersFlag

public void setUseParentHandlersFlag(String loggerName,
                            boolean flag)
                              throws ManagementConsoleException

Throws:

ManagementConsoleException

getUseParentHandlersFlag

public boolean getUseParentHandlersFlag(String loggerName)
                                 throws ManagementConsoleException

Throws:

ManagementConsoleException

getLoggerLevel

public String getLoggerLevel(String loggerName)
                      throws ManagementConsoleException

Throws:

ManagementConsoleException

setLoggerFilterClassName

public void setLoggerFilterClassName(String loggerName,
                            String className,
                            String[] constructorParameters,
                            String[] paramValues)
                              throws ManagementConsoleException

Throws:

ManagementConsoleException

getLoggerFilterClassName

public String getLoggerFilterClassName(String loggerName)
                                throws ManagementConsoleException

Throws:

ManagementConsoleException