Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members

sosc::AuthTool Class Reference

Public Methods
	AuthTool () throws Exception
	AuthTool (DbTool db, String tableNamePrefix) throws Exception
void	setDbTool (DbTool db) throws Exception
void	setTableNamePrefix (String tableNamePrefix) throws Exception
String	getTableNamePrefix () throws Exception
void	sanityCheck () throws Exception
void	refreshSchema () throws Exception
String	userTable () throws Exception
String	groupTable () throws Exception
String	groupMemberTable () throws Exception
void	addUser (String userName, String password) throws Exception
void	addUser (String userName, String password, String email) throws Exception
void	setUserEmail (String userName, String email) throws Exception
void	setUserPassword (String userName, String password) throws Exception
void	changePassword (String userName, String newPassword) throws Exception
void	removeUser (String userName) throws Exception
Map	getUsers () throws Exception
Map	getGroups () throws Exception
Map	getGroupMembers (String groupName) throws Exception
void	addGroup (String groupName) throws Exception
void	removeGroup (String groupName) throws Exception
boolean	authenticate (String userName, String password) throws Exception
void	addGroupMember (String groupName, String userName) throws Exception
boolean	isGroupMember (String groupName, HttpServletRequest request) throws Exception
boolean	isGroupMember (String groupName, String userName) throws Exception
void	removeGroupMember (String groupName, String userName) throws Exception
String	getCurrentUser (HttpServletRequest request) throws Exception
String	getUserEmail (String userName) throws Exception
void	setCurrentUser (HttpServletResponse response, String userName)
void	setCurrentUser (HttpServletResponse response, String userName, String password) throws Exception
Private Methods
Map	getIdNames (String sql) throws Exception
Private Attributes
DbTool	db = null
String	tableNamePrefix = null

Constructor & Destructor Documentation

sosc::AuthTool::AuthTool ( ) throws Exception [inline]

Definition at line 42 of file AuthTool.java.

sosc::AuthTool::AuthTool ( DbTool db,

String tableNamePrefix

) throws Exception [inline]

Definition at line 48 of file AuthTool.java.
References sosc::AuthTool::setDbTool(), sosc::AuthTool::setTableNamePrefix(), and sosc::AuthTool::tableNamePrefix.

Member Function Documentation

void sosc::AuthTool::addGroup ( String groupName ) throws Exception [inline]

Definition at line 238 of file AuthTool.java.
References sosc::AuthTool::groupTable(), sosc::AuthTool::sanityCheck(), and sosc::DbTool::update().

void sosc::AuthTool::addGroupMember ( String groupName,

String userName

) throws Exception [inline]

Definition at line 277 of file AuthTool.java.
References sosc::AuthTool::groupMemberTable(), sosc::AuthTool::groupTable(), sosc::AuthTool::isGroupMember(), sosc::AuthTool::sanityCheck(), sosc::DbTool::update(), and sosc::AuthTool::userTable().

void sosc::AuthTool::addUser ( String userName,

String password,

String email

) throws Exception [inline]

Definition at line 142 of file AuthTool.java.
References sosc::AuthTool::addUser(), and sosc::AuthTool::setUserEmail().

void sosc::AuthTool::addUser ( String userName,

String password

) throws Exception [inline]

Definition at line 129 of file AuthTool.java.
References sosc::AuthTool::sanityCheck(), sosc::DbTool::update(), and sosc::AuthTool::userTable().
Referenced by sosc::AuthTool::addUser().

boolean sosc::AuthTool::authenticate ( String userName,

String password

) throws Exception [inline]

Definition at line 261 of file AuthTool.java.
References sosc::DbTool::query(), sosc::DbTool::quote(), sosc::AuthTool::sanityCheck(), and sosc::AuthTool::userTable().
Referenced by sosc::AuthTool::setCurrentUser().

void sosc::AuthTool::changePassword ( String userName,

String newPassword

) throws Exception [inline]

Definition at line 174 of file AuthTool.java.
References sosc::DbTool::quote(), sosc::AuthTool::sanityCheck(), sosc::DbTool::update(), and sosc::AuthTool::userTable().

String sosc::AuthTool::getCurrentUser ( HttpServletRequest request ) throws Exception [inline]

Definition at line 347 of file AuthTool.java.
Referenced by sosc::AuthTool::isGroupMember().

Map sosc::AuthTool::getGroupMembers ( String groupName ) throws Exception [inline]

Definition at line 220 of file AuthTool.java.
References sosc::AuthTool::getIdNames(), sosc::AuthTool::groupMemberTable(), sosc::AuthTool::groupTable(), sosc::DbTool::quote(), and sosc::AuthTool::userTable().

Map sosc::AuthTool::getGroups ( ) throws Exception [inline]

Definition at line 213 of file AuthTool.java.
References sosc::AuthTool::getIdNames(), and sosc::AuthTool::groupTable().

Map sosc::AuthTool::getIdNames ( String sql ) throws Exception [inline, private]

Definition at line 196 of file AuthTool.java.
References sosc::DbTool::query().
Referenced by sosc::AuthTool::getGroupMembers(), sosc::AuthTool::getGroups(), and sosc::AuthTool::getUsers().

String sosc::AuthTool::getTableNamePrefix ( ) throws Exception [inline]

Definition at line 70 of file AuthTool.java.
References sosc::AuthTool::tableNamePrefix.

String sosc::AuthTool::getUserEmail ( String userName ) throws Exception [inline]

Definition at line 366 of file AuthTool.java.
References sosc::DbTool::query(), sosc::DbTool::quote(), and sosc::AuthTool::userTable().

Map sosc::AuthTool::getUsers ( ) throws Exception [inline]

Definition at line 206 of file AuthTool.java.
References sosc::AuthTool::getIdNames(), and sosc::AuthTool::userTable().

String sosc::AuthTool::groupMemberTable ( ) throws Exception [inline]

Definition at line 118 of file AuthTool.java.
References sosc::AuthTool::tableNamePrefix.
Referenced by sosc::AuthTool::addGroupMember(), sosc::AuthTool::getGroupMembers(), sosc::AuthTool::isGroupMember(), sosc::AuthTool::refreshSchema(), sosc::AuthTool::removeGroup(), sosc::AuthTool::removeGroupMember(), and sosc::AuthTool::removeUser().

String sosc::AuthTool::groupTable ( ) throws Exception [inline]

Definition at line 111 of file AuthTool.java.
References sosc::AuthTool::tableNamePrefix.
Referenced by sosc::AuthTool::addGroup(), sosc::AuthTool::addGroupMember(), sosc::AuthTool::getGroupMembers(), sosc::AuthTool::getGroups(), sosc::AuthTool::isGroupMember(), sosc::AuthTool::refreshSchema(), sosc::AuthTool::removeGroup(), and sosc::AuthTool::removeGroupMember().

boolean sosc::AuthTool::isGroupMember ( String groupName,

String userName

) throws Exception [inline]

Definition at line 307 of file AuthTool.java.
References sosc::AuthTool::groupMemberTable(), sosc::AuthTool::groupTable(), sosc::DbTool::query(), sosc::AuthTool::sanityCheck(), and sosc::AuthTool::userTable().

boolean sosc::AuthTool::isGroupMember ( String groupName,

HttpServletRequest request

) throws Exception [inline]

Alias for isGroupMember(groupName, getCurrentUser(request));
Definition at line 300 of file AuthTool.java.
References sosc::AuthTool::getCurrentUser().
Referenced by sosc::AuthTool::addGroupMember().

void sosc::AuthTool::refreshSchema ( ) throws Exception [inline]

Definition at line 93 of file AuthTool.java.
References sosc::AuthTool::groupMemberTable(), sosc::AuthTool::groupTable(), sosc::DbTool::update(), and sosc::AuthTool::userTable().

void sosc::AuthTool::removeGroup ( String groupName ) throws Exception [inline]

Definition at line 249 of file AuthTool.java.
References sosc::AuthTool::groupMemberTable(), sosc::AuthTool::groupTable(), sosc::AuthTool::sanityCheck(), and sosc::DbTool::update().

void sosc::AuthTool::removeGroupMember ( String groupName,

String userName

) throws Exception [inline]

Definition at line 330 of file AuthTool.java.
References sosc::AuthTool::groupMemberTable(), sosc::AuthTool::groupTable(), sosc::AuthTool::sanityCheck(), sosc::DbTool::update(), and sosc::AuthTool::userTable().

void sosc::AuthTool::removeUser ( String userName ) throws Exception [inline]

Definition at line 184 of file AuthTool.java.
References sosc::AuthTool::groupMemberTable(), sosc::AuthTool::sanityCheck(), sosc::DbTool::update(), and sosc::AuthTool::userTable().

void sosc::AuthTool::sanityCheck ( ) throws Exception [inline]

Definition at line 77 of file AuthTool.java.
References sosc::AuthTool::tableNamePrefix.
Referenced by sosc::AuthTool::addGroup(), sosc::AuthTool::addGroupMember(), sosc::AuthTool::addUser(), sosc::AuthTool::authenticate(), sosc::AuthTool::changePassword(), sosc::AuthTool::isGroupMember(), sosc::AuthTool::removeGroup(), sosc::AuthTool::removeGroupMember(), sosc::AuthTool::removeUser(), and sosc::AuthTool::setCurrentUser().

void sosc::AuthTool::setCurrentUser ( HttpServletResponse response,

String userName,

String password

) throws Exception [inline]

Definition at line 383 of file AuthTool.java.
References sosc::AuthTool::authenticate(), sosc::AuthTool::sanityCheck(), and sosc::AuthTool::setCurrentUser().

void sosc::AuthTool::setCurrentUser ( HttpServletResponse response,

String userName

) [inline]

Definition at line 375 of file AuthTool.java.
Referenced by sosc::AuthTool::setCurrentUser().

void sosc::AuthTool::setDbTool ( DbTool db ) throws Exception [inline]

Definition at line 56 of file AuthTool.java.
Referenced by sosc::AuthTool::AuthTool().

void sosc::AuthTool::setTableNamePrefix ( String tableNamePrefix ) throws Exception [inline]

Definition at line 63 of file AuthTool.java.
References sosc::AuthTool::tableNamePrefix.
Referenced by sosc::AuthTool::AuthTool().

void sosc::AuthTool::setUserEmail ( String userName,

String email

) throws Exception [inline]

Definition at line 150 of file AuthTool.java.
References sosc::DbTool::quote(), sosc::DbTool::update(), and sosc::AuthTool::userTable().
Referenced by sosc::AuthTool::addUser().

void sosc::AuthTool::setUserPassword ( String userName,

String password

) throws Exception [inline]

Definition at line 162 of file AuthTool.java.
References sosc::DbTool::quote(), sosc::DbTool::update(), and sosc::AuthTool::userTable().

String sosc::AuthTool::userTable ( ) throws Exception [inline]

Definition at line 104 of file AuthTool.java.
References sosc::AuthTool::tableNamePrefix.
Referenced by sosc::AuthTool::addGroupMember(), sosc::AuthTool::addUser(), sosc::AuthTool::authenticate(), sosc::AuthTool::changePassword(), sosc::AuthTool::getGroupMembers(), sosc::AuthTool::getUserEmail(), sosc::AuthTool::getUsers(), sosc::AuthTool::isGroupMember(), sosc::AuthTool::refreshSchema(), sosc::AuthTool::removeGroupMember(), sosc::AuthTool::removeUser(), sosc::AuthTool::setUserEmail(), and sosc::AuthTool::setUserPassword().

Member Data Documentation

DbTool sosc::AuthTool::db = null [private]

Definition at line 36 of file AuthTool.java.

String sosc::AuthTool::tableNamePrefix = null [private]

Definition at line 37 of file AuthTool.java.
Referenced by sosc::AuthTool::AuthTool(), sosc::AuthTool::getTableNamePrefix(), sosc::AuthTool::groupMemberTable(), sosc::AuthTool::groupTable(), sosc::AuthTool::sanityCheck(), sosc::AuthTool::setTableNamePrefix(), and sosc::AuthTool::userTable().

The documentation for this class was generated from the following file:

AuthTool.java

Generated on Mon Jul 14 17:19:21 2003 for SOSC by

1.2.15

sosc::AuthTool Class Reference

Public Methods

Private Methods

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation