uk.org.retep.xmpp.muc.MucLogger Maven / Gradle / Ivy
/*
* Copyright (c) 1998-2010, Peter T Mount
* All rights reserved.
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
*
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
*
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see
*
*
* GNU GENERAL PUBLIC LICENSE - CLASSPATH EXCEPTION
*
*
*
* Linking this library statically or dynamically with other modules
* is making a combined work based on this library. Thus, the terms
* and conditions of the GNU General Public License cover the whole
* combination.
*
*
*
* As a special exception, the copyright holders of this library give
* you permission to link this library with independent modules to
* produce an executable, regardless of the license terms of these
* independent modules, and to copy and distribute the resulting
* executable under terms of your choice, provided that you also meet,
* for each linked independent module, the terms and conditions of the
* license of that module.
*
*
*
* An independent module is a module which is either not derived from or based
* on this library, or a module who's classes extend those within this library
* as part of the implementation of the library.
*
*
*
* If you modify this library, you may extend this exception to your version
* of the library, but you are not obligated to do so. If you do not wish to
* do so, delete this exception statement from your version.
*
*/
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 );
}