98 lines
3.4 KiB
Java
98 lines
3.4 KiB
Java
/**
|
|
*
|
|
* Copyright 2003-2007 Jive Software, 2017 Florian Schmaus.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
package org.jivesoftware.smack.debugger;
|
|
|
|
import java.io.Reader;
|
|
import java.io.Writer;
|
|
|
|
import org.jivesoftware.smack.XMPPConnection;
|
|
import org.jivesoftware.smack.packet.TopLevelStreamElement;
|
|
|
|
import org.jxmpp.jid.EntityFullJid;
|
|
|
|
/**
|
|
* Interface that allows for implementing classes to debug XML traffic. That is a GUI window that
|
|
* displays XML traffic.<p>
|
|
*
|
|
* Every implementation of this interface <b>must</b> have a public constructor with the following
|
|
* arguments: XMPPConnection, Writer, Reader.
|
|
*
|
|
* @author Gaston Dombiak
|
|
*/
|
|
public abstract class SmackDebugger {
|
|
|
|
protected final XMPPConnection connection;
|
|
|
|
protected SmackDebugger(XMPPConnection connection) {
|
|
this.connection = connection;
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param user the user@host/resource that has just logged in
|
|
*/
|
|
// TODO: Should be replaced with a connection listener authenticed().
|
|
public abstract void userHasLogged(EntityFullJid user);
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param reader connection reader.
|
|
* @return a new special Reader that wraps the new connection Reader.
|
|
*/
|
|
public abstract Reader newConnectionReader(Reader reader);
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param writer connection writer.
|
|
* @return a new special Writer that wraps the new connection Writer.
|
|
*/
|
|
public abstract Writer newConnectionWriter(Writer writer);
|
|
|
|
/**
|
|
* Used by the connection to notify about an incoming top level stream element.
|
|
* <p>
|
|
* This method is invoked right after the incoming stream was parsed.
|
|
* </p>
|
|
*
|
|
* @param streamElement the incoming top level stream element.
|
|
*/
|
|
public abstract void onIncomingStreamElement(TopLevelStreamElement streamElement);
|
|
|
|
/**
|
|
* Used by the connection to notify about a outgoing top level stream element.
|
|
* <p>
|
|
* This method is invoked right before the element is serialized to XML and put into the outgoing stream.
|
|
* </p>
|
|
*
|
|
* @param streamElement the outgoing top level stream element.
|
|
*/
|
|
public abstract void onOutgoingStreamElement(TopLevelStreamElement streamElement);
|
|
|
|
}
|