ChatTool (sakai-chat-tool 10.4 API)

java.lang.Object
- org.sakaiproject.chat2.tool.ChatTool

All Implemented Interfaces:

org.sakaiproject.chat2.model.PresenceObserver, org.sakaiproject.chat2.model.RoomObserver
```
public class ChatTool
extends Object
implements org.sakaiproject.chat2.model.RoomObserver, org.sakaiproject.chat2.model.PresenceObserver
```
This class is used in two ways: 1) It is a JSF backing bean, with session scope. A new one is created every time the user enters the main chat tool. This includes a refresh. 2) It is an observer. It is put on a list of observers for the room by AddRoomListener. This double existence is messy, because JSF manages beans, but if JSF replaces or finishes the bean, there is no automatic way for it to get removed from the list of observers. Getting it off the list of observers is kind of tricky, because there's no direct way to know when the instance is no longer valid. Since a refresh generates a new instance, we have to get rid of the old one, or the list of observers keeps growing. The hash table "tools" is used to keep track of instances so we can kill old ones. This code was originally written when there was at most one chat room per site. For that it made sense for the backing bean to have session scope (because going to a new site goes through the main entry and generates a new instance). We really need to redo this with the bean at request scope and other data structures for things that live longer. But I found out about this issue a week before 2.6 was due. So I've adopted a hack. The bean is now in theory session scope but actually may be shared by more than one chat room in a site. It should never cross sites. That means there are now a couple of data structures indexed by room ID, to handle more than one room. The JSP's all set the current room ID when doing a submit. So that lets them share the single backing bean. The other way an instance can become invalid is if the session goes away. So in userLeft and a couple of other places we check we check whether the current session is still alive, and if not, remove the instance. This bookkeeping is done in SetCurrentChannel and ResetCurrentChannel, so they should be the only code to call AddRoomListener and RemoveRoomListener. For final cleanup we depend upon the fact that all observers will eventually get either UserLeft or ReceivedMessage, and the code will notice that the session no longer exists. At times UserLeft seems to be called when the session is still there, but when the next user logs out, it will get called again with no session. Chat works by the courier but not the same way as the old message delivery system. The courier sends messages into the JSF tool. When the user dials home it then picks up the messages. COOL TECHNOLOGY ALERT: TODO: The page that sends the messages is polled, the tool can wait on the connection until it recieves a message to send or until it times out. This would provide instant messaging as opposed to polling. When entering the tool the first main page calls the enterTool function which redirects the users based upon the tool's preferences: go to select a room or to a specific tool. NB: each time enterTool is called, we are dealing with a new instance. The PresenceObserverHelper is placed on the current room. This this tool is informed when a user enters and exits the room.

Author:

andersjb

Field Summary

Fields
Modifier and Type Field and Description

protected org.sakaiproject.courier.api.CourierService m_courierService
Constructor discovered injected CourierService.

Fields
Modifier and Type	Field and Description
`protected org.sakaiproject.courier.api.CourierService`	`m_courierService` Constructor discovered injected CourierService.

Constructor Summary

Constructors
Constructor and Description

ChatTool()

Constructors
Constructor and Description
`ChatTool()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected int`	`countChannelMessages(org.sakaiproject.chat2.model.ChatChannel channel)`
`SelectItem`	`createSelect(Object id, String description)`
`String`	`getAccessibleOptionsLink()`
`protected String`	`getAllMessagesText()`
`boolean`	`getCanCreateChannel()`
`boolean`	`getCanEditChannel(org.sakaiproject.chat2.model.ChatChannel channel)`
`boolean`	`getCanManageTool()` Check for add/edit/del perms on the channel
`boolean`	`getCanPost()`
`boolean`	`getCanRead(org.sakaiproject.chat2.model.ChatChannel channel)`
`boolean`	`getCanRemoveChannel(org.sakaiproject.chat2.model.ChatChannel channel)`
`boolean`	`getCanRemoveChannelMessages(org.sakaiproject.chat2.model.ChatChannel channel)`
`boolean`	`getCanRemoveMessage(org.sakaiproject.chat2.model.ChatMessage message)`
`boolean`	`getCanRenderAllMessages()`
`boolean`	`getCanRenderDateMessages()`
`boolean`	`getCanRenderMessageOptions()` Determins if the message option display dropdown gets rendered or not
`boolean`	`getCanRenderNoMessages()`
`boolean`	`getCanRenderNumberMessages()`
`List<DecoratedChatChannel>`	`getChatChannels()` gets the tool decorated channels
`String`	`getChatFunctionPrefix()`
`org.sakaiproject.chat2.model.ChatManager`	`getChatManager()` gets the chatManager
`List<SelectItem>`	`getChatRoomsSelectItems()` This creates select items out of the channels available to the tool
`ColorMapper`	`getColorMapper()`
`protected String`	`getContext()` Gets the id of the site we are in
`String`	`getCourierString()` This allows us to change/give the courier address.
`DecoratedChatChannel`	`getCurrentChannel()` gets the current channel
`DecoratedChatChannel`	`getCurrentChannelEdit()`
`String`	`getCurrentChatChannelId()` gets the channel id of the current channel.
`DecoratedChatMessage`	`getCurrentMessage()`
`DecoratedSynopticOptions`	`getCurrentSynopticOptions()`
`protected String`	`getCustomOptionText(String filterType, int filterParam)`
`protected String`	`getCustomOptionValue(String filterType)`
`String`	`getDatesMessage()`
`boolean`	`getDisplayDate()`
`boolean`	`getDisplayId()`
`boolean`	`getDisplayTime()`
`String`	`getEnterTool()` This is called from the first page to redirect the user to the proper view.
`String`	`getFramePlacementId()` Returns the frame identifier for resizing
`boolean`	`getMaintainer()`
`String`	`getMessageFromBundle(String key)`
`String`	`getMessageFromBundle(String key, Object[] args)`
`String`	`getMessageOptions()`
`List<SelectItem>`	`getMessageOptionsList()`
`String`	`getMessageOwnerDisplayName(org.sakaiproject.chat2.model.ChatMessage message)`
`protected List<DecoratedChatMessage>`	`getMessages(String context, Date limitDate, int numMessages, boolean sortAsc)`
`protected int`	`getMessagesCount(String context, Date limitDate)`
`String`	`getMessagesShownTotalText()`
`String`	`getNewMessageText()`
`protected String`	`getNoMessagesText()`
`protected String`	`getPastXDaysText(int x)`
`protected String`	`getPastXMessagesText(int x)`
`String`	`getPermissionsMessage()`
`List<DecoratedChatMessage>`	`getRoomMessages()`
`int`	`getRoomMessagesCount()` Finds the current messages count for the current room
`String`	`getServerUrl()`
`String`	`getSessionId()`
`int`	`getSiteChannelCount()` gets the number of channels in this site
`protected List<org.sakaiproject.chat2.model.ChatChannel>`	`getSiteChannels()` gets the channels in this site
`boolean`	`getSoundAlert()`
`List<DecoratedChatMessage>`	`getSynopticMessages()`
`String`	`getToolContext()`
`org.sakaiproject.tool.api.ToolManager`	`getToolManager()`
`String`	`getToolString()` Gets the id of the tool we are in
`String`	`getToolTitle()`
`List<String>`	`getUsersInCurrentChannel()` this gets the users in a channel.
`String`	`getViewingChatRoomText()`
`String`	`getViewOptions()`
`org.sakaiproject.site.api.Site`	`getWorksite()`
`protected int`	`initMessageOptions()`
`boolean`	`isDatesRestricted()`
`DecoratedSynopticOptions`	`lookupSynopticOptions()`
`String`	`processActionAddRoom()`
`String`	`processActionBackToRoom()`
`String`	`processActionCancelChangeChannel()` When the user wants to cancel changing a room
`String`	`processActionDeleteMessage()` Deletes the current message
`String`	`processActionDeleteMessageCancel()` Cancels the delete of the current message
`protected String`	`processActionDeleteMessageConfirm(DecoratedChatMessage message)` Deletes the specified message
`String`	`processActionDeleteRoom()` deletes the current room and all it's messages
`String`	`processActionDeleteRoomCancel()` cancels the deletion of a room via the confirmation
`protected String`	`processActionDeleteRoomConfirm(DecoratedChatChannel chatChannel)` Sets the current room and goes to confirm deleting the room
`String`	`processActionDeleteRoomMessages()` deletes the current room's messages
`String`	`processActionDeleteRoomMessagesCancel()` cancels the deletion of a room's messages via the confirmation
`protected String`	`processActionDeleteRoomMessagesConfirm(DecoratedChatChannel chatChannel)` Sets the current room and goes to confirm deleting the room's messages
`protected String`	`processActionEditRoom(DecoratedChatChannel chatChannel)` Sets the current room and goes to edit that room
`String`	`processActionEditRoomCancel()` Sets the current room to null
`String`	`processActionEditRoomSave()` Sets the current room to null
`protected String`	`processActionEnterRoom(DecoratedChatChannel chatChannel)` Sets the current room and goes to the room page
`String`	`processActionListRooms()`
`String`	`processActionPermissions()`
`String`	`processActionSetAsDefaultRoom(DecoratedChatChannel decoChannel)`
`String`	`processActionSynopticOptions()`
`String`	`processActionSynopticOptionsCancel()`
`String`	`processActionSynopticOptionsSave()`
`void`	`receivedMessage(String roomId, Object message)` in the context of the event manager thread
`protected void`	`resetCurrentChannel(DecoratedChatChannel oldChannel)`
`void`	`roomDeleted(String roomId)`
`void`	`setChatManager(org.sakaiproject.chat2.model.ChatManager chatManager)` Sets the chatManager
`void`	`setColorMapper(ColorMapper colorMapper)`
`void`	`setCurrentChannel(DecoratedChatChannel channel)` Implements a change of the chat room.
`void`	`setCurrentChannelEdit(DecoratedChatChannel currentChannelEdit)`
`void`	`setCurrentChatChannelId(String channelId)`
`void`	`setCurrentMessage(DecoratedChatMessage currentMessage)`
`void`	`setCurrentSynopticOptions(DecoratedSynopticOptions currentSynopticOptions)`
`void`	`setMessageOptions(String messageOptions)`
`void`	`setNewMessageText(String newMessageText)`
`void`	`setToolContext(String toolContext)`
`void`	`setToolManager(org.sakaiproject.tool.api.ToolManager toolManager)`
`protected void`	`setupTool()`
`void`	`setViewOptions(String d)`
`void`	`userJoined(String location, String user)`
`void`	`userLeft(String location, String user)` In addition to refreshing the list, this code takes care of removing instances associated with processes that are now dead.
`protected boolean`	`validateChannel(org.sakaiproject.chat2.model.ChatChannel channel)` Make sure that the channel has a title when saving, the title isn't too long, and the description isn't too long
`void`	`validatePositiveNumber(FacesContext context, UIComponent component, Object value)`

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

- Field Detail
  - m_courierService
```
protected org.sakaiproject.courier.api.CourierService m_courierService
```
    Constructor discovered injected CourierService.
- Constructor Detail
  - ChatTool
```
public ChatTool()
```
- Method Detail
  - setupTool
```
protected void setupTool()
```
  - getEnterTool
```
public String getEnterTool()
```
    This is called from the first page to redirect the user to the proper view. This is the first call after JSF creates a new instance, so initialization is done here. If the tool is set to go to the select a chat room view and there are multiple chat rooms, then it will go to the select a room page. If the user is to select a room and there is only one room, then it will go to that room.
    
    Returns:
    String
  - getUsersInCurrentChannel
```
public List<String> getUsersInCurrentChannel()
```
    this gets the users in a channel. It is typically called from roomUsers.jsp to display or refresh the list. Despite the name, if called from a JSP with channel as an argument, it uses that channel. Otherwise the current channel.
    
    Returns:
    List of String display names
  - receivedMessage
```
public void receivedMessage(String roomId,
                   Object message)
```
    in the context of the event manager thread
    
    Specified by:
    
    receivedMessage in interface org.sakaiproject.chat2.model.RoomObserver
  - roomDeleted
```
public void roomDeleted(String roomId)
```
    Specified by:
    
    roomDeleted in interface org.sakaiproject.chat2.model.RoomObserver
  - userJoined
```
public void userJoined(String location,
              String user)
```
    Specified by:
    
    userJoined in interface org.sakaiproject.chat2.model.PresenceObserver
  - userLeft
```
public void userLeft(String location,
            String user)
```
    In addition to refreshing the list, this code takes care of removing instances associated with processes that are now dead. Despite the user argument, the API doesn't tell us what user left. So the best we can do is check ourself, and rely on the fact that this will be called once for each user who has an observer in the room observer list, so the user who left should catch himself.
    
    Specified by:
    
    userLeft in interface org.sakaiproject.chat2.model.PresenceObserver
  - validateChannel
```
protected boolean validateChannel(org.sakaiproject.chat2.model.ChatChannel channel)
```
    Make sure that the channel has a title when saving, the title isn't too long, and the description isn't too long
    
    Parameters:
    channel -
    
    Returns:
    Returns if the channel validates
  - processActionCancelChangeChannel
```
public String processActionCancelChangeChannel()
```
    When the user wants to cancel changing a room
    
    Returns:
    String next page
  - processActionSetAsDefaultRoom
```
public String processActionSetAsDefaultRoom(DecoratedChatChannel decoChannel)
```
  - processActionAddRoom
```
public String processActionAddRoom()
```
  - processActionPermissions
```
public String processActionPermissions()
```
  - processActionSynopticOptions
```
public String processActionSynopticOptions()
```
  - processActionSynopticOptionsSave
```
public String processActionSynopticOptionsSave()
```
  - processActionSynopticOptionsCancel
```
public String processActionSynopticOptionsCancel()
```
  - processActionBackToRoom
```
public String processActionBackToRoom()
```
  - getChatFunctionPrefix
```
public String getChatFunctionPrefix()
```
  - getPermissionsMessage
```
public String getPermissionsMessage()
```
  - getDatesMessage
```
public String getDatesMessage()
```
    Returns:
    the translated message based on the current date settings for this channel
  - isDatesRestricted
```
public boolean isDatesRestricted()
```
    Returns:
    true if chat posting is restricted by configured dates or false otherwise
  - getWorksite
```
public org.sakaiproject.site.api.Site getWorksite()
```
  - processActionEnterRoom
```
protected String processActionEnterRoom(DecoratedChatChannel chatChannel)
```
    Sets the current room and goes to the room page
    
    Parameters:
    chatChannel -
    
    Returns:
    String selects a new room to go into
  - processActionListRooms
```
public String processActionListRooms()
```
  - processActionEditRoom
```
protected String processActionEditRoom(DecoratedChatChannel chatChannel)
```
    Sets the current room and goes to edit that room
    
    Parameters:
    chatChannel -
    
    Returns:
    String goes to the edit room view
  - processActionEditRoomSave
```
public String processActionEditRoomSave()
```
    Sets the current room to null
    
    Returns:
    String goes to the edit room view
  - processActionEditRoomCancel
```
public String processActionEditRoomCancel()
```
    Sets the current room to null
    
    Returns:
    String goes to the edit room view
  - processActionDeleteRoomConfirm
```
protected String processActionDeleteRoomConfirm(DecoratedChatChannel chatChannel)
```
    Sets the current room and goes to confirm deleting the room
    
    Parameters:
    chatChannel -
    
    Returns:
    String goes to the delete room confirmation page
  - processActionDeleteRoom
```
public String processActionDeleteRoom()
```
    deletes the current room and all it's messages
    
    Returns:
    String goes to the select a room page
  - processActionDeleteRoomCancel
```
public String processActionDeleteRoomCancel()
```
    cancels the deletion of a room via the confirmation
    
    Returns:
    String goes to the select a room page
  - processActionDeleteRoomMessagesConfirm
```
protected String processActionDeleteRoomMessagesConfirm(DecoratedChatChannel chatChannel)
```
    Sets the current room and goes to confirm deleting the room's messages
    
    Parameters:
    chatChannel -
    
    Returns:
    String goes to the delete room messages confirmation page
  - processActionDeleteRoomMessages
```
public String processActionDeleteRoomMessages()
```
    deletes the current room's messages
    
    Returns:
    String goes to the select a room page
  - processActionDeleteRoomMessagesCancel
```
public String processActionDeleteRoomMessagesCancel()
```
    cancels the deletion of a room's messages via the confirmation
    
    Returns:
    String goes to the select a room page
  - processActionDeleteMessage
```
public String processActionDeleteMessage()
```
    Deletes the current message
    
    Returns:
    String goes to the room's main page
  - processActionDeleteMessageConfirm
```
protected String processActionDeleteMessageConfirm(DecoratedChatMessage message)
```
    Deletes the specified message
    
    Parameters:
    message -
    
    Returns:
    String goes to the delete message page
  - processActionDeleteMessageCancel
```
public String processActionDeleteMessageCancel()
```
    Cancels the delete of the current message
    
    Returns:
    String goes to the room's main page
  - getCourierString
```
public String getCourierString()
```
    This allows us to change/give the courier address. We want the courier to respond to the chat room.
    
    Returns:
    String
  - getCanManageTool
```
public boolean getCanManageTool()
```
    Check for add/edit/del perms on the channel
    
    Returns:
  - getCurrentChatChannelId
```
public String getCurrentChatChannelId()
```
    gets the channel id of the current channel. If there isn't one then give a blank string
    
    Returns:
    ChatManager
  - setCurrentChatChannelId
```
public void setCurrentChatChannelId(String channelId)
```
  - getCurrentChannel
```
public DecoratedChatChannel getCurrentChannel()
```
    gets the current channel
    
    Returns:
    ChatChannel
  - setCurrentChannel
```
public void setCurrentChannel(DecoratedChatChannel channel)
```
    Implements a change of the chat room. It removes presence from the prior room, adds observation of the new room, and then becomes present in the new room
    
    Parameters:
    channel -
  - resetCurrentChannel
```
protected void resetCurrentChannel(DecoratedChatChannel oldChannel)
```
  - getCurrentChannelEdit
```
public DecoratedChatChannel getCurrentChannelEdit()
```
    Returns:
    the currentChannelEdit
  - setCurrentChannelEdit
```
public void setCurrentChannelEdit(DecoratedChatChannel currentChannelEdit)
```
    Parameters:
    currentChannelEdit - the currentChannelEdit to set
  - getCurrentMessage
```
public DecoratedChatMessage getCurrentMessage()
```
    Returns:
    the currentMessage
  - setCurrentMessage
```
public void setCurrentMessage(DecoratedChatMessage currentMessage)
```
    Parameters:
    currentMessage - the currentMessage to set
  - lookupSynopticOptions
```
public DecoratedSynopticOptions lookupSynopticOptions()
```
  - getCurrentSynopticOptions
```
public DecoratedSynopticOptions getCurrentSynopticOptions()
```
    Returns:
    the synopticOptions
  - setCurrentSynopticOptions
```
public void setCurrentSynopticOptions(DecoratedSynopticOptions currentSynopticOptions)
```
    Parameters:
    synopticOptions - the synopticOptions to set
  - getChatRoomsSelectItems
```
public List<SelectItem> getChatRoomsSelectItems()
```
    This creates select items out of the channels available to the tool
    
    Returns:
    List of SelectItem
  - getChatChannels
```
public List<DecoratedChatChannel> getChatChannels()
```
    gets the tool decorated channels
    
    Returns:
  - getChatManager
```
public org.sakaiproject.chat2.model.ChatManager getChatManager()
```
    gets the chatManager
    
    Returns:
    ChatManager
  - getViewOptions
```
public String getViewOptions()
```
  - setViewOptions
```
public void setViewOptions(String d)
```
  - initMessageOptions
```
protected int initMessageOptions()
```
  - getMessageOptions
```
public String getMessageOptions()
```
    Returns:
    the messageOptions
  - setMessageOptions
```
public void setMessageOptions(String messageOptions)
```
    Parameters:
    messageOptions - the messageOptions to set
  - getNewMessageText
```
public String getNewMessageText()
```
  - setNewMessageText
```
public void setNewMessageText(String newMessageText)
```
  - setChatManager
```
public void setChatManager(org.sakaiproject.chat2.model.ChatManager chatManager)
```
    Sets the chatManager
    
    Parameters:
    chatManager - ChatManager
  - getToolManager
```
public org.sakaiproject.tool.api.ToolManager getToolManager()
```
  - setToolManager
```
public void setToolManager(org.sakaiproject.tool.api.ToolManager toolManager)
```
  - getColorMapper
```
public ColorMapper getColorMapper()
```
  - setColorMapper
```
public void setColorMapper(ColorMapper colorMapper)
```
  - getDisplayDate
```
public boolean getDisplayDate()
```
  - getDisplayTime
```
public boolean getDisplayTime()
```
  - getDisplayId
```
public boolean getDisplayId()
```
  - getCanRenderAllMessages
```
public boolean getCanRenderAllMessages()
```
  - getCanRenderDateMessages
```
public boolean getCanRenderDateMessages()
```
  - getCanRenderNumberMessages
```
public boolean getCanRenderNumberMessages()
```
  - getCanRenderNoMessages
```
public boolean getCanRenderNoMessages()
```
  - getMessageOptionsList
```
public List<SelectItem> getMessageOptionsList()
```
  - getCanRenderMessageOptions
```
public boolean getCanRenderMessageOptions()
```
    Determins if the message option display dropdown gets rendered or not
    
    Returns:
  - getCustomOptionValue
```
protected String getCustomOptionValue(String filterType)
```
  - getCustomOptionText
```
protected String getCustomOptionText(String filterType,
                         int filterParam)
```
  - getSoundAlert
```
public boolean getSoundAlert()
```
  - countChannelMessages
```
protected int countChannelMessages(org.sakaiproject.chat2.model.ChatChannel channel)
```
  - getRoomMessages
```
public List<DecoratedChatMessage> getRoomMessages()
```
  - getRoomMessagesCount
```
public int getRoomMessagesCount()
```
    Finds the current messages count for the current room
    
    Returns:
    the count of the total messages for this chatroom
  - getSynopticMessages
```
public List<DecoratedChatMessage> getSynopticMessages()
```
  - getMessages
```
protected List<DecoratedChatMessage> getMessages(String context,
                                     Date limitDate,
                                     int numMessages,
                                     boolean sortAsc)
```
    Parameters:
    context -
    limitDate -
    numMessages -
    sortAsc -
    
    Returns:
    the set of all messages in this channel, limited to a max of 100 for paging
  - getMessagesCount
```
protected int getMessagesCount(String context,
                   Date limitDate)
```
    Returns:
    the number of items in this channel, mostly for paging
  - getCanRemoveMessage
```
public boolean getCanRemoveMessage(org.sakaiproject.chat2.model.ChatMessage message)
```
  - getCanRemoveChannel
```
public boolean getCanRemoveChannel(org.sakaiproject.chat2.model.ChatChannel channel)
```
  - getCanRemoveChannelMessages
```
public boolean getCanRemoveChannelMessages(org.sakaiproject.chat2.model.ChatChannel channel)
```
  - getCanEditChannel
```
public boolean getCanEditChannel(org.sakaiproject.chat2.model.ChatChannel channel)
```
  - getCanCreateChannel
```
public boolean getCanCreateChannel()
```
  - getCanRead
```
public boolean getCanRead(org.sakaiproject.chat2.model.ChatChannel channel)
```
  - getCanPost
```
public boolean getCanPost()
```
  - getMaintainer
```
public boolean getMaintainer()
```
  - getMessageOwnerDisplayName
```
public String getMessageOwnerDisplayName(org.sakaiproject.chat2.model.ChatMessage message)
```
  - getPastXDaysText
```
protected String getPastXDaysText(int x)
```
  - getPastXMessagesText
```
protected String getPastXMessagesText(int x)
```
  - getNoMessagesText
```
protected String getNoMessagesText()
```
  - getAllMessagesText
```
protected String getAllMessagesText()
```
  - getMessagesShownTotalText
```
public String getMessagesShownTotalText()
```
  - getViewingChatRoomText
```
public String getViewingChatRoomText()
```
  - getServerUrl
```
public String getServerUrl()
```
  - getToolString
```
public String getToolString()
```
    Gets the id of the tool we are in
    
    Returns:
    String
  - getContext
```
protected String getContext()
```
    Gets the id of the site we are in
    
    Returns:
    String
  - getFramePlacementId
```
public String getFramePlacementId()
```
    Returns the frame identifier for resizing
    
    Returns:
  - getSiteChannels
```
protected List<org.sakaiproject.chat2.model.ChatChannel> getSiteChannels()
```
    gets the channels in this site
    
    Returns:
    List of ChatChannel
  - getSiteChannelCount
```
public int getSiteChannelCount()
```
    gets the number of channels in this site
    
    Returns:
    int
  - createSelect
```
public SelectItem createSelect(Object id,
                      String description)
```
  - getMessageFromBundle
```
public String getMessageFromBundle(String key,
                          Object[] args)
```
  - getMessageFromBundle
```
public String getMessageFromBundle(String key)
```
  - getToolContext
```
public String getToolContext()
```
  - setToolContext
```
public void setToolContext(String toolContext)
```
  - getSessionId
```
public String getSessionId()
```
  - validatePositiveNumber
```
public void validatePositiveNumber(FacesContext context,
                          UIComponent component,
                          Object value)
```
  - getToolTitle
```
public String getToolTitle()
```
  - getAccessibleOptionsLink
```
public String getAccessibleOptionsLink()
```

Class ChatTool

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_courierService

Constructor Detail

ChatTool

Method Detail

setupTool

getEnterTool

getUsersInCurrentChannel

receivedMessage

roomDeleted

userJoined

userLeft

validateChannel

processActionCancelChangeChannel

processActionSetAsDefaultRoom

processActionAddRoom

processActionPermissions

processActionSynopticOptions

processActionSynopticOptionsSave

processActionSynopticOptionsCancel

processActionBackToRoom

getChatFunctionPrefix

getPermissionsMessage

getDatesMessage

isDatesRestricted

getWorksite

processActionEnterRoom

processActionListRooms

processActionEditRoom

processActionEditRoomSave

processActionEditRoomCancel

processActionDeleteRoomConfirm

processActionDeleteRoom

processActionDeleteRoomCancel

processActionDeleteRoomMessagesConfirm

processActionDeleteRoomMessages

processActionDeleteRoomMessagesCancel

processActionDeleteMessage

processActionDeleteMessageConfirm

processActionDeleteMessageCancel

getCourierString

getCanManageTool

getCurrentChatChannelId

setCurrentChatChannelId

getCurrentChannel

setCurrentChannel

resetCurrentChannel

getCurrentChannelEdit

setCurrentChannelEdit

getCurrentMessage

setCurrentMessage

lookupSynopticOptions

getCurrentSynopticOptions

setCurrentSynopticOptions

getChatRoomsSelectItems

getChatChannels

getChatManager

getViewOptions

setViewOptions

initMessageOptions

getMessageOptions

setMessageOptions

getNewMessageText

setNewMessageText

setChatManager

getToolManager

setToolManager

getColorMapper

setColorMapper

getDisplayDate

getDisplayTime

getDisplayId

getCanRenderAllMessages

getCanRenderDateMessages

getCanRenderNumberMessages