alma::contLogTest::TestLogLevelsCompImpl::LogSeriesExpectant Class Reference

Collaboration diagram for alma::contLogTest::TestLogLevelsCompImpl::LogSeriesExpectant:

Classes
class	LogList
Public Member Functions
void	clearLogs ()
Package Functions
	LogSeriesExpectant (LogReceiver logReceiver)
LogList	awaitLogRecords (String loggerName, int logRoundtripTimeSeconds)
Private Attributes
LogReceiver	logReceiver

Detailed Description

Helper class for tests that must receive log records from the Log service.

Constructor & Destructor Documentation

alma::contLogTest::TestLogLevelsCompImpl::LogSeriesExpectant::LogSeriesExpectant ( LogReceiver logReceiver ) [inline, package]

Parameters:

logReceiver

an already initialized LogReceiver from which logs will be fetched. This class will not stop the logReceiver, which therefore remains the task of the calling class.

Exceptions:

IllegalArgumentException

if logReceiver is not initialized.

References alma::acs::logging::engine::LogReceiver::isInitialized().

Member Function Documentation

LogList alma::contLogTest::TestLogLevelsCompImpl::LogSeriesExpectant::awaitLogRecords	(	String	loggerName,
		int	logRoundtripTimeSeconds
	)			`[inline, package]`

Call this method after the logs that should be received have been produced. Then the call may take up to logRoundtripTimeSeconds seconds to return.

Parameters:

	loggerName	The name of the logger whose records are to be collected. Filtering of arriving log records will be done for the ILogEntry.Field#SOURCEOBJECT field.
	logRoundtripTimeSeconds	Maximum roundtrip time of a log record (incl. caching by container, sending to Log service, processing by Log service, arrival at LogReceiver).

References alma::acs::logging::engine::LogReceiver::getLogQueue(), alma::acs::logging::engine::LogReceiver::DelayedLogEntry::getLogRecord(), alma::acs::logging::engine::LogReceiver::ReceivedLogRecord::getMessage(), alma::acs::logging::engine::LogReceiver::ReceivedLogRecord::getSourceObject(), alma::acs::logging::engine::LogReceiver::ReceivedLogRecord::getTimestamp(), logReceiver, and alma::acs::logging::engine::LogReceiver::setDelayMillis().

Referenced by alma::contLogTest::TestLogLevelsCompImpl::TestLogLevelsCompTest::testLoggingConfigurableCentralLogLevels().

void alma::contLogTest::TestLogLevelsCompImpl::LogSeriesExpectant::clearLogs ( ) [inline]

Call this method before the logs that we are interested in get produced.

References alma::acs::logging::engine::LogReceiver::getLogQueue(), and logReceiver.

Referenced by alma::contLogTest::TestLogLevelsCompImpl::TestLogLevelsCompTest::testLoggingConfigurableCentralLogLevels().