org.wso2.esb.integration.common.clients.logging

Class LoggingAdminClient

java.lang.Object

org.wso2.esb.integration.common.clients.logging.LoggingAdminClient

public class LoggingAdminClient
extends Object

This class can be used as the client to obtaining Log4J information about the system and also used for managing the system Log4J configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoggingAdminClient.LogLevel

Constructor Summary

Constructors

Constructor and Description
LoggingAdminClient(String backEndUrl, String sessionCookie)
LoggingAdminClient(String backEndURL, String userName, String password)

Method Summary

Modifier and Type	Method and Description
org.wso2.carbon.logging.admin.stub.types.carbon.AppenderData	getAppenderData(String appenderName) Returns the AppenderData for the given appenderName.
org.wso2.carbon.logging.admin.stub.types.carbon.LogData	getSysLog() Returns the system log data.
void	restoreToDefaults() Restores to the default log.
boolean	updateLoggerData(String loggerName, String logLevel, boolean additivity, boolean persist) Updates the loggerdata in the LoggingAdminStub.
void	updateSystemLog(String logLevel, String logPattern, boolean persist) Updates the system log.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingAdminClient

public LoggingAdminClient(String backEndUrl,
                          String sessionCookie)
                   throws org.apache.axis2.AxisFault

Throws:

org.apache.axis2.AxisFault

LoggingAdminClient

public LoggingAdminClient(String backEndURL,
                          String userName,
                          String password)
                   throws org.apache.axis2.AxisFault

Throws:

org.apache.axis2.AxisFault

Method Detail

updateLoggerData

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

Updates the loggerdata in the LoggingAdminStub.

Parameters:

loggerName - the logger name

logLevel - the log level

additivity - whether additivity is true or false

persist - whether to persist or not

Returns:

whether the update was successful or not

Throws:

Exception - exception from the LoggingAdminStub

updateSystemLog

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

Updates the system log.

Parameters:

logLevel - the log level

logPattern - the log pattern

persist - whether to persist or not

Throws:

Exception - exception from the LoggingAdminStub

getSysLog

public org.wso2.carbon.logging.admin.stub.types.carbon.LogData getSysLog()
                                                                  throws Exception

Returns the system log data.

Returns:

the system LogData

Throws:

Exception - exception from the LoggingAdminStub

restoreToDefaults

public void restoreToDefaults()
                       throws Exception

Restores to the default log.

Throws:

Exception - exception from the LoggingAdminStub

getAppenderData

public org.wso2.carbon.logging.admin.stub.types.carbon.AppenderData getAppenderData(String appenderName)
                                                                             throws Exception

Returns the AppenderData for the given appenderName.

Parameters:

appenderName - the appenderName

Returns:

the AppenderData for the given appenderName

Throws:

Exception - exception from the LoggingAdminStub