com.q2learning.webtier.webhuddle
Class WebHuddle

java.lang.Object
  com.q2learning.webtier.webhuddle.WebHuddle

public class WebHuddle
extends java.lang.Object

WebHuddle: API class to talk to Webhuddle server, specifically to:

• Create a user (a host aka moderator)
• Change a user's password.
• Create a meeting.
• Generate URLs to join a user to that meeting.

Simulates browser interaction with webhuddle pages in many cases, so the logic is heavily dependent on the layout, form field names, and wording of those pages.

11/20/2007 Charles Roth. First version.
12/01/2007 Charles Roth. Major revisions, removed database access & invite method.

Copyright (C) 2007 Q2learning LLC, www.q2learning.com. All rights reserved.

Constructor Summary

WebHuddle(java.lang.String serverUrl)

Method Summary

java.lang.String[]	createMeeting(java.lang.String meetingName, java.lang.String meetingPassword, java.lang.String moderator, java.lang.String moderatorPassword) Create a new meeting inside WebHuddle.
java.lang.String	createUser(java.lang.String fname, java.lang.String lname, java.lang.String email, java.lang.String country) Create a user inside WebHuddle.
java.lang.String	getJoinModeratorToMeetingUrl(java.lang.String meetingId, java.lang.String moderatorKey, java.lang.String moderatorEmailAddress, java.lang.String moderatorPassword) Get the URL to join the moderator to a meeting.
java.lang.String	getJoinUserToMeetingUrl(java.lang.String meetingId, java.lang.String meetingPassword, java.lang.String moderatorEmailAddress, java.lang.String userEmailAddress, java.lang.String userFullName) Get the URL to join a user to a meeting already in progress.
boolean	setUserPassword(java.lang.String email, java.lang.String oldPassword, java.lang.String newPassword) Change a webhuddle user's password.
protected java.lang.String	stripFirstLast(java.lang.String x)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebHuddle

public WebHuddle(java.lang.String serverUrl)

Parameters:

serverUrl - Base URL of WebHuddle server, including port number. Note that only "http" URLs work, for now (no https:).

Method Detail

createUser

public java.lang.String createUser(java.lang.String fname,
                                   java.lang.String lname,
                                   java.lang.String email,
                                   java.lang.String country)

Create a user inside WebHuddle. Generally only required for moderators(?).

Parameters:

fname - User's first name.

lname - User's last name.

email - User's email address (what WebHuddle considers the userid)

country - Two-letter country code, e.g. "US".

Returns:

Password of newly-created user, or empty if this user already exists.

setUserPassword

public boolean setUserPassword(java.lang.String email,
                               java.lang.String oldPassword,
                               java.lang.String newPassword)

Change a webhuddle user's password.

Parameters:

email - User's email address (what WebHuddle considers the userid)

oldPassword -

newPassword -

Returns:

true if password change succeeds.

createMeeting

public java.lang.String[] createMeeting(java.lang.String meetingName,
                                        java.lang.String meetingPassword,
                                        java.lang.String moderator,
                                        java.lang.String moderatorPassword)

Create a new meeting inside WebHuddle.

Parameters:

meetingName -

meetingPassword - A password for the meeting.

moderator - Email address of moderator

moderatorPassword -

Returns:

[0]=meeting id, [1]=moderator key. Empty, i.e. [0]="", means failure.

getJoinModeratorToMeetingUrl

public java.lang.String getJoinModeratorToMeetingUrl(java.lang.String meetingId,
                                                     java.lang.String moderatorKey,
                                                     java.lang.String moderatorEmailAddress,
                                                     java.lang.String moderatorPassword)

Get the URL to join the moderator to a meeting. The moderator most be the first person to join the meeting.

Parameters:

meetingId - As returned in [0] from createMeeting().

moderatorKey - As returned in [1] from createMeeting().

moderatorEmailAddress -

moderatorPassword -

Returns:

Full URL -- Point a browser to this URL to join the moderator to the meeting and launch the meeting applet.

getJoinUserToMeetingUrl

public java.lang.String getJoinUserToMeetingUrl(java.lang.String meetingId,
                                                java.lang.String meetingPassword,
                                                java.lang.String moderatorEmailAddress,
                                                java.lang.String userEmailAddress,
                                                java.lang.String userFullName)

Get the URL to join a user to a meeting already in progress. Note that no invitation is required, the parameters below are considered sufficient "proof" that this user is allowed to join the meeting.

Parameters:

meetingId - As returned in [0] from createMeeting().

meetingPassword - Same as supplied to createMeeting().

moderatorEmailAddress -

userEmailAddress - What webhuddle considers the userid

userFullName - This user's full name as it should appear in the meeting.

Returns:

Full URL -- Point a browser to this URL to join the user to the meeting and launch the meeting applet.

stripFirstLast

protected java.lang.String stripFirstLast(java.lang.String x)