uk.org.retep.xmpp.muc.room.LeaveRoomLogic 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.room;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import uk.org.retep.util.messaging.MessageException;
import uk.org.retep.xmpp.JID;
import uk.org.retep.xmpp.XMPPServer;
import uk.org.retep.xmpp.logic.AbstractXMPPLogic;
import uk.org.retep.xmpp.logic.XMPPLogic;
import uk.org.retep.xmpp.message.Presence;
import uk.org.retep.xmpp.muc.MucRoom;
import uk.org.retep.xmpp.muc.MucRoomMember;
import uk.org.retep.xmpp.muc.MucService;

/**
 * {@link XMPPLogic} used when a user leaves a room
 * @author peter
 */
public class LeaveRoomLogic
        extends AbstractXMPPLogic
{

    private static final LeaveRoomLogic instance = new LeaveRoomLogic();

    public static LeaveRoomLogic getInstance()
    {
        return instance;
    }

    protected LeaveRoomLogic()
    {
    }

    @Override
    public  XMPPLogic process( @Nonnull final XMPPServer server,
                                  @Nonnull final MucService service,
                                  @Nullable final MucRoom room,
                                  @Nonnull final Presence presence )
            throws MessageException
    {
        // This is the departing users room jid
        final JID jidInRoom = presence.getTo();

        getLog().info( "%s left %s", presence.getFrom(), jidInRoom );

        // Remove the user from the room
        final MucRoomMember leavingMember = room.remove( jidInRoom );

        // now send the relevant messages
        return roomLeaveBroadcast( server, service, room, presence, jidInRoom, leavingMember );
    }

    /**
     * Returns an XMPPLogic which should broadcast the fact that a user has left a room
     *
     * @param server {@link XMPPServer}
     * @param service {@link MucService} being used
     * @param room {@link MucRoom} may be null
     * @param presence The presence of the leave
     * @param jidInRoom The users JID within the room
     * @param leavingMember The {@link MucRoomMember} of the user
     * @return XMPPLogic to invoke
     * @throws MessageException on failure
     */
    protected XMPPLogic roomLeaveBroadcast( @Nonnull final XMPPServer server,
                                            @Nonnull final MucService service,
                                            @Nullable final MucRoom room,
                                            @Nonnull final Presence presence,
                                            @Nonnull final JID jidInRoom,
                                            @Nonnull final MucRoomMember leavingMember )
            throws MessageException
    {
        return new RoomLeaveBroadcast( jidInRoom, leavingMember );
    }
}