org.netbeans.lib.collab
Interface ConferenceService


public interface ConferenceService

The Conference service. There are two types of conferences, private and public The difference between private and public is public conferences persist even when no members are present. private conferences can be setup using setupConference(). Private conferences can be joined by calling Conference.join(). Public conferences can be setup using setupPublicConference(). Public conferences can be joined using joinPublicConference(). The service should be intialized by calling intialize() before using any of the methods.

Since:
version 0.1

Method Summary
 void addConferenceServiceListener(ConferenceServiceListener listener)
          Add an additional ConferenceServiceListener to receive the event notifications.
 Conference getPublicConference(java.lang.String destination)
          retrieve a public conference without joining Verified that the conference exists
 void initialize(ConferenceServiceListener listener)
          intialize the service by providing a ConferenceServiceListener.
 Conference joinPublicConference(java.lang.String nick, ConferenceHistory history, java.lang.String destination, ConferenceListener listener)
          join a public conference
 Conference joinPublicConference(java.lang.String destination, ConferenceListener listener)
          join a public conference
 Conference[] listConference(int access)
          list the conference rooms with specified access
 void removeConferenceServiceListener(ConferenceServiceListener listener)
          Removes an already added ConfereneServiceListener.
 Conference setupConference(ConferenceListener listener, int accessLevel)
          setup a new conference
 Conference setupPublicConference(java.lang.String destination, ConferenceListener listener, int accessLevel)
          create a new public conference A public conference is a conference which persists even when no member is present.
 

Method Detail

setupConference

public Conference setupConference(ConferenceListener listener,
                                  int accessLevel)
                           throws CollaborationException
setup a new conference

Parameters:
listener - conference listener
accessLevel - privilegdes to assign to the invited user.
Returns:
a new conference handle. The only member so far is the owner of this session. The invite method in the Conference object can then be used to invite other users to the conference.
Throws:
CollaborationException

joinPublicConference

public Conference joinPublicConference(java.lang.String destination,
                                       ConferenceListener listener)
                                throws CollaborationException
join a public conference

Parameters:
destination - conference address
listener - conference listener. This listener can also be instance of ConferencePasswordListener or ConferenceEventListener
Throws:
CollaborationException

joinPublicConference

public Conference joinPublicConference(java.lang.String nick,
                                       ConferenceHistory history,
                                       java.lang.String destination,
                                       ConferenceListener listener)
                                throws CollaborationException
join a public conference

Parameters:
nick - The nick name to be used in conference room
history - The detail about the history messages. It should be null if the default behaviour is desired.
destination - conference address
listener - conference listener. This listener can also be instance of ConferencePasswordListener or ConferenceEventListener
Throws:
CollaborationException

setupPublicConference

public Conference setupPublicConference(java.lang.String destination,
                                        ConferenceListener listener,
                                        int accessLevel)
                                 throws CollaborationException
create a new public conference A public conference is a conference which persists even when no member is present. It is generally used as a public instant discussion forum, aka public chat room. It differs from a bulletin board in that messages are not persistant. A public conference is joined by other users using the joinPublicConference method.

Parameters:
destination - identifier for this conference
listener - conference listener. This listener can also be instance of ConferencePasswordListener or ConferenceEventListener
accessLevel - default privilegdes to assign to the joining users.
Throws:
CollaborationException
See Also:
joinPublicConference

getPublicConference

public Conference getPublicConference(java.lang.String destination)
                               throws CollaborationException
retrieve a public conference without joining Verified that the conference exists

Parameters:
destination - identifier for this conference
Throws:
CollaborationException

addConferenceServiceListener

public void addConferenceServiceListener(ConferenceServiceListener listener)
Add an additional ConferenceServiceListener to receive the event notifications. To receive all the initial events the first ConferenceServiceListener should be added while initializing ConferenceService.

Parameters:
listener - ConferenceServiceListener The ConferenceServiceListener to be added.

removeConferenceServiceListener

public void removeConferenceServiceListener(ConferenceServiceListener listener)
Removes an already added ConfereneServiceListener. To prevent loss of any event notification it is advised to have atleast one ConferenceServiceListener

Parameters:
listener - ConferenceServiceListener The ConferenceServiceListener to be removed.

initialize

public void initialize(ConferenceServiceListener listener)
                throws CollaborationException
intialize the service by providing a ConferenceServiceListener. Service should be initialized by calling this method before using any of the services of ConferenceService

Parameters:
listener - ConferenceServiceListener
Throws:
CollaborationException

listConference

public Conference[] listConference(int access)
                            throws CollaborationException
list the conference rooms with specified access

Parameters:
access - The access level as defined in this class
Returns:
An array of Conference objects
Throws:
CollaborationException