ClearspaceMUCTranscriptManager (Openfire 3.9.3 Javadoc)

Overview

Package

Class

Tree

Deprecated

Index

Help

Openfire 3.9.3 Javadoc

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jivesoftware.openfire.clearspace
Class ClearspaceMUCTranscriptManager

java.lang.Object
  org.jivesoftware.openfire.clearspace.ClearspaceMUCTranscriptManager

All Implemented Interfaces:: MUCEventListener

public class ClearspaceMUCTranscriptManager
extends Object
implements MUCEventListener
extends Object
implements MUCEventListener

Stores MUC events that are intended to be recorded as a transcript for a group chat room in Clearspace. A task will periodically flush the queue of MUC events, sending them to the Clearspace component via XMPP for parsing and storing. Clearspace is expected to handle the packets containing MUC events by parsing them as they come in, accumulating them into a daily group chat transcript for the room it is associated with. The task will flush each queue of MUC events assoicated with a room based on either the size of the queue, or time. If the size of the queue exceeds a limit we have set, or a certain period of time has elapsed, the queue will be sent to Clearspace -- whichever happens first. (When we say size of the queue, we really mean the effective size as it will appear in a transcript-update packet). Example of a transcript-update packet:

 <iq type='set' to='clearspace.example.org' from='clearspace-conference.example.org'>
         <transcript-update xmlns='http://jivesoftware.com/clearspace'>
             <presence from='user1@example.org'>
                 <roomjid>14-1234@clearspace-conference.example.org</roomjid>
                 <timestamp>1207933781000</timestamp>
             </presence>
             <message from='user1@example.org'>
                 <roomjid>14-1234@clearspace-conference.example.org</roomjid>
                 <timestamp>1207933783000</timestamp>
                 <body>user2, I won the lottery!</body>
             </message>
             <message from='user2@example.org'>
                 <roomjid>14-1234@clearspace-conference.example.org</roomjid>
                 <timestamp>1207933785000</timestamp>
                 <body>WHAT?!</body>
             </message>
             <message from='user1@example.org'>
                 <roomjid>14-1234@clearspace-conference.example.org</roomjid>
                 <timestamp>1207933787000</timestamp>
                 <body>April Fools!</body>
             </message>
             <presence from='user3@example.org' type='unavailable'>
                 <roomjid>14-1234@clearspace-conference.example.org</roomjid>
                 <timestamp>1207933789000</timestamp>
             </presence>
             <message from="user2@example.org">
                 <roomjid>14-1234@clearspace-conference.example.org</roomjid>
                 <timestamp>120793379100</timestamp>
                 <body>Wow, that was lame.</body>
             </message>

               ...
         </transcript-update>
     </iq>

Author:: Armando Jagucki

Constructor Summary
`ClearspaceMUCTranscriptManager(TaskEngine taskEngine)`

Method Summary
`void`	`messageReceived(org.xmpp.packet.JID roomJID, org.xmpp.packet.JID user, String nickname, org.xmpp.packet.Message message)` Event triggered when a room occupant sent a message to a room.
`void`	`nicknameChanged(org.xmpp.packet.JID roomJID, org.xmpp.packet.JID user, String oldNickname, String newNickname)` Event triggered when an occupant changed his nickname in a room.
`void`	`occupantJoined(org.xmpp.packet.JID roomJID, org.xmpp.packet.JID user, String nickname)` Event triggered when a new occupant joins a room.
`void`	`occupantLeft(org.xmpp.packet.JID roomJID, org.xmpp.packet.JID user)` Event triggered when an occupant left a room.
`void`	`privateMessageRecieved(org.xmpp.packet.JID fromJID, org.xmpp.packet.JID toJID, org.xmpp.packet.Message message)` Event triggered when a room occupant sent a private message to another room user
`void`	`roomCreated(org.xmpp.packet.JID roomJID)` Event triggered when a new room was created.
`void`	`roomDestroyed(org.xmpp.packet.JID roomJID)` Event triggered when a room was destroyed.
`void`	`roomSubjectChanged(org.xmpp.packet.JID roomJID, org.xmpp.packet.JID user, String newSubject)` Event triggered when the subject of a room is changed.
`void`	`start()`
`void`	`stop()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

ClearspaceMUCTranscriptManager

public ClearspaceMUCTranscriptManager(TaskEngine taskEngine)

Method Detail

start

public void start()