uk.org.retep.xmpp.muc.MucLogger Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of multiUserChat Show documentation

There is a newer version: 10.6

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package uk.org.retep.xmpp.muc;

import javax.annotation.Nonnull;
import uk.org.retep.xmpp.message.Message;

/**
 * Interface which allows messages received by a {@link MucRoom} to be logged.
 *
 * 
 *  This is an optional interface. If messages need to be logged (either in a
 *  standard log file, a database etc) then an implementation of this should
 *  be used and attached to the {@link MucService}.
 * 
 *
 * 
 *  {@link uk.org.retep.xmpp.muc.beans.BasicMucLogger} provides a simple
 *  implementation for Log4J.
 * 
 *
 * @author peter
 * @see uk.org.retep.xmpp.muc.beans.BasicMucLogger
 */
public interface MucLogger
{

    /**
     * Log a {@link Message}
     *
     * @param room MucRoom the message is in
     * @param message Message to log
     */
    void logMessage( @Nonnull final MucRoom room, @Nonnull final Message message );
}