|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--jChatBox.Chat.Chatroom
This class implements all features for jChatBox rooms.
Description :
- open/close chatroom.
- setup chatroom's name,topic,...
- reopen chatroom.
- add/remove user to chatroom.
- blackList management.
- Chatroom management (MAX users).
Constructor Summary | |
Chatroom(ChatroomParams params)
Chatroom constructor. |
Method Summary | |
void |
addListener(ChatroomListener listener)
Add listener to be notified on chatroom's events. |
void |
addMsg(Msg msg)
Adds message to Chat. |
void |
addToBlacklist(ChatroomUser user,
java.lang.String reason)
Add user to blacklist. |
void |
addUser(ChatroomUser newUser)
Adds user to Chatroom. |
void |
clear()
Clear chatroom content. |
void |
close()
Close the Chatroom. |
Blacklist |
getBlacklist()
Returns Blacklist. |
java.util.Vector |
getChat()
Returns the whole Chat. |
java.util.Vector |
getChat(java.lang.String username)
Returns the Chat content for an user only. |
java.util.Date |
getDate()
Returns opening date. |
java.util.Vector |
getListeners()
Return chatroom's listeners. |
ChatroomParams |
getParams()
Returns Chatroom's parameters. |
int |
getTotalUsers()
Counts Users. |
ChatroomUser |
getUser(java.lang.String name)
Returns an User. |
java.util.Hashtable |
getUsers()
Returns Users. |
boolean |
isOpened()
Return true if chatroom is opened. |
protected void |
notifyListeners(ChatroomEvent event)
Notify chatroom's listeners. |
void |
open()
Opens the Chatroom. |
void |
performLogin(ChatroomUser user)
LogListener dummy implementation. |
void |
performLogout(ChatroomUser user)
Remove user from chatroom. |
void |
removeFromBlacklist(java.lang.String ip)
Remove IP from blacklist. |
void |
removeListener(ChatroomListener listener)
Remove listener. |
void |
removeUser(java.lang.String name)
Removes an User. |
void |
reOpen()
ReOpen the Chatroom (Should be used after servlet container crash ot stop). |
void |
resetBlacklist()
Reset Blacklist. |
protected void |
runTimer(ChatroomListener listener)
Run ChatroomTimer in a Thread. |
void |
updateParams(ChatroomParams params)
Updates Chatroom's parameters. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Chatroom(ChatroomParams params)
Method Detail |
public void open()
public boolean isOpened()
public void reOpen()
public void addListener(ChatroomListener listener)
listener
- protected void runTimer(ChatroomListener listener)
listener
- public void removeListener(ChatroomListener listener)
listener
- protected void notifyListeners(ChatroomEvent event)
event
- public java.util.Vector getListeners()
public void close()
public java.util.Date getDate()
public void addUser(ChatroomUser newUser) throws ChatException
ChatException
public ChatroomUser getUser(java.lang.String name)
public int getTotalUsers()
public ChatroomParams getParams()
public void updateParams(ChatroomParams params)
public void addToBlacklist(ChatroomUser user, java.lang.String reason) throws ChatException
ChatException
public void removeFromBlacklist(java.lang.String ip)
public void resetBlacklist()
public Blacklist getBlacklist()
public void removeUser(java.lang.String name) throws ChatException
ChatException
public void addMsg(Msg msg) throws ChatException
ChatException
public java.util.Vector getChat()
public java.util.Vector getChat(java.lang.String username)
public java.util.Hashtable getUsers()
public void clear()
public void performLogout(ChatroomUser user)
performLogout
in interface LogListener
public void performLogin(ChatroomUser user)
performLogin
in interface LogListener
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |