|
|
|
|
@ -12,22 +12,39 @@
|
|
|
|
|
|
|
|
|
|
import net.java.sip.communicator.service.filehistory.*;
|
|
|
|
|
import net.java.sip.communicator.service.msghistory.*;
|
|
|
|
|
import net.java.sip.communicator.service.protocol.*;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @author Yana Stamcheva
|
|
|
|
|
* @author Lubomir Marinov
|
|
|
|
|
*/
|
|
|
|
|
public interface ChatSession
|
|
|
|
|
public abstract class ChatSession
|
|
|
|
|
{
|
|
|
|
|
final String[] chatHistoryFilter
|
|
|
|
|
/**
|
|
|
|
|
* The chat history filter.
|
|
|
|
|
*/
|
|
|
|
|
protected final String[] chatHistoryFilter
|
|
|
|
|
= new String[]{ MessageHistoryService.class.getName(),
|
|
|
|
|
FileHistoryService.class.getName()};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* The list of <tt>ChatContact</tt>s contained in this chat session.
|
|
|
|
|
*/
|
|
|
|
|
protected final List<ChatContact> chatParticipants
|
|
|
|
|
= new ArrayList<ChatContact>();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* The list of <tt>ChatTransport</tt>s available in this session.
|
|
|
|
|
*/
|
|
|
|
|
protected final List<ChatTransport> chatTransports
|
|
|
|
|
= new ArrayList<ChatTransport>();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns the descriptor of this chat session.
|
|
|
|
|
*
|
|
|
|
|
* @return the descriptor of this chat session.
|
|
|
|
|
*/
|
|
|
|
|
public Object getDescriptor();
|
|
|
|
|
public abstract Object getDescriptor();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns <code>true</code> if this chat session descriptor is persistent,
|
|
|
|
|
@ -38,141 +55,178 @@ public interface ChatSession
|
|
|
|
|
public abstract boolean isDescriptorPersistent();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns an iterator to the list of all participants contained in this
|
|
|
|
|
* Returns an iterator to the list of all participants contained in this
|
|
|
|
|
* chat session.
|
|
|
|
|
*
|
|
|
|
|
* @return an iterator to the list of all participants contained in this
|
|
|
|
|
*
|
|
|
|
|
* @return an iterator to the list of all participants contained in this
|
|
|
|
|
* chat session.
|
|
|
|
|
*/
|
|
|
|
|
public Iterator<ChatContact> getParticipants();
|
|
|
|
|
public Iterator<ChatContact> getParticipants()
|
|
|
|
|
{
|
|
|
|
|
return chatParticipants.iterator();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns all available chat transports for this chat session. Each chat
|
|
|
|
|
* transport is corresponding to a protocol provider.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @return all available chat transports for this chat session.
|
|
|
|
|
*/
|
|
|
|
|
public Iterator<ChatTransport> getChatTransports();
|
|
|
|
|
public Iterator<ChatTransport> getChatTransports()
|
|
|
|
|
{
|
|
|
|
|
return chatTransports.iterator();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns the currently used transport for all operation within this chat
|
|
|
|
|
* session.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @return the currently used transport for all operation within this chat
|
|
|
|
|
* session.
|
|
|
|
|
*/
|
|
|
|
|
public ChatTransport getCurrentChatTransport();
|
|
|
|
|
public abstract ChatTransport getCurrentChatTransport();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns a list of all <tt>ChatTransport</tt>s contained in this session
|
|
|
|
|
* supporting the given <tt>opSetClass</tt>.
|
|
|
|
|
* @param opSetClass the <tt>OperationSet</tt> class we're looking for
|
|
|
|
|
* @return a list of all <tt>ChatTransport</tt>s contained in this session
|
|
|
|
|
* supporting the given <tt>opSetClass</tt>
|
|
|
|
|
*/
|
|
|
|
|
public List<ChatTransport> getTransportsForOperationSet(
|
|
|
|
|
Class<? extends OperationSet> opSetClass)
|
|
|
|
|
{
|
|
|
|
|
LinkedList<ChatTransport> opSetTransports
|
|
|
|
|
= new LinkedList<ChatTransport>();
|
|
|
|
|
|
|
|
|
|
for (ChatTransport transport : chatTransports)
|
|
|
|
|
{
|
|
|
|
|
if(transport.getProtocolProvider()
|
|
|
|
|
.getOperationSet(opSetClass) != null)
|
|
|
|
|
opSetTransports.add(transport);
|
|
|
|
|
}
|
|
|
|
|
return opSetTransports;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns the <tt>ChatSessionRenderer</tt> that provides the connection
|
|
|
|
|
* between this chat session and its UI.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @return The <tt>ChatSessionRenderer</tt>.
|
|
|
|
|
*/
|
|
|
|
|
public ChatSessionRenderer getChatSessionRenderer();
|
|
|
|
|
public abstract ChatSessionRenderer getChatSessionRenderer();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Sets the transport that will be used for all operations within this chat
|
|
|
|
|
* session.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @param chatTransport The transport to set as a default transport for this
|
|
|
|
|
* session.
|
|
|
|
|
*/
|
|
|
|
|
public void setCurrentChatTransport(ChatTransport chatTransport);
|
|
|
|
|
public abstract void setCurrentChatTransport(ChatTransport chatTransport);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns the name of the chat. If this chat panel corresponds to a single
|
|
|
|
|
* chat it will return the name of the <tt>MetaContact</tt>, otherwise it
|
|
|
|
|
* will return the name of the chat room.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @return the name of the chat
|
|
|
|
|
*/
|
|
|
|
|
public String getChatName();
|
|
|
|
|
public abstract String getChatName();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns a collection of the last N number of history messages given by
|
|
|
|
|
* count.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @param count The number of messages from history to return.
|
|
|
|
|
* @return a collection of the last N number of messages given by count.
|
|
|
|
|
*/
|
|
|
|
|
public Collection<Object> getHistory(int count);
|
|
|
|
|
public abstract Collection<Object> getHistory(int count);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns a collection of the last N number of history messages given by
|
|
|
|
|
* count.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @param date The date up to which we're looking for messages.
|
|
|
|
|
* @param count The number of messages from history to return.
|
|
|
|
|
* @return a collection of the last N number of messages given by count.
|
|
|
|
|
*/
|
|
|
|
|
public Collection<Object> getHistoryBeforeDate(Date date, int count);
|
|
|
|
|
public abstract Collection<Object> getHistoryBeforeDate(Date date, int count);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns a collection of the last N number of history messages given by
|
|
|
|
|
* count.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @param date The date from which we're looking for messages.
|
|
|
|
|
* @param count The number of messages from history to return.
|
|
|
|
|
* @return a collection of the last N number of messages given by count.
|
|
|
|
|
*/
|
|
|
|
|
public Collection<Object> getHistoryAfterDate(Date date, int count);
|
|
|
|
|
public abstract Collection<Object> getHistoryAfterDate(Date date, int count);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns the start date of the history of this chat session.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @return the start date of the history of this chat session.
|
|
|
|
|
*/
|
|
|
|
|
public long getHistoryStartDate();
|
|
|
|
|
public abstract long getHistoryStartDate();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns the end date of the history of this chat session.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @return the end date of the history of this chat session.
|
|
|
|
|
*/
|
|
|
|
|
public long getHistoryEndDate();
|
|
|
|
|
public abstract long getHistoryEndDate();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns the default mobile number used to send sms-es in this session.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @return the default mobile number used to send sms-es in this session.
|
|
|
|
|
*/
|
|
|
|
|
public String getDefaultSmsNumber();
|
|
|
|
|
public abstract String getDefaultSmsNumber();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Sets the default mobile number used to send sms-es in this session.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @param smsPhoneNumber The default mobile number used to send sms-es in
|
|
|
|
|
* this session.
|
|
|
|
|
*/
|
|
|
|
|
public void setDefaultSmsNumber(String smsPhoneNumber);
|
|
|
|
|
public abstract void setDefaultSmsNumber(String smsPhoneNumber);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Disposes this chat session.
|
|
|
|
|
*/
|
|
|
|
|
public void dispose();
|
|
|
|
|
public abstract void dispose();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns the ChatTransport corresponding to the given descriptor.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @param descriptor The descriptor of the chat transport we're looking for.
|
|
|
|
|
* @return The ChatTransport corresponding to the given descriptor.
|
|
|
|
|
*/
|
|
|
|
|
public ChatTransport findChatTransportForDescriptor(Object descriptor);
|
|
|
|
|
public ChatTransport findChatTransportForDescriptor(
|
|
|
|
|
Object descriptor)
|
|
|
|
|
{
|
|
|
|
|
for (ChatTransport chatTransport : chatTransports)
|
|
|
|
|
{
|
|
|
|
|
if (chatTransport.getDescriptor().equals(descriptor))
|
|
|
|
|
return chatTransport;
|
|
|
|
|
}
|
|
|
|
|
return null;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns the status icon of this chat session.
|
|
|
|
|
*
|
|
|
|
|
* @return the status icon of this chat session.
|
|
|
|
|
*/
|
|
|
|
|
public ImageIcon getChatStatusIcon();
|
|
|
|
|
public abstract ImageIcon getChatStatusIcon();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns the avatar icon of this chat session.
|
|
|
|
|
*
|
|
|
|
|
* @return the avatar icon of this chat session.
|
|
|
|
|
*/
|
|
|
|
|
public byte[] getChatAvatar();
|
|
|
|
|
public abstract byte[] getChatAvatar();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Gets the indicator which determines whether a contact list of (multiple)
|
|
|
|
|
@ -184,21 +238,23 @@ public interface ChatSession
|
|
|
|
|
* @return <tt>true</tt> if this <code>ChatSession</code> supports a contact
|
|
|
|
|
* list of (multiple) participants; otherwise, <tt>false</tt>
|
|
|
|
|
*/
|
|
|
|
|
public boolean isContactListSupported();
|
|
|
|
|
|
|
|
|
|
public abstract boolean isContactListSupported();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Adds the given {@link ChatSessionChangeListener} to this
|
|
|
|
|
* <tt>ChatSession</tt>.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @param l the <tt>ChatSessionChangeListener</tt> to add
|
|
|
|
|
*/
|
|
|
|
|
public void addChatTransportChangeListener(ChatSessionChangeListener l);
|
|
|
|
|
|
|
|
|
|
public abstract void addChatTransportChangeListener(
|
|
|
|
|
ChatSessionChangeListener l);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Removes the given {@link ChatSessionChangeListener} to this
|
|
|
|
|
* <tt>ChatSession</tt>.
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @param l the <tt>ChatSessionChangeListener</tt> to add
|
|
|
|
|
*/
|
|
|
|
|
public void removeChatTransportChangeListener(ChatSessionChangeListener l);
|
|
|
|
|
public abstract void removeChatTransportChangeListener(
|
|
|
|
|
ChatSessionChangeListener l);
|
|
|
|
|
}
|
|
|
|
|
|
Yana Stamcheva
16 years ago
