org.wso2.carbon.logging.service

Class LoggingAdmin

java.lang.Object

org.wso2.carbon.logging.service.LoggingAdmin

public class LoggingAdmin
extends Object

This is the Admin service used for obtaining Log4J information about the system and also used for managing the system Log4J configuration

Constructor Summary

Constructors

Constructor and Description
LoggingAdmin()

Method Summary

Methods

Modifier and Type	Method and Description
LoggerData[]	getAllLoggerData(String logNameFilter, boolean beginsWith)
AppenderData	getAppenderData(String appenderName)
LoggerData	getLoggerData(String loggerName)
SyslogData	getSyslogData()
LogData	getSystemLog() Get all the information regarding the system log4j information but Logger information such as logger, parent logger, effective level and additivity.
boolean	isStratosService()
String	removeSyslogPattern(String appenderPattern)
void	restoreDefaults()
void	updateAllAppenderData(String appenderName, String appenderPattern, String threshold, String logFileName, String sysLogHost, String facility, boolean persist) Set the Appender information.
void	updateLoggerData(String loggerName, String loggerLevel, boolean additivity, boolean persist)
void	updateSyslogConfig(String url, String port, String realm, String userName, String password)
void	updateSystemLog(String logLevel, String logPattern, boolean persist) Globally update the System Logging configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingAdmin

public LoggingAdmin()
             throws Exception

Throws:

Exception

Method Detail

getSystemLog

public LogData getSystemLog()
                     throws Exception

Get all the information regarding the system log4j information but Logger information such as logger, parent logger, effective level and additivity. As this information is abundant, rendering SOAP env will be expensive and time consuming.

Returns:

System log information

Throws:

Exception

getAllLoggerData

public LoggerData[] getAllLoggerData(String logNameFilter,
                            boolean beginsWith)

getAppenderData

public AppenderData getAppenderData(String appenderName)

Parameters:

appenderName - The name of the appender

Returns:

The appender information the given appender with name appenderName

getLoggerData

public LoggerData getLoggerData(String loggerName)

updateSyslogConfig

public void updateSyslogConfig(String url,
                      String port,
                      String realm,
                      String userName,
                      String password)
                        throws LoggingAdminException

Throws:

LoggingAdminException

getSyslogData

public SyslogData getSyslogData()
                         throws LoggingAdminException

Throws:

LoggingAdminException

removeSyslogPattern

public String removeSyslogPattern(String appenderPattern)

updateAllAppenderData

public void updateAllAppenderData(String appenderName,
                         String appenderPattern,
                         String threshold,
                         String logFileName,
                         String sysLogHost,
                         String facility,
                         boolean persist)
                           throws Exception

Set the Appender information. We receive all the parameters from the update appenders method but we have to only update the relevent data.

Parameters:

appenderName - The name of the Appender

appenderPattern - The log pattern

threshold - The logging threshold

logFileName - log file name - Only relevant to FileAppenders

sysLogHost - The Syslog host - Only relevant to SyslogAppenders

facility - The Syslog facility - Only relevant to SyslogAppenders

persist - true - indicates persist these changes to the DB; false - indicates make changes only in memory and do not persist the changes to DB

Throws:

org.apache.axis2.AxisFault - If failure occurs during setting of these values

Exception

isStratosService

public boolean isStratosService()
                         throws Exception

Throws:

Exception

updateSystemLog

public void updateSystemLog(String logLevel,
                   String logPattern,
                   boolean persist)
                     throws Exception

Globally update the System Logging configuration. The global logging level & the log pattern will be changed by this method

Parameters:

logLevel - The global log level to be set

logPattern - The global log pattern to be set

persist - true - indicates persist these changes to the DB; false - indicates make changes only in memory and do not persist the changes to DB

Throws:

Exception

updateLoggerData

public void updateLoggerData(String loggerName,
                    String loggerLevel,
                    boolean additivity,
                    boolean persist)
                      throws Exception

Throws:

Exception

restoreDefaults

public void restoreDefaults()
                     throws Exception

Throws:

Exception