org.frogx.service.api
Interface MUGManager


public interface MUGManager

The MUGManager is the interface for MultiUserGame plugins to register and unregister their support within MUGService components.

Author:
Günther Nieß

Method Summary
 LocaleUtil getLocaleUtil()
           
 LogUtil getLogUtil()
           
 java.lang.String getServerName()
           
 boolean isGameRegistered(java.lang.String namespace)
          Returns true if a MultiUserGame is configured for this server.
 void registerMultiUserGame(java.lang.String namespace, MultiUserGame game)
          Registers a MultiUserGame at the multi-user game plugin which handles the MUGService.
 void sendPacket(MUGService mugService, org.xmpp.packet.Packet packet)
           
 void unregisterMultiUserGame(java.lang.String namespace)
          Unregisters a MultiUserGame at the multi-user game plugin which handles the MUGService.
 

Method Detail

isGameRegistered

boolean isGameRegistered(java.lang.String namespace)
Returns true if a MultiUserGame is configured for this server.

Parameters:
namespace - The namespace (disco#info) of the MultiUserGame.
Returns:
True if the game is registered for this server.

registerMultiUserGame

void registerMultiUserGame(java.lang.String namespace,
                           MultiUserGame game)
Registers a MultiUserGame at the multi-user game plugin which handles the MUGService.

Parameters:
namespace - The namespace of the MultiUserGame which can be discovered via disco#info queries.
game - The MultiUserGame which should be registered.

unregisterMultiUserGame

void unregisterMultiUserGame(java.lang.String namespace)
Unregisters a MultiUserGame at the multi-user game plugin which handles the MUGService. For example if the Plugin is getting removed or if the game should no longer offered.

Parameters:
namespace - The namespace (disco#info) of the MultiUserGame.

getServerName

java.lang.String getServerName()

getLocaleUtil

LocaleUtil getLocaleUtil()

getLogUtil

LogUtil getLogUtil()

sendPacket

void sendPacket(MUGService mugService,
                org.xmpp.packet.Packet packet)
                throws org.xmpp.component.ComponentException
Throws:
org.xmpp.component.ComponentException


Copyright © 2009. All Rights Reserved.