Overview  Package   Class  Use  Deprecated  Index
Home >> All >> edu >> ou >> kmi >> buddyspace >> [ core overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

edu.ou.kmi.buddyspace.core
Class BSMessengerBean  

java.lang.Object
  edu.ou.kmi.buddyspace.core.BSMessengerBean

All Implemented Interfaces:

org.jabber.jabberbeans.PacketListener

---

public class BSMessengerBean

extends java.lang.Object

implements org.jabber.jabberbeans.PacketListener

BSMessengerBean provides message handling. It relies on BSConnectionBean, which must be set after each reconnection. It uses MessengerBean.

---

Field Summary
private  java.util.Vector	blockedJIDs
private  boolean	blockGroupChat
private  org.jabber.jabberbeans.MessengerBean	msgBean
private  java.util.Vector	msgListeners
private  java.util.Hashtable	msgTimeStamps
private  java.lang.String	name
static java.lang.String	PLAIN_MESSAGE
private  java.util.Hashtable	unreadMsgs

 

Constructor Summary
(package private)	BSMessengerBean()           Constructor
(package private)	BSMessengerBean(org.jabber.jabberbeans.ConnectionBean connection)           Constructor, which sets existing and connected ConnectionBean.

 

Method Summary
void	addMessageListener(BSMessageListener listener)           Adds MessageListener from listeners notified when unread messages change.
void	deleteMessagePacket(org.jabber.jabberbeans.Message msg)           Deletes given message from unread messages and fires messageRead event.
private  void	fireMessageError(JID toAddress, java.lang.String errType, java.lang.String error)           Notifies message listeners that a message to toAddress was not delivered because of error.
private  void	fireMessageError(org.jabber.jabberbeans.Message msg)           Notifies message listeners that a message to toAddress was not delivered because of error.
private  void	fireMessageRead(org.jabber.jabberbeans.Message msg)           Notifies message listeners that a message from fromAddress was read.
private  void	fireMessageReceived(org.jabber.jabberbeans.Message msg)           Notifies message listeners that message was received from fromAddress.
protected  org.jabber.jabberbeans.ConnectionBean	getConnection()           Returns currently used ConnectionBean.
java.util.Enumeration	getMessagePackets(JID jid, java.lang.String type)           Returns the Enumeration of message packets for given jid (or all JIDs if jid is null) of given type.
java.util.Enumeration	getMessagePackets(JID jid, java.util.Vector types)           Returns the Enumeration of message packets for given jid (or all JIDs if jid is null) of any from given types.
java.util.Enumeration	getMessagePackets(java.lang.String type)           Returns the Enumeration of message packets of given type.
org.jabber.jabberbeans.MessengerBean	getMessengerBean()           Returns currently used MessengerBean.
java.util.Date	getTimeStamp(org.jabber.jabberbeans.Message msg)           Returns time-stamp when the given message was received
private  void	handleError(org.jabber.jabberbeans.Message msg)           Handles Message packet, if it does contain an error.
private  void	handleMessage(org.jabber.jabberbeans.Message msg)           Handles Message packet, if it doesn't contain an error.
boolean	isMessageWaiting(JID jid)           Returns if there is some unread message for given jid.
java.lang.String	popFirstMessage(JID jid)           Returns the oldest unread message body for given jid and removes the message from list of unread.
org.jabber.jabberbeans.Message	popFirstMessagePacket(JID jid)           Returns the oldest unread message packet for given jid and removes the message from list of unread.
protected  void	prepareToDestroy()           Frees all object bindings to allow object destroy
void	receivedPacket(PacketEvent pe)           Invoked when a message packet is received.
void	removeAllMessageListeners()           Removes all listeners notified when unread messages change.
void	removeMessageListener(BSMessageListener listener)           Removes MessageListener from listeners notified when unread messages change.
boolean	sendChatMessage(JID jid, java.lang.String body, java.lang.String thread)           Sends chat message with given body and thread to given jid.
void	sendFailed(PacketEvent pe)           Invoked when a message packet send failes.
boolean	sendMessage(JID jid, java.lang.String body, java.lang.String subject)           Sends plain message with given body and subject to given jid.
boolean	sendMessage(JID jid, java.lang.String type, java.lang.String subject, java.lang.String body, java.lang.String thread)           Sends message of given type with subject, body and thread to given jid.
boolean	sendMessage(org.jabber.jabberbeans.Message msg)           Sends given message packet.
org.jabber.jabberbeans.Message	sendURLMessage(JID jid, java.lang.String type, java.lang.String subject, java.lang.String body, java.lang.String thread, java.lang.String url, java.lang.String urlDesc)           Sends message of given type with embedded URL.
void	sentPacket(PacketEvent pe)           Invoked when a message packet is sent.
protected  void	setConnection(org.jabber.jabberbeans.ConnectionBean connection)           Sets existing and connected ConnectionBean.
void	startBlocking(JID jid)           Starts blocking messages from given JID and its resources.
void	startBlockingGroupChat()           Starts blocking groupchat messages.
void	stopBlocking(JID jid)           Stops blocking messages from given JID and its resources.
void	stopBlockingGroupChat()           Stops blocking blocking groupchat messages.
protected  void	storeMessageTimeStamp(org.jabber.jabberbeans.Message msg)           Stores message time-stamp.

 

Methods inherited from class java.lang.Object

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

 

Methods inherited from interface org.jabber.jabberbeans.PacketListener

receivedPacket, sentPacket

 

Field Detail

msgBean

private org.jabber.jabberbeans.MessengerBean msgBean

---

name

private java.lang.String name

---

unreadMsgs

private java.util.Hashtable unreadMsgs

---

msgTimeStamps

private java.util.Hashtable msgTimeStamps

---

msgListeners

private java.util.Vector msgListeners

---

blockedJIDs

private java.util.Vector blockedJIDs

---

blockGroupChat

private boolean blockGroupChat

---

PLAIN_MESSAGE

public static final java.lang.String PLAIN_MESSAGE

See Also:

Constant Field Values

Constructor Detail

BSMessengerBean

BSMessengerBean()

Constructor

---

BSMessengerBean

BSMessengerBean(org.jabber.jabberbeans.ConnectionBean connection)

Constructor, which sets existing and connected ConnectionBean. Then MessengerBean is created and this is registered as listener for message packets.

Method Detail

setConnection

protected void setConnection(org.jabber.jabberbeans.ConnectionBean connection)

Sets existing and connected ConnectionBean. Then MessengerBean is created and this is registered as listener for message packets.

---

getConnection

protected org.jabber.jabberbeans.ConnectionBean getConnection()

Returns currently used ConnectionBean.

---

getMessengerBean

public org.jabber.jabberbeans.MessengerBean getMessengerBean()

Returns currently used MessengerBean.

---

prepareToDestroy

protected void prepareToDestroy()

Frees all object bindings to allow object destroy

---

sendMessage

public boolean sendMessage(org.jabber.jabberbeans.Message msg)

Sends given message packet.

---

sendMessage

public boolean sendMessage(JID jid,
                           java.lang.String type,
                           java.lang.String subject,
                           java.lang.String body,
                           java.lang.String thread)

Sends message of given type with subject, body and thread to given jid. Returns if sending was successfull.

---

sendURLMessage

public org.jabber.jabberbeans.Message sendURLMessage(JID jid,
                                                     java.lang.String type,
                                                     java.lang.String subject,
                                                     java.lang.String body,
                                                     java.lang.String thread,
                                                     java.lang.String url,
                                                     java.lang.String urlDesc)

Sends message of given type with embedded URL. Returns sent Message packet - if failed returns null.

---

sendMessage

public boolean sendMessage(JID jid,
                           java.lang.String body,
                           java.lang.String subject)

Sends plain message with given body and subject to given jid. Returns if sending was successfull.

---

sendChatMessage

public boolean sendChatMessage(JID jid,
                               java.lang.String body,
                               java.lang.String thread)

Sends chat message with given body and thread to given jid. Returns if sending was successfull.

---

getMessagePackets

public java.util.Enumeration getMessagePackets(JID jid,
                                               java.util.Vector types)

Returns the Enumeration of message packets for given jid (or all JIDs if jid is null) of any from given types. Plain message type is specified by BSMessengerBean.PLAIN_MESSAGE.

---

getMessagePackets

public java.util.Enumeration getMessagePackets(java.lang.String type)

Returns the Enumeration of message packets of given type.

---

getMessagePackets

public java.util.Enumeration getMessagePackets(JID jid,
                                               java.lang.String type)

Returns the Enumeration of message packets for given jid (or all JIDs if jid is null) of given type.

---

getTimeStamp

public java.util.Date getTimeStamp(org.jabber.jabberbeans.Message msg)

Returns time-stamp when the given message was received

---

popFirstMessage

public java.lang.String popFirstMessage(JID jid)

Returns the oldest unread message body for given jid and removes the message from list of unread. Then it notifies listeners that the message was read.

---

popFirstMessagePacket

public org.jabber.jabberbeans.Message popFirstMessagePacket(JID jid)

Returns the oldest unread message packet for given jid and removes the message from list of unread. Then it notifies listeners that the message was read.

---

deleteMessagePacket

public void deleteMessagePacket(org.jabber.jabberbeans.Message msg)

Deletes given message from unread messages and fires messageRead event.

---

isMessageWaiting

public boolean isMessageWaiting(JID jid)

Returns if there is some unread message for given jid.

---

receivedPacket

public void receivedPacket(PacketEvent pe)

Invoked when a message packet is received.

---

storeMessageTimeStamp

protected void storeMessageTimeStamp(org.jabber.jabberbeans.Message msg)

Stores message time-stamp.

---

handleMessage

private void handleMessage(org.jabber.jabberbeans.Message msg)

Handles Message packet, if it doesn't contain an error.

---

handleError

private void handleError(org.jabber.jabberbeans.Message msg)

Handles Message packet, if it does contain an error.

---

sendFailed

public void sendFailed(PacketEvent pe)

Invoked when a message packet send failes.

---

sentPacket

public void sentPacket(PacketEvent pe)

Invoked when a message packet is sent.

---

startBlocking

public void startBlocking(JID jid)

Starts blocking messages from given JID and its resources.

---

stopBlocking

public void stopBlocking(JID jid)

Stops blocking messages from given JID and its resources.

---

startBlockingGroupChat

public void startBlockingGroupChat()

Starts blocking groupchat messages.

---

stopBlockingGroupChat

public void stopBlockingGroupChat()

Stops blocking blocking groupchat messages.

---

addMessageListener

public void addMessageListener(BSMessageListener listener)

Adds MessageListener from listeners notified when unread messages change.

---

removeMessageListener

public void removeMessageListener(BSMessageListener listener)

Removes MessageListener from listeners notified when unread messages change.

---

removeAllMessageListeners

public void removeAllMessageListeners()

Removes all listeners notified when unread messages change. This can be used before to free dependencies and allow dispose of all objects.

---

fireMessageReceived

private void fireMessageReceived(org.jabber.jabberbeans.Message msg)

Notifies message listeners that message was received from fromAddress.

---

fireMessageRead

private void fireMessageRead(org.jabber.jabberbeans.Message msg)

Notifies message listeners that a message from fromAddress was read.

---

fireMessageError

private void fireMessageError(org.jabber.jabberbeans.Message msg)

Notifies message listeners that a message to toAddress was not delivered because of error.

---

fireMessageError

private void fireMessageError(JID toAddress,
                              java.lang.String errType,
                              java.lang.String error)

Notifies message listeners that a message to toAddress was not delivered because of error.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> edu >> ou >> kmi >> buddyspace >> [ core overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---