| java.lang.Object
 vqwiki.AbstractWikiMembers
vqwiki.file.FileWikiMembers
| FileWikiMembers | | public class FileWikiMembers extends AbstractWikiMembers (Code) | | Stores a list of usernames and their registered email addresses so
that users may set notifications and reminders per topic page. Users
must set a canonical username and provide a valid email address.
An email will then be sent to the supplied address with a hyperlink
containing a validation key. The key is then checked against the
list of registered names and confirmed, at which point the user
is allowed to set notifications and reminders. This is a file-based
implementation of the WikiMembers interface.
author:
Robert E Brewer
version:
0.1 |
| createMembershipWithoutRequest | | public synchronized boolean createMembershipWithoutRequest(String username, String email) throws WikiException(Code) | | Add a user account to the Members collection. It is assumed that the
confirmation was done somewhere else e.g. in the LDAP directory.
Parameters:
username - the name of the user for whom membership is requested
Parameters:
email - the email address of the user for whom membership is requestedin the confirmation email. For example, http://www.mybogusdomain.com/vqwiki/jsp/confirm.jsp
exception:
vqwiki.WikiException - if the mailer could not be instantiated |
| findMemberByName | | public WikiMember findMemberByName(String username)(Code) | | Finds a WikiMember object in the Member collection using the username.
Parameters:
username - the name of the user to find WikiMember the Member object for the specified user |
| removeMember | | public synchronized boolean removeMember(String username)(Code) | | Removes a WikiMember from the members list.
Parameters:
username - the name of the user to remove boolean true if the operation completed successfully, false if the member file could not be written |
| requestMembership | | public synchronized boolean requestMembership(String username, String email, HttpServletRequest request) throws WikiException(Code) | | Add a user account to the Members collection. A key will be generated and sent via
email to the specified address in a hyperlink, which the user can then visit
to confirm the membership request.
Parameters:
username - the name of the user for whom membership is requested
Parameters:
email - the email address of the user for whom membership is requestedin the confirmation email. For example, http://www.mybogusdomain.com/vqwiki/jsp/confirm.jsp boolean true if the user account has been added, false if an account already exists for this username or the member file could not be written
exception:
vqwiki.WikiException - if the mailer could not be instantiated |
|
|