Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.webchat.user
Class UserManager

java.lang.Object
  extended by com.jivesoftware.webchat.user.UserManager

public class UserManager
extends java.lang.Object

Responsible for the creation of ChatSessionManagers. ChatSessionManagers store all relevant information about one users current state, all chats and XMPPConnection. You would use this class to login to the Group Chat system.


Constructor Summary
UserManager()
          Initialization constructor.
 
Method Summary
 java.util.Map login(java.lang.String username, java.lang.String password, java.lang.String nickname, java.lang.String sessionID)
          Login user needing authentication.
 java.util.Map loginAnonymously(java.lang.String nickname, java.lang.String sessionID)
          Logs in an anonymous user.
 boolean shouldCreateNewAnonymousSession(java.lang.String sessionID)
          Returns true if a new connection and session should be created.
 boolean shouldCreateNewAuthenticatedSession(java.lang.String sessionID)
          Returns true if a new connection and session should be created.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserManager

public UserManager()
Initialization constructor.

Method Detail

loginAnonymously

public java.util.Map loginAnonymously(java.lang.String nickname,
                                      java.lang.String sessionID)
Logs in an anonymous user.

Parameters:
nickname - the nickname to user in the chat. Note: This may change depending on conflicting nicknames.
sessionID - the sessionID of the current session.
Returns:
a Map of errors, if any.

login

public java.util.Map login(java.lang.String username,
                           java.lang.String password,
                           java.lang.String nickname,
                           java.lang.String sessionID)
Login user needing authentication.

Parameters:
username - the username of the user.
password - the password of the user.
nickname - the nickname to use in the chat. Note: This may change depending on conflicting nicknames.
sessionID - the sessionID of the current session.
Returns:
a Map of errors, if any.

shouldCreateNewAnonymousSession

public boolean shouldCreateNewAnonymousSession(java.lang.String sessionID)
Returns true if a new connection and session should be created.

Parameters:
sessionID - the current sessionID
Returns:
true if a new session should be created, false if we can keep an existing connection.

shouldCreateNewAuthenticatedSession

public boolean shouldCreateNewAuthenticatedSession(java.lang.String sessionID)
Returns true if a new connection and session should be created.

Parameters:
sessionID - the current sessionID
Returns:
true if a new session should be created, false if we can keep an existing connection.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.