| org.jamwiki.UserHandler
All known Subclasses: org.jamwiki.db.DatabaseUserHandler, org.jamwiki.TestUserHandler, org.jamwiki.ldap.LdapUserHandler,
| Method Summary | |
| void | addWikiUserInfo(WikiUserInfo userInfo, Object transactionObject)
Add new user information to the user information data store. | | boolean | authenticate(String username, String password)
Determine if a value matching the given username and password exists in
the data store.
Parameters:
username - The username that is being validated against.
Parameters:
password - The password that is being validated against. | | boolean | isWriteable()
This method returns true if the user information data
store is writeable, and false if it is read-only. | | WikiUserInfo | lookupWikiUserInfo(String username)
Given a username, retrieving a WikiUserInfo containing values for
the specified user.
Parameters:
username - The username for the user information being retrieved. | | void | updateWikiUserInfo(WikiUserInfo userInfo, Object transactionObject)
Parameters:
userInfo - The WikiUserInfo object that is to be updated in thedata store.
Parameters:
transactionObject - If the user information is being updated inthe data store as part of a transaction then this parameter shouldcontain the transaction object, such as a database connection. |
| addWikiUserInfo | | void addWikiUserInfo(WikiUserInfo userInfo, Object transactionObject) throws Exception(Code) | | Add new user information to the user information data store. If the
data store is write-only then this method should throw an
OperationNotSupportedException.
Parameters:
userInfo - The WikiUserInfo object that is to be added to thedata store.
Parameters:
transactionObject - If the user information is being added to thedata store as part of a transaction then this parameter should containthe transaction object, such as a database connection. If notransaction is being used then this value should be null.
throws:
Exception - Thrown if an error occurs while adding the userinformation, or if the data store is read-only. |
| authenticate | | boolean authenticate(String username, String password) throws Exception(Code) | | Determine if a value matching the given username and password exists in
the data store.
Parameters:
username - The username that is being validated against.
Parameters:
password - The password that is being validated against. true if the username / password combination matchesan existing record in the data store, false otherwise.
throws:
Exception - Thrown if an error occurs while accessing the datastore. |
| isWriteable | | boolean isWriteable()(Code) | | This method returns true if the user information data
store is writeable, and false if it is read-only.
true if the user information data store iswriteable, and false if it is read-only. |
| lookupWikiUserInfo | | WikiUserInfo lookupWikiUserInfo(String username) throws Exception(Code) | | Given a username, retrieving a WikiUserInfo containing values for
the specified user.
Parameters:
username - The username for the user information being retrieved. A WikiUserInfo object containing user information matching thethe username, or null if no record matching the usernamecan be found.
throws:
Exception - Thrown if an error occurs while retrieving userinformation. |
| updateWikiUserInfo | | void updateWikiUserInfo(WikiUserInfo userInfo, Object transactionObject) throws Exception(Code) | |
Parameters:
userInfo - The WikiUserInfo object that is to be updated in thedata store.
Parameters:
transactionObject - If the user information is being updated inthe data store as part of a transaction then this parameter shouldcontain the transaction object, such as a database connection. If notransaction is being used then this value should be null.
throws:
Exception - Thrown if an error occurs while updating the userinformation, or if the data store is read-only. |
|
|