bsconfbeaninterface.java

一款即时通讯软件

package edu.ou.kmi.buddyspace.plugins.conference;

/*
 * BSConfInterfaceBean.java
 *
 * Project: BuddySpace
 * (C) Copyright Knowledge Media Institute 2004
 *
 *
 * Created on 5 March 2004, 11:53
 */

import java.util.*;
import javax.swing.*;

import org.jabber.jabberbeans.*;
import org.jabber.jabberbeans.util.*;
import org.jabber.jabberbeans.Extension.*;

import edu.ou.kmi.buddyspace.core.*;
import edu.ou.kmi.buddyspace.plugins.conference.core.*;

/**
 * <code>BSConfBeanInterface</code> provides general interface for all
 * groupchat and conferencing core beans (e.g. BSConfBean and BSGroupchatBean).
 *
 * @author  Jiri Komzak, Knowledge Media Institute, Open University, United Kingdom
 */
public interface BSConfBeanInterface {

    /**
     * Sets existing and connected <code>IQBean</code>.
     * Then this is registered as listener for IQ packets.
     */
    public void setIQBean(IQBean iqBean);
    
    /**
     * Sets existing and connected <code>MessengerBean</code>.
     * Then this is registered as listener for message packets.
     */
    public void setMessengerBean(BSMessengerBean bsMsgBean);
    
    /**
     * Sets existing and connected <code>BSPresenceBean</code>.
     * Then this is registered as listener for presence events.
     */
    public void setPresenceBean(BSPresenceBean presenceBean);
    
    /**
     * Returns currently used <code>IQBean</code>.
     */
    public IQBean getIQBean();
    
    /**
     * Returns currently used <code>MessengerBean</code>.
     */
    public MessengerBean getMessengerBean();
    
    /**
     * Returns currently used <code>BSPresenceBean</code>.
     */
    public BSPresenceBean getPresenceBean();
    
    /**
     * Called when disconneted.
     */
    public void disconnected();
    
    /**
     * Frees all object bindings to allow object destroy
     */
    public void prepareToDestroy();
    
    /**
     * Creates or joins a conference room.
     */
    public boolean createRoom(String roomName, String server, String nick);
    
    /** Sends presence to the jid (room) */
    public void sendPresence(BSPresenceInfo pi, JID roomAddress);
    
    /** Leaves the room */
    public void leaveRoom(JID roomJID);
    
    /** 
     * Sends message to the room.
     * @param roomAddress is JID of room
     * @param body is body of message
     */
    public boolean sendMessage(JID roomAddress, String body);
    
    
    /** 
     * Sends message with URL into the room.
     * @param roomAddress is JID of room
     * @param body is body of message
     * @param url is URL
     * @param urlDesc is description of URL
     */
    public Message sendURLMessage(JID roomAddress, String body, String url, String urlDesc);
    
    /** Sends invitation into given room to given JID */
    public boolean sendInvitation(JID toAddress, JID roomJID, String subject, String body);
    
    /** Returns users inside given room */
    public Enumeration getRoster(JID roomJID);
    
    /** Returns nick of given JID */
    public String getNick(JID jid);
    
    /** Changes the nick name */
    public void changeNick(JID roomJID, String newNick);
    
    /**
     * Adds <code>BSConfListener</code> from listeners notified when
     * conference event appears.
     *
     * @see #removeConfListener
     * @see #removeAllConfListeners
     * @see #fireConfReceived
     */
    public void addConfListener(BSConfListener listener);

    /**
     * Removes <code>BSConfListener</code> from listeners notified when
     * conference event appears.
     *
     * @see #addConfListener
     * @see #removeAllConfListeners
     * @see #fireConfReceived
     */
    public void removeConfListener(BSConfListener listener);

    /**
     * Removes all listeners notified when conference event appears.
     * This can be used before to free dependencies and allow dispose of
     * all objects.
     *
     * @see #addConfListener
     * @see #removeConfListener
     * @see #fireConfReceived
     */
    public void removeAllConfListeners();
    
    
    /**
     * Adds <code>BSConfConsumer</code> from consumers notified when
     * conference event appears.
     *
     * @see #removeConfListener
     * @see #removeAllConfListeners
     * @see #fireConfReceived
     */
    public void addConfConsumer(BSConfConsumer consumer);

    /**
     * Removes <code>BSConfConsumer</code> from consumers notified when
     * conference event appears.
     *
     * @see #addConfListener
     * @see #removeAllConfListeners
     * @see #fireConfReceived
     */
    public void removeConfConsumer(BSConfConsumer consumer);

    /**
     * Removes all consumers notified when conference event appears.
     * This can be used before to free dependencies and allow dispose of
     * all objects.
     *
     * @see #addConfListener
     * @see #removeConfListener
     * @see #fireConfReceived
     */
    public void removeAllConfConsumers();

}