tigase.jaxmpp.core.client.xmpp.modules.chat

Class MessageModule

java.lang.Object

tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule<T>

tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaExtendableModule<tigase.jaxmpp.core.client.xmpp.stanzas.Message>

tigase.jaxmpp.core.client.xmpp.modules.chat.MessageModule

All Implemented Interfaces:

tigase.jaxmpp.core.client.xmpp.modules.ContextAware, tigase.jaxmpp.core.client.xmpp.modules.extensions.ExtendableModule, tigase.jaxmpp.core.client.xmpp.modules.InitializingModule, tigase.jaxmpp.core.client.XmppModule

public class MessageModule
extends tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaExtendableModule<tigase.jaxmpp.core.client.xmpp.stanzas.Message>

Module to handle messages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MessageModule.ChatClosedHandler
static interface	MessageModule.ChatCreatedHandler
static interface	MessageModule.ChatUpdatedHandler
static interface	MessageModule.MessageReceivedHandler

Field Summary

Fields inherited from class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule

context, log

Constructor Summary

Constructors

Constructor and Description
MessageModule()
MessageModule(AbstractChatManager chatManager)

Method Summary

Modifier and Type	Method and Description
void	afterRegister()
void	beforeRegister()
void	close(Chat chat) Destroy chat object.
Chat	createChat(tigase.jaxmpp.core.client.JID jid) Creates new chat object.
Chat	createChatInstance(tigase.jaxmpp.core.client.xmpp.stanzas.Message message, tigase.jaxmpp.core.client.JID interlocutorJid)
protected tigase.jaxmpp.core.client.xmpp.stanzas.Message	executeBeforeMessageProcess(tigase.jaxmpp.core.client.xmpp.stanzas.Message element, Chat chat)
protected String	generateThreadID()
AbstractChatManager	getChatManager()
List<Chat>	getChats() Returns all chat objects.
tigase.jaxmpp.core.client.criteria.Criteria	getCriteria()
String[]	getFeatures()
protected boolean	isMessageHandledByMUC(tigase.jaxmpp.core.client.JID from)
void	process(tigase.jaxmpp.core.client.xmpp.stanzas.Message message)
tigase.jaxmpp.core.client.xmpp.stanzas.Message	sendMessage(Chat chat, String body) Sends message in passed chat.
tigase.jaxmpp.core.client.xmpp.stanzas.Message	sendMessage(Chat chat, String body, List<? extends tigase.jaxmpp.core.client.xml.Element> additionalElems) Sends message in passed chat.
tigase.jaxmpp.core.client.xmpp.stanzas.Message	sendMessage(tigase.jaxmpp.core.client.JID toJID, String subject, String message) Sends message.
tigase.jaxmpp.core.client.xmpp.stanzas.Message	sendMessage(tigase.jaxmpp.core.client.xmpp.stanzas.Message msg) Sends message in passed chat.
protected boolean	update(Chat chat, tigase.jaxmpp.core.client.JID fromJid, String threadId)
tigase.jaxmpp.core.client.xmpp.stanzas.Message	writeMessage(tigase.jaxmpp.core.client.xmpp.stanzas.Message msg)

Methods inherited from class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaExtendableModule

addExtension, getExtensionChain, getFeaturesWithExtensions, removeExtension, write, write, write

Methods inherited from class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule

beforeUnregister, fireEvent, getFirstChild, process, setContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageModule

public MessageModule()

MessageModule

public MessageModule(AbstractChatManager chatManager)

Method Detail

afterRegister

public void afterRegister()

Specified by:

afterRegister in interface tigase.jaxmpp.core.client.xmpp.modules.InitializingModule

Overrides:

afterRegister in class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule<tigase.jaxmpp.core.client.xmpp.stanzas.Message>

beforeRegister

public void beforeRegister()

Specified by:

beforeRegister in interface tigase.jaxmpp.core.client.xmpp.modules.InitializingModule

Overrides:

beforeRegister in class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule<tigase.jaxmpp.core.client.xmpp.stanzas.Message>

close

public void close(Chat chat)
           throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Destroy chat object.

Parameters:

chat - chat object

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

createChat

public Chat createChat(tigase.jaxmpp.core.client.JID jid)
                throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Creates new chat object.

Parameters:

jid - destination JID

Returns:

chat object

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

createChatInstance

public Chat createChatInstance(tigase.jaxmpp.core.client.xmpp.stanzas.Message message,
                               tigase.jaxmpp.core.client.JID interlocutorJid)
                        throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

getChatManager

public AbstractChatManager getChatManager()

getChats

public List<Chat> getChats()

Returns all chat objects.

Returns:

collection of chat objects.

getCriteria

public tigase.jaxmpp.core.client.criteria.Criteria getCriteria()

getFeatures

public String[] getFeatures()

process

public void process(tigase.jaxmpp.core.client.xmpp.stanzas.Message message)
             throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Specified by:

process in class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule<tigase.jaxmpp.core.client.xmpp.stanzas.Message>

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

sendMessage

public tigase.jaxmpp.core.client.xmpp.stanzas.Message sendMessage(Chat chat,
                                                                  String body)
                                                           throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Sends message in passed chat. It uses correct interlocutor JID and thread-id.

Parameters:

body - message to send.

Returns:

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

sendMessage

public tigase.jaxmpp.core.client.xmpp.stanzas.Message sendMessage(tigase.jaxmpp.core.client.xmpp.stanzas.Message msg)
                                                           throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Sends message in passed chat.

Parameters:

msg - message stanza to send.

Returns:

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

sendMessage

public tigase.jaxmpp.core.client.xmpp.stanzas.Message sendMessage(Chat chat,
                                                                  String body,
                                                                  List<? extends tigase.jaxmpp.core.client.xml.Element> additionalElems)
                                                           throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Sends message in passed chat. It uses correct interlocutor JID and thread-id.

Parameters:

body - message to send.

Returns:

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

sendMessage

public tigase.jaxmpp.core.client.xmpp.stanzas.Message sendMessage(tigase.jaxmpp.core.client.JID toJID,
                                                                  String subject,
                                                                  String message)
                                                           throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Sends message. It does not create chat object.

Parameters:

toJID - recipient's JID

subject - subject of message

message - message

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

writeMessage

public tigase.jaxmpp.core.client.xmpp.stanzas.Message writeMessage(tigase.jaxmpp.core.client.xmpp.stanzas.Message msg)
                                                            throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

executeBeforeMessageProcess

protected tigase.jaxmpp.core.client.xmpp.stanzas.Message executeBeforeMessageProcess(tigase.jaxmpp.core.client.xmpp.stanzas.Message element,
                                                                                     Chat chat)

generateThreadID

protected String generateThreadID()

isMessageHandledByMUC

protected boolean isMessageHandledByMUC(tigase.jaxmpp.core.client.JID from)

update

protected boolean update(Chat chat,
                         tigase.jaxmpp.core.client.JID fromJid,
                         String threadId)
                  throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException