org.wso2.carbon.logging.service.provider

Class InMemoryLogProvider

java.lang.Object

org.wso2.carbon.logging.service.provider.InMemoryLogProvider

All Implemented Interfaces:

LogProvider

public class InMemoryLogProvider
extends Object
implements LogProvider

Constructor Summary

Constructors

Constructor and Description
InMemoryLogProvider()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	clearLogs() Do clear operation, eg: if it is a in memory log provider then this can be used to clear the memory.
List<LogEvent>	getAllLogs(String tenantDomain, String serverKey) Return a list of all the logs available under given domain and server key
List<String>	getApplicationNames(String tenantDomain, String serverKey) Return a list of all application names deployed under provided tenant domain and server key
List<LogEvent>	getLogs(String type, String keyword, String appName, String tenantDomain, String serverKey) Returns a list of all LogEvents related to the given application, which match to given type and LogEvent message has given key word with it.
List<LogEvent>	getLogsByAppName(String appName, String tenantDomain, String serverKey) Return a list of all the LogEvents belongs to the application, which is deployed under given tenant domain and server key.
List<LogEvent>	getSystemLogs() Return a list of system LogEvents
void	init(LoggingConfig loggingConfig) Initialize the log provider by reading the property comes with logging configuration file This will be called immediate after create new instance of ILogProvider
int	logsCount(String tenantDomain, String serverKey) Return LogEvent count.

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryLogProvider

public InMemoryLogProvider()

Method Detail

init

public void init(LoggingConfig loggingConfig)

Initialize the log provider by reading the property comes with logging configuration file This will be called immediate after create new instance of ILogProvider

Specified by:

init in interface LogProvider

Parameters:

loggingConfig - - configuration class which read and keep configurations

getApplicationNames

public List<String> getApplicationNames(String tenantDomain,
                               String serverKey)
                                 throws LogViewerException

Description copied from interface: LogProvider

Return a list of all application names deployed under provided tenant domain and server key

Specified by:

getApplicationNames in interface LogProvider

Parameters:

tenantDomain - - Tenant domain eg: t1.com

serverKey - - Server key

Returns:

- string List which has all application names, empty String List if there is no application registered under given tenant domain and server key

Throws:

LogViewerException

getSystemLogs

public List<LogEvent> getSystemLogs()
                             throws LogViewerException

Description copied from interface: LogProvider

Return a list of system LogEvents

Specified by:

getSystemLogs in interface LogProvider

Returns:

- List of LogEvent , null if no system LogEvents available.

Throws:

LogViewerException

getAllLogs

public List<LogEvent> getAllLogs(String tenantDomain,
                        String serverKey)
                          throws LogViewerException

Description copied from interface: LogProvider

Return a list of all the logs available under given domain and server key

Specified by:

getAllLogs in interface LogProvider

Parameters:

tenantDomain - - Tenant domain eg: t1.com

serverKey - - server key

Returns:

- List of all LogEvents available under the tenant domain and server key. empty LogEvent array if there is no LogEvents available.

Throws:

LogViewerException

getLogsByAppName

public List<LogEvent> getLogsByAppName(String appName,
                              String tenantDomain,
                              String serverKey)
                                throws LogViewerException

Description copied from interface: LogProvider

Return a list of all the LogEvents belongs to the application, which is deployed under given tenant domain and server key.

Specified by:

getLogsByAppName in interface LogProvider

Parameters:

appName - - application name

tenantDomain - - Tenant domain eg: t1.com

serverKey - - Server key

Returns:

all the LogEvents belongs to the application, which is deployed under given tenant domain and server key, return empty LogEvent array if there is no such LogEvents available.

Throws:

LogViewerException

getLogs

public List<LogEvent> getLogs(String type,
                     String keyword,
                     String appName,
                     String tenantDomain,
                     String serverKey)
                       throws LogViewerException

Description copied from interface: LogProvider

Returns a list of all LogEvents related to the given application, which match to given type and LogEvent message has given key word with it. User can use this api for search operations.

Specified by:

getLogs in interface LogProvider

Parameters:

type - - Log type , eg: ALL , INFO , DEBUG etc ....

keyword - - Key word

appName - - Application name

tenantDomain - - Tenant domain eg: t1.com

serverKey - - Server key

Returns:

- all LogEvents related to the given application, which match to given type and LogEvent message has given key word with it. empty LogEvent array if there is no LogEvents available.

Throws:

LogViewerException

logsCount

public int logsCount(String tenantDomain,
            String serverKey)
              throws LogViewerException

Description copied from interface: LogProvider

Return LogEvent count.

Specified by:

logsCount in interface LogProvider

Parameters:

tenantDomain - - Tenant domain eg: t1.com

serverKey - - Server key

Returns:

- LogEvent count, 0 if there is no LogEvent.

Throws:

LogViewerException

clearLogs

public boolean clearLogs()

Description copied from interface: LogProvider

Do clear operation, eg: if it is a in memory log provider then this can be used to clear the memory.

Specified by:

clearLogs in interface LogProvider

Returns:

- true if clear operation success, false if not.