uk.org.retep.xmpp.muc.builder.MucRoomLogicBuilder 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.builder;
import uk.org.retep.xmpp.builder.AbstractProtocolLogicSetBuilder;
import uk.org.retep.xmpp.builder.XMPPLogicBuilder;
import uk.org.retep.xmpp.muc.MucRoom;
import uk.org.retep.xmpp.muc.MucService;
import uk.org.retep.xmpp.muc.logic.MemberQueryLogic;
import uk.org.retep.xmpp.muc.logic.RoomQueryLogic;
import uk.org.retep.xmpp.muc.room.JoinExistingRoomLogic;
import uk.org.retep.xmpp.muc.room.LeaveRoomLogic;
import uk.org.retep.xmpp.muc.room.relay.BasicMessageRelayLogic;
/**
* {@link XMPPLogicBuilder} implementation for building logic for handling rooms
* that currently exist
*
* @author peter
* @since 9.12
*/
public class MucRoomLogicBuilder
extends AbstractProtocolLogicSetBuilder
{
/**
* Use {@link MucServiceBuilder#getMucRoomLogicBuilder()
*/
public MucRoomLogicBuilder()
{
}
/**
* Adds the various components needed for a basic Muc implementation.
*
* @return this instance
*/
@Override
public MucRoomLogicBuilder addDefaultLogic()
{
addBasicMessageRelayLogic();
addLeaveRoomLogic();
addJoinExistingRoomLogic();
addRoomInfoQuery();
addRoomItemsQuery();
addRoomAdminLogic();
return this;
}
/**
* Adds a Basic message relay algorithm to the service - i.e. one message
* per room occupant is sent
*
* @return this instance
*/
public MucRoomLogicBuilder addBasicMessageRelayLogic()
{
return add( BasicMessageRelayLogic.getInstance() );
}
/**
* Adds logic to enable a room occupant to leave a room
*
* @return this instance
*/
public MucRoomLogicBuilder addLeaveRoomLogic()
{
return add( LeaveRoomLogic.getInstance() );
}
/**
* Adds logic to allow a user to enter a room
*
* @return this instance
*/
public MucRoomLogicBuilder addJoinExistingRoomLogic()
{
return add( JoinExistingRoomLogic.getInstance() );
}
/**
* Adds logic to enable a client to query a rooms information
*
* @return this instance
*/
public MucRoomLogicBuilder addRoomInfoQuery()
{
return add( RoomQueryLogic.ROOM_INFO );
}
/**
* Adds logic to enable a client to query a room's items - specifically
* the members of a room
*
* @return this instance
*/
public MucRoomLogicBuilder addRoomItemsQuery()
{
return add( RoomQueryLogic.ROOM_ITEMS );
}
/**
* Adds logic to enable administration of a room
*
* @return this instance
*/
public MucRoomLogicBuilder addRoomAdminLogic()
{
return add( new MemberQueryLogic() );
}
}