com.varra.jmx.mbean

Class Log4jConfigLoader

java.lang.Object

com.varra.jmx.mbean.Log4jConfigLoader

All Implemented Interfaces:

Log4jConfigLoaderMBean, Serializable

@InterfaceAudience.Public
 @InterfaceStability.Stable
public class Log4jConfigLoader
extends Object
implements Log4jConfigLoaderMBean

Loads the log4jConfig file and monitors it, re-loads the log file whenever it gets changed.

Version:

1.0

Author:

Rajakrishna V. Reddy

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Log4jConfigLoader(String log4jConfigFileName, int interval) Instantiates a new log4j config loader.

Method Summary

Modifier and Type	Method and Description
Object	getContent() Gets the log4j content.
int	getInterval() Gets the interval of the logFile loader that is pre-configured.
String	getLevel() Gets the current root log level configured.
String	getLevelAsString()
String	getLevelHelp()
String	getLogFileName() Gets the full qualified log file name.
long	lastLoaded() Gets the timeStamp of the logFile when it is Last loaded.
void	reload() The Default LogFile will be loaded for every pre-configured interval, but this request Reloads the logFile forcefully.
void	reload(String fileName)
void	setContent(Object logFileConfig) Sets the content.
void	setInterval(int interval) Sets the interval of the logFile loader, replaces the value that is pre-configured for this instance.
void	setLevel(int level)
void	setLevel(String level) It is an admin's helper method to set the log level on demand thru JMX, It can be done by changing the root log level entry in log properties too. Sets the Root Log level, that is passed as an String.
String	setLogFileName(String logFileName) Sets the log file name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Log4jConfigLoader

public Log4jConfigLoader(String log4jConfigFileName,
                         int interval)
                  throws Log4jConfigLoaderException

Instantiates a new log4j config loader.

Parameters:

log4jConfigFileName - the log4j config file name

interval - the interval

Throws:

Log4jConfigLoaderException - the log4j config loader exception

Method Detail

lastLoaded

public long lastLoaded()

Description copied from interface: Log4jConfigLoaderMBean

Gets the timeStamp of the logFile when it is Last loaded.

Specified by:

lastLoaded in interface Log4jConfigLoaderMBean

Returns:

the long

reload

public void reload()

Description copied from interface: Log4jConfigLoaderMBean

The Default LogFile will be loaded for every pre-configured interval, but this request Reloads the logFile forcefully.

Specified by:

reload in interface Log4jConfigLoaderMBean

reload

public void reload(String fileName)

getLogFileName

public String getLogFileName()

Description copied from interface: Log4jConfigLoaderMBean

Gets the full qualified log file name.

Specified by:

getLogFileName in interface Log4jConfigLoaderMBean

Returns:

the log file name

getInterval

public int getInterval()

Description copied from interface: Log4jConfigLoaderMBean

Gets the interval of the logFile loader that is pre-configured.

Specified by:

getInterval in interface Log4jConfigLoaderMBean

Returns:

the interval

setInterval

public void setInterval(int interval)

Description copied from interface: Log4jConfigLoaderMBean

Sets the interval of the logFile loader, replaces the value that is pre-configured for this instance.

Specified by:

setInterval in interface Log4jConfigLoaderMBean

Parameters:

interval - the new interval

getLevel

public String getLevel()

Description copied from interface: Log4jConfigLoaderMBean

Gets the current root log level configured.
You can change this by using the Log4jConfigLoaderMBean.setLevel(String). method.
It returns -1 there is no log level set for it or if gets any exception. !!!

Specified by:

getLevel in interface Log4jConfigLoaderMBean

Returns:

the level - the assigned level, can be -1.

getLevelAsString

public String getLevelAsString()

setLevel

public void setLevel(int level)

setLevel

public void setLevel(String level)

Description copied from interface: Log4jConfigLoaderMBean

It is an admin's helper method to set the log level on demand thru JMX, It can be done by changing the root log level entry in log properties too.
Sets the Root Log level, that is passed as an String. Please find the String corresponding to the level respectively.

0. The OFF has the highest possible rank and is intended to turn off logging.

1. The FATAL level designates very severe error events that will presumably lead the application to abort.
   
2. The ERROR level designates error events that might still allow the application to continue running.
   
3. The WARN level designates potentially harmful situations.
   
4. The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.
   
5. The DEBUG Level designates fine-grained informational events that are most useful to debug an application.
   
6. The TRACE Level designates finer-grained informational events than the DEBUG level.
   
7. The ALL has the lowest possible rank and is intended to turn on all logging.

Specified by:

setLevel in interface Log4jConfigLoaderMBean

Parameters:

level - the new level

getLevelHelp

public String getLevelHelp()

getContent

public Object getContent()

Description copied from interface: Log4jConfigLoaderMBean

Gets the log4j content.

Specified by:

getContent in interface Log4jConfigLoaderMBean

Returns:

the content

setLogFileName

public String setLogFileName(String logFileName)

Description copied from interface: Log4jConfigLoaderMBean

Sets the log file name.

Specified by:

setLogFileName in interface Log4jConfigLoaderMBean

Parameters:

logFileName - the log file name

Returns:

the string

setContent

public void setContent(Object logFileConfig)

Description copied from interface: Log4jConfigLoaderMBean

Sets the content.

Specified by:

setContent in interface Log4jConfigLoaderMBean

Parameters:

logFileConfig - the new content