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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of multiUserChat Show documentation
The newest version!
/*
 * 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 uk.org.retep.util.messaging.MessageException;
import uk.org.retep.xmpp.message.ErrorCondition;
import uk.org.retep.xmpp.message.Message;

/**
 *
 * @author peter
 */
public interface MucValidator
{

    /**
     * Hook to allow subclasses to validate the message.
     *
     * 
     *  The default implementation simply returns ErrorCondition.OK as we
     *  permit all messages to be relayed, however as per XEP-0045 7.9:
     *  
     *      a service MAY ignore or reject messages that do not have a type of
     *      "groupchat"
     *  
     * 
     *
     * @param sender MucRoomMember of the sender
     * @param room MucRoom
     * @param message Message to send
     * @return ErrorCondition.OK to allow relay, any other value to respond
     * with the appropriate Error to the sender
     * @throws MessageException
     */
    ErrorCondition validateMessage( final MucRoomMember sender,
                                    final MucRoom room,
                                    final Message message )
            throws MessageException;

    ErrorCondition validateSender( final MucRoomMember sender,
                                   final MucService service,
                                   final MucRoom room,
                                   final Message message )
            throws MessageException;
}