org.jivesoftware.smack.debugger

Class ConsoleDebugger

java.lang.Object

org.jivesoftware.smack.debugger.ConsoleDebugger

All Implemented Interfaces:

SmackDebugger

public class ConsoleDebugger
extends Object
implements SmackDebugger

Very simple debugger that prints to the console (stdout) the sent and received stanzas. Use this debugger with caution since printing to the console is an expensive operation that may even block the thread since only one thread may print at a time.

It is possible to not only print the raw sent and received stanzas but also the interpreted packets by Smack. By default interpreted packets won't be printed. To enable this feature just change the printInterpreted static variable to true.

Author:

Gaston Dombiak

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	printInterpreted

Constructor Summary

Constructors

Constructor and Description
ConsoleDebugger(Connection connection, Writer writer, Reader reader)

Method Summary

Methods

Modifier and Type	Method and Description
Reader	getReader() Returns the special Reader that wraps the main Reader and logs data to the GUI.
PacketListener	getReaderListener() Returns the thread that will listen for all incoming packets and write them to the GUI.
Writer	getWriter() Returns the special Writer that wraps the main Writer and logs data to the GUI.
PacketListener	getWriterListener() Returns the thread that will listen for all outgoing packets and write them to the GUI.
Reader	newConnectionReader(Reader newReader) Returns a new special Reader that wraps the new connection Reader.
Writer	newConnectionWriter(Writer newWriter) Returns a new special Writer that wraps the new connection Writer.
void	userHasLogged(String user) Called when a user has logged in to the server.

Methods inherited from class java.lang.Object

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

Field Detail

printInterpreted

public static boolean printInterpreted

Constructor Detail

ConsoleDebugger

public ConsoleDebugger(Connection connection,
               Writer writer,
               Reader reader)

Method Detail

newConnectionReader

public Reader newConnectionReader(Reader newReader)

Description copied from interface: SmackDebugger

Returns a new special Reader that wraps the new connection Reader. The connection has been secured so the connection is using a new reader and writer. The debugger needs to wrap the new reader and writer to keep being notified of the connection traffic.

Specified by:

newConnectionReader in interface SmackDebugger

Returns:

a new special Reader that wraps the new connection Reader.

newConnectionWriter

public Writer newConnectionWriter(Writer newWriter)

Description copied from interface: SmackDebugger

Returns a new special Writer that wraps the new connection Writer. The connection has been secured so the connection is using a new reader and writer. The debugger needs to wrap the new reader and writer to keep being notified of the connection traffic.

Specified by:

newConnectionWriter in interface SmackDebugger

Returns:

a new special Writer that wraps the new connection Writer.

userHasLogged

public void userHasLogged(String user)

Description copied from interface: SmackDebugger

Called when a user has logged in to the server. The user could be an anonymous user, this means that the user would be of the form host/resource instead of the form user@host/resource.

Specified by:

userHasLogged in interface SmackDebugger

Parameters:

user - the user@host/resource that has just logged in

getReader

public Reader getReader()

Description copied from interface: SmackDebugger

Returns the special Reader that wraps the main Reader and logs data to the GUI.

Specified by:

getReader in interface SmackDebugger

Returns:

the special Reader that wraps the main Reader and logs data to the GUI.

getWriter

public Writer getWriter()

Description copied from interface: SmackDebugger

Returns the special Writer that wraps the main Writer and logs data to the GUI.

Specified by:

getWriter in interface SmackDebugger

Returns:

the special Writer that wraps the main Writer and logs data to the GUI.

getReaderListener

public PacketListener getReaderListener()

Description copied from interface: SmackDebugger

Returns the thread that will listen for all incoming packets and write them to the GUI. This is what we call "interpreted" packet data, since it's the packet data as Smack sees it and not as it's coming in as raw XML.

Specified by:

getReaderListener in interface SmackDebugger

Returns:

the PacketListener that will listen for all incoming packets and write them to the GUI

getWriterListener

public PacketListener getWriterListener()

Description copied from interface: SmackDebugger

Returns the thread that will listen for all outgoing packets and write them to the GUI.

Specified by:

getWriterListener in interface SmackDebugger

Returns:

the PacketListener that will listen for all sent packets and write them to the GUI