uk.org.retep.xmpp.muc.MucFactory 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 java.util.List;
import uk.org.retep.annotations.NoInstance;
import uk.org.retep.logging.Log;
import uk.org.retep.logging.LogFactory;
import uk.org.retep.util.messaging.MessageException;
import uk.org.retep.xmpp.JID;
import uk.org.retep.xmpp.XMPPComponent;
import uk.org.retep.xmpp.XMPPRouter;
import uk.org.retep.xmpp.logic.JIDDelegatingLogicComponent;
import uk.org.retep.xmpp.logic.XMPPLogic;
import uk.org.retep.xmpp.logic.XMPPProtocolLogicSet;
import uk.org.retep.xmpp.message.Body;
import uk.org.retep.xmpp.message.Message;
import uk.org.retep.xmpp.muc.beans.BasicMucAuthenticator;
import uk.org.retep.xmpp.muc.beans.BasicMucRoomSet;
import uk.org.retep.xmpp.muc.beans.BasicMucService;
import uk.org.retep.xmpp.muc.beans.BasicMucValidator;
import uk.org.retep.xmpp.muc.logic.DiscoveryLogic;
import uk.org.retep.xmpp.muc.logic.RoomLookupLogic;
import uk.org.retep.xmpp.muc.logic.RoomQueryLogic;
import uk.org.retep.xmpp.muc.room.JoinExistingRoomLogic;
import uk.org.retep.xmpp.muc.room.JoinNewRoomLogic;
import uk.org.retep.xmpp.muc.room.LeaveRoomLogic;
import uk.org.retep.xmpp.muc.room.relay.BasicMessageRelayLogic;
/**
* Factory for specific Muc objects
* @author peter
* @deprecated in 9.12 use MucServiceBuilder
*/
@NoInstance
@Deprecated
public class MucFactory
{
private MucFactory()
{
}
public static MucService createDefaultService( final JID jid )
{
return createDefaultService( jid, null, null );
}
public static MucService createDefaultService( final JID jid,
final MucAuthenticator auth,
final MucRoomSet roomSet )
{
final BasicMucService service = new BasicMucService( jid );
service.setAuthenticator(
auth == null ? new BasicMucAuthenticator() : auth );
service.setRoomSet(
roomSet == null ? new BasicMucRoomSet( jid ) : roomSet );
service.setValidator( new BasicMucValidator() );
service.setServerLogic( new XMPPProtocolLogicSet(
DiscoveryLogic.MUC_SUPPORT,
DiscoveryLogic.ROOMS ) );
service.setRoomLogic( new XMPPProtocolLogicSet(
BasicMessageRelayLogic.getInstance(),
LeaveRoomLogic.getInstance(),
JoinExistingRoomLogic.getInstance(),
RoomQueryLogic.ROOM_INFO,
RoomQueryLogic.ROOM_ITEMS ) );
service.setRoomAbsentLogic( JoinNewRoomLogic.getInstance() );
//service.setRoomAbsentLogic( PrivateMessageRelayLogic.getInstance() );
return service;
}
/**
* Create an {@link XMPPRouter} with the default functionality returned
* by {@link #createDefaultMucLogic()}.
*
*
* This is useful for basic setups however for production code it's
* advisable to create a specific {@link XMPPLogic} set and use
* {@link #createMucRouter(uk.org.retep.xmpp.JID, uk.org.retep.xmpp.muc.MucRoomSet, uk.org.retep.xmpp.logic.XMPPLogic) }
* as that will allow you to add authentication and other features to
* the router.
*
*
* @param service {@link MucService}
* @return XMPPComponent to attach to the {@link uk.org.retep.xmpp.XMPPServer}
* @throws MessageException
*/
public static XMPPComponent createMucComponent(
final MucService service )
throws MessageException
{
return createMucComponent( service, RoomLookupLogic.INSTANCE );
}
/**
* Create an {@link XMPPRouter} with the default functionality returned
* by {@link #createDefaultMucLogic()}.
*
*
* This is useful for basic setups however for production code it's
* advisable to create a specific {@link XMPPLogic} set and use
* {@link #createMucRouter(uk.org.retep.xmpp.JID, uk.org.retep.xmpp.muc.MucRoomSet, uk.org.retep.xmpp.logic.XMPPLogic) }
* as that will allow you to add authentication and other features to
* the router.
*
*
* @param service {@link MucService}
* @param roomLookupLogic XMPPLogic that manages the lookup of rooms
* @return XMPPComponent to attach to the {@link uk.org.retep.xmpp.XMPPServer}
* @throws MessageException
*/
public static XMPPComponent createMucComponent(
final MucService service,
final XMPPLogic roomLookupLogic )
throws MessageException
{
return new JIDDelegatingLogicComponent(
service.getJid(),
service,
service.getServerLogic(),
roomLookupLogic );
}
public static MucLogger createBasicMucLogger()
{
final Log log = LogFactory.getLog( MucLogger.class );
return new MucLogger()
{
@Override
public void logMessage( final MucRoom room, final Message message )
{
if( log.isInfoEnabled() )
{
// FIXME figure out why this is needed
@SuppressWarnings( "unchecked" )
final List body = message.getBody();
if( body.isEmpty() )
{
log.info( "%s %s NO_BODY", message.getFrom(),
room.getJid() );
}
else
{
for( Body b : body )
{
log.info( "%s %s %s",
message.getFrom(),
room.getJid(),
b.getValue() );
}
}
}
}
};
}
}