uk.org.retep.xmpp.muc.MucService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of multiUserChat Show documentation

There is a newer version: 10.6

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package uk.org.retep.xmpp.muc;

import uk.org.retep.xmpp.JID;
import uk.org.retep.xmpp.logic.XMPPLogic;
import uk.org.retep.xmpp.presence.PresenceManager;

/**
 * Data object attached to an XMPPComponent and passed to the various XMPPLogic
 * instances. It maintains the links between various objects required for
 * a functioning MucService.
 * 
 * @author peter
 */
public interface MucService
        extends MucLogger
{

    JID getJid();

    /**
     * The {@link MucAuthenticator} to handle security
     * @return the {@link MucAuthenticator} to handle security
     */
    MucAuthenticator getAuthenticator();

    MucValidator getValidator();

    /**
     * The {@link MucRoomSet} implementation managing the {@link MucRoom}'s
     *
     * @return the {@link MucRoomSet} implementation managing the {@link MucRoom}'s
     */
    MucRoomSet getRoomSet();

    /**
     * The {@link XMPPLogic} instance containing the logic of this
     * service.
     *
     * @return the {@link XMPPLogic} instance containing the logic
     * of this service.
     */
    XMPPLogic getRoomAbsentLogic();

    /**
     * The {@link XMPPLogic} instance containing the logic of this
     * service.
     *
     * @return the {@link XMPPLogic} instance containing the logic
     * of this service.
     */
    XMPPLogic getRoomLogic();

    /**
     * The {@link XMPPLogic} instance containing the logic of this
     * service.
     *
     * @return the {@link XMPPLogic} instance containing the logic
     * of this service.
     */
    XMPPLogic getServerLogic();

    /**
     * The {@link PresenceManager}
     * @return
     */
    PresenceManager getPresenceManager();
}