com.varra.jmx.mbean

Interface Log4jConfigLoaderMBean

All Superinterfaces:

Serializable

All Known Implementing Classes:

Log4jConfigLoader

@InterfaceAudience.Public
 @InterfaceStability.Stable
public interface Log4jConfigLoaderMBean
extends Serializable

Loads the log4jConfig file and monitors it, re-loads the log file whenever it gets changed.
Exposing this functionality as an MBean, to make this available to outside world.

Version:

1.0

Author:

Rajakrishna V. Reddy

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	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	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(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.

Method Detail

lastLoaded

long lastLoaded()

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

Returns:

the long

reload

void reload()

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

getLogFileName

String getLogFileName()

Gets the full qualified log file name.

Returns:

the log file name

setLogFileName

String setLogFileName(String logFileName)

Sets the log file name.

Parameters:

logFileName - the log file name

Returns:

the string

getInterval

int getInterval()

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

Returns:

the interval

setInterval

void setInterval(int interval)

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

Parameters:

interval - the new interval

getLevel

String getLevel()

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

Returns:

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

setLevel

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. 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.

Parameters:

level - the new level

getContent

Object getContent()

Gets the log4j content.

Returns:

the content

setContent

void setContent(Object logFileConfig)

Sets the content.

Parameters:

logFileConfig - the new content