org.wso2.esb.integration.common.utils

Class CarbonLogReader

java.lang.Object

org.wso2.esb.integration.common.utils.CarbonLogReader

public class CarbonLogReader
extends Object

The class which facilitates tailing the logs from wso2carbon.log file.

Constructor Summary

Constructors

Constructor and Description
CarbonLogReader()
CarbonLogReader(boolean startReadingFromEndOfFile) Class initializer.

Method Summary

Modifier and Type	Method and Description
boolean	assertIfLogExists(String expected) Check for the existence of the given log message.
boolean	assertIfLogExists(String expected, int numberofOccurrences) Check for the existence of occurrences of a given log message.
boolean	checkForLog(String expected, int timeout) Check for the existence of the given log message.
boolean	checkForLog(String expected, int timeout, int numberofOccurrences) Check for the existence of the given log message occurrences.
void	clearLogs() Clears the tail log container.
String	getLogs() Get the tailed logs from the start until now.
int	getNumberOfOccurencesForLog(String expected) Check for the existence of the given log message occurrences.
String	getSubstringBetweenStrings(String startWith, String endWith, int timeout) Returns the substring between the given start and end substrings.
void	start() Start tailer thread.
void	stop() Stops the thread which started tailing the logs.

Methods inherited from class java.lang.Object

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

Constructor Detail

CarbonLogReader

public CarbonLogReader()

CarbonLogReader

public CarbonLogReader(boolean startReadingFromEndOfFile)

Class initializer.

Parameters:

startReadingFromEndOfFile - - specify whether you want to tail from the end of file or not.

Method Detail

start

public void start()

Start tailer thread.

getLogs

public String getLogs()

Get the tailed logs from the start until now.

Returns:

- tailed logs as string.

clearLogs

public void clearLogs()

Clears the tail log container.

stop

public void stop()

Stops the thread which started tailing the logs.

assertIfLogExists

public boolean assertIfLogExists(String expected)

Check for the existence of the given log message.

Parameters:

expected - expected log string

Returns:

true if the log is found, false otherwise

assertIfLogExists

public boolean assertIfLogExists(String expected,
                                 int numberofOccurrences)

Check for the existence of occurrences of a given log message.

Parameters:

expected - expected log string

numberofOccurrences - numberofOccurrences expected number of log occurrences

Returns:

true if the expected number of log occurrences are found, false otherwise

getSubstringBetweenStrings

public String getSubstringBetweenStrings(String startWith,
                                         String endWith,
                                         int timeout)
                                  throws InterruptedException

Returns the substring between the given start and end substrings.

Parameters:

startWith - starting substring

endWith - ending substring

timeout - max time to poll in seconds

Returns:

the substring between the given string, empty string otherwise

Throws:

InterruptedException - if interrupted while sleeping

checkForLog

public boolean checkForLog(String expected,
                           int timeout)
                    throws InterruptedException

Check for the existence of the given log message. The polling will happen in one second intervals.

Parameters:

expected - expected log string

timeout - max time to do polling in seconds

Returns:

true if the log is found with given timeout, false otherwise

Throws:

InterruptedException - if interrupted while sleeping

checkForLog

public boolean checkForLog(String expected,
                           int timeout,
                           int numberofOccurrences)
                    throws InterruptedException

Check for the existence of the given log message occurrences. The polling will happen in one second intervals.

Parameters:

expected - expected log message

timeout - max time to poll in seconds

numberofOccurrences - expected number of log occurrences

Returns:

true if the expected number of log occurrences are found within the given timeout, false otherwise

Throws:

InterruptedException - if interrupted while sleeping

getNumberOfOccurencesForLog

public int getNumberOfOccurencesForLog(String expected)
                                throws InterruptedException

Check for the existence of the given log message occurrences. The polling will happen in one second intervals.

Parameters:

expected - expected log message

Returns:

true if the expected number of log occurrences are found within the given timeout, false otherwise

Throws:

InterruptedException - if interrupted while sleeping