org.glassfish.cafe.api
Interface MSRPConversation

All Superinterfaces:

Communication

public interface MSRPConversation
extends Communication

A communication object that represents the session-mode instant messaging or chat session among two participants. In addition to text messaging, this communication object can be used for transferring large files among two participants.

Currently MSRPConversation is created by the CAFE internally for the incoming MSRP requests. Upon the creation of MSRPConversation, CommunicationEvent.Type.INITIALIZATION event will be invoked on the CommunicationBean.

If the CommunicationBean creates a MSRPConference with this conversation, then this conversation will be terminated, and the MSRPConference will be initiated. (Refer MSRPConference usage examples).

If the CommunicationBean either does not handle the event or does not create the MSRPConference, then the MSRPConversation between the two remote parties will be established.

Author:

bhavanishankar@dev.java.net

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.cafe.api.Communication

Communication.State

Method Summary

UserParticipant

getParticipant() Return the Callee of this conversation

Methods inherited from interface org.glassfish.cafe.api.Communication

addAgent, addParticipant, addParticipant, addParticipant, addParticipant, end, getAgent, getAgents, getInitiator, getName, getParticipant, getParticipant, getState, removeAgent, removeParticipant, removeParticipant, replaceParticipant

Method Detail

getParticipant

UserParticipant getParticipant()

Return the Callee of this conversation

Returns:

Callee participant.