uk.org.retep.xmpp.muc.room.AbstractRoomBroadcast 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.room;
import org.jabber.protocol.muc_user.XBuilder;
import org.jabber.protocol.nick.NickBuilder;
import uk.org.retep.util.messaging.MessageException;
import uk.org.retep.xmpp.message.PresenceBuilder;
import uk.org.retep.xmpp.logic.AbstractXMPPLogic;
import uk.org.retep.xmpp.logic.XMPPLogic;
import uk.org.retep.xmpp.muc.MucRoom;
import uk.org.retep.xmpp.muc.MucRoomMember;
import uk.org.retep.xmpp.muc.MucService;
/**
* {@link XMPPLogic} implementation created by another to generate responses
* for when a user joins a chat room
*
* @author peter
*/
public abstract class AbstractRoomBroadcast
extends AbstractXMPPLogic
{
/**
* Returns a Presence that can be used as some response. It will have the
* correct muc#user.X element set with the details for the supplied
* MucRoomMember applied.
*
* Note you need to set the from/to attributes on Presence, the default will
* be the to/from pair from the passed instance.
*
* @param p PresenceBuilder to add to
* @param member MucRoomMember
* @throws uk.org.retep.util.messaging.MessageException
*/
protected final void addPersistentNickName( final PresenceBuilder p, final MucRoomMember member )
throws MessageException
{
// XEP-0172 persistent Nickname support
final String persistentNickname = member.getPersistentNickname();
if( persistentNickname != null )
{
p.add( new NickBuilder().setValue( persistentNickname ) );
}
}
protected final XBuilder addMembershipItem( final PresenceBuilder p,
final MucRoomMember member,
final boolean nonAnon,
final String nickname )
throws MessageException
{
final org.jabber.protocol.muc_user.ItemBuilder item = new org.jabber.protocol.muc_user.ItemBuilder();
item.setAffiliation( member.getAffiliation().cloneBuilder() ).
setRole( member.getRole().cloneBuilder() );
// Nickname change
if( nickname != null )
{
item.setNick( nickname );
}
if( nonAnon )
{
item.setJid( member.getJID().cloneBuilder() );
}
final XBuilder x = new XBuilder().setItem( item );
p.add( x );
return x;
}
}