org.kaazing.test.util

Class MemoryAppender

java.lang.Object

org.apache.log4j.AppenderSkeleton

org.apache.log4j.WriterAppender

org.apache.log4j.ConsoleAppender

org.kaazing.test.util.MemoryAppender

All Implemented Interfaces:

org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler

public class MemoryAppender
extends org.apache.log4j.ConsoleAppender

This class is a subclass of log4j ConsoleAppender. It stores all logged messages in memory until (and if) static method printAllMessages is called. The in-memory list of log messages is reset by calling the static initialize method. This class automatically sets the level of the root logger to Level.TRACE, the first time a messages is logged using it. USAGE: configure this class as the ONLY appender on the root Logger (on the element log4j-config.xml) in order to store trace level log messages in memory during a test run without seriously impacting performance or thread concurrency. If a test fails, the printAllMessages method can be called to write all the messages to standard output. TODO: remove this class and consume the version from itests.util instead (which is identical).

Field Summary

Fields inherited from class org.apache.log4j.ConsoleAppender

SYSTEM_ERR, SYSTEM_OUT, target

Fields inherited from class org.apache.log4j.WriterAppender

encoding, immediateFlush, qw

Fields inherited from class org.apache.log4j.AppenderSkeleton

closed, errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

Constructors

Constructor and Description
MemoryAppender()

Method Summary

Modifier and Type	Method and Description
static void	assertLogMessages(Collection<String> expectedPatternsRO, Collection<String> unexpectedPatterns, Collection<Class<? extends Throwable>> expectedExceptionsRO, Collection<Class<? extends Throwable>> unexpectedExceptions, String filterPattern, boolean verbose)
static void	assertMessagesLogged(Collection<String> expectedPatternsRO, Collection<String> unexpectedPatterns, String filterPattern, boolean verbose)
void	close()
static void	initialize()
static void	printAllMessages()
boolean	requiresLayout()
static void	setGatewayBeingStarted(String gatewayName) Call this to identify each gateway when starting multiple embedded gateways.
protected void	subAppend(org.apache.log4j.spi.LoggingEvent event)
String	toString()

Methods inherited from class org.apache.log4j.ConsoleAppender

activateOptions, closeWriter, getFollow, getTarget, setFollow, setTarget

Methods inherited from class org.apache.log4j.WriterAppender

append, checkEntryConditions, createWriter, getEncoding, getImmediateFlush, reset, setEncoding, setErrorHandler, setImmediateFlush, setWriter, shouldFlush, writeFooter, writeHeader

Methods inherited from class org.apache.log4j.AppenderSkeleton

addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setLayout, setName, setThreshold

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryAppender

public MemoryAppender()

Method Detail

initialize

public static void initialize()

assertLogMessages

public static void assertLogMessages(Collection<String> expectedPatternsRO,
                                     Collection<String> unexpectedPatterns,
                                     Collection<Class<? extends Throwable>> expectedExceptionsRO,
                                     Collection<Class<? extends Throwable>> unexpectedExceptions,
                                     String filterPattern,
                                     boolean verbose)

assertMessagesLogged

public static void assertMessagesLogged(Collection<String> expectedPatternsRO,
                                        Collection<String> unexpectedPatterns,
                                        String filterPattern,
                                        boolean verbose)

printAllMessages

public static void printAllMessages()

setGatewayBeingStarted

public static void setGatewayBeingStarted(String gatewayName)

Call this to identify each gateway when starting multiple embedded gateways. That way, each log message will be prefixed by the name of the gateway that issued the message (though unfortunately this can only be done during gateway startup, see injectGatewayName).

subAppend

protected void subAppend(org.apache.log4j.spi.LoggingEvent event)

Overrides:

subAppend in class org.apache.log4j.WriterAppender

close

public void close()

Specified by:

close in interface org.apache.log4j.Appender

Overrides:

close in class org.apache.log4j.WriterAppender

requiresLayout

public boolean requiresLayout()

Specified by:

requiresLayout in interface org.apache.log4j.Appender

Overrides:

requiresLayout in class org.apache.log4j.WriterAppender

toString

public String toString()

Overrides:

toString in class Object