com.mizar.credentials
Interface UserManagement


Deprecated.

@Deprecated
public interface UserManagement


Method Summary
 User addUser(java.lang.String username, java.lang.String password, java.lang.String emailAddress, java.lang.String projectName, java.lang.String initialRoleList)
          Deprecated.  
 void changePassword(java.lang.String userName, java.lang.String oldPassword, java.lang.String newPassword, java.lang.String newPassword2)
          Deprecated. Changes the given userRow's password
 void changePassword(User callingUser, java.lang.String userName, java.lang.String newPassword, java.lang.String newPassword2)
          Deprecated. An administrator level function to allow them to set a userRow's password Throws an AccessException if called by anyone other than the Admin
 User createAnonymousUser()
          Deprecated. Creates a userRow with a generated username and ID.
 Group createGroup(java.lang.String groupName)
          Deprecated. Assigns a role to a group.
 Permission createPermission(java.lang.String permissionName)
          Deprecated. Create a new permission
 Role createRole(java.lang.String roleName)
          Deprecated. Creates a new role
 User createUser(java.lang.String username, java.lang.String password, java.lang.String emailAddress, java.lang.String initialRoleList)
          Deprecated. Creates a userRow with the given username, assigns them the email address and sends out a confirmation email.
 UserPropertiesName createUserProperty(java.lang.String propertyName)
          Deprecated. Creates a userRow property
 void createUserWithPermission(java.lang.String username, java.lang.String email, java.util.Map<java.lang.String,java.lang.String> properties)
          Deprecated. Sends an email to ask for permission to create the userRow.
 void deleteGroup(java.lang.String groupName)
          Deprecated.  
 void deletePermission(java.lang.String permissionName)
          Deprecated. Deletes a permission from the database
 void deleteRole(java.lang.String roleName)
          Deprecated. Deletes a role from the Database
 void deleteUser(java.lang.String username)
          Deprecated. Erases a userRow from the database
 User getUserBean(java.lang.String userName)
          Deprecated. Gets the userbean based on the username
 void resetPassword(java.lang.String username, java.lang.String email)
          Deprecated. Resets the userRow's password and emails it out to them
 User updateUser(User changedBean)
          Deprecated. Updates the userRow record in the database.
 void updateViewSetting(User callingUser, java.lang.String projectName, org.jdom.Element root)
          Deprecated. Updates the userRow's saved preferences.
 

Method Detail

addUser

User addUser(java.lang.String username,
             java.lang.String password,
             java.lang.String emailAddress,
             java.lang.String projectName,
             java.lang.String initialRoleList)
             throws UserExistsException,
                    AccessException,
                    java.lang.Exception
Deprecated. 
Throws:
UserExistsException
AccessException
java.lang.Exception

createUser

User createUser(java.lang.String username,
                java.lang.String password,
                java.lang.String emailAddress,
                java.lang.String initialRoleList)
                throws UserExistsException,
                       java.lang.Exception
Deprecated. 
Creates a userRow with the given username, assigns them the email address and sends out a confirmation email. The email will have a randomly generated password, which they may use to log-in. An exception is thrown in 2 instances 1) Invalid email - InvalidEmailException 2) Username is already in - UserExistsException

Parameters:
username -
emailAddress -
Returns:
Throws:
UserExistsException
java.lang.Exception

createAnonymousUser

User createAnonymousUser()
                         throws java.lang.Exception
Deprecated. 
Creates a userRow with a generated username and ID. The password is set to null and so the userRow cannot log in.

Returns:
a userRow with no username
Throws:
java.lang.Exception

createUserWithPermission

void createUserWithPermission(java.lang.String username,
                              java.lang.String email,
                              java.util.Map<java.lang.String,java.lang.String> properties)
                              throws UserExistsException,
                                     AccessException
Deprecated. 
Sends an email to ask for permission to create the userRow.

Parameters:
username -
email -
properties -
Throws:
UserExistsException
AccessException

deleteUser

void deleteUser(java.lang.String username)
                throws AccessException
Deprecated. 
Erases a userRow from the database

Parameters:
username - - the username to be deleted.
Throws:
AccessException

getUserBean

User getUserBean(java.lang.String userName)
                 throws AccessException
Deprecated. 
Gets the userbean based on the username

Parameters:
userName -
Returns:
Throws:
AccessException

changePassword

void changePassword(User callingUser,
                    java.lang.String userName,
                    java.lang.String newPassword,
                    java.lang.String newPassword2)
                    throws AccessException
Deprecated. 
An administrator level function to allow them to set a userRow's password Throws an AccessException if called by anyone other than the Admin

Parameters:
userName -
newPassword -
newPassword2 -
Throws:
AccessException

changePassword

void changePassword(java.lang.String userName,
                    java.lang.String oldPassword,
                    java.lang.String newPassword,
                    java.lang.String newPassword2)
                    throws AccessException
Deprecated. 
Changes the given userRow's password

Parameters:
userName - The username
oldPassword - The userRow's current password
newPassword - The userRow's new password
newPassword2 - The userRow's new password, must match newPassword
Throws:
AccessException

resetPassword

void resetPassword(java.lang.String username,
                   java.lang.String email)
                   throws AccessException
Deprecated. 
Resets the userRow's password and emails it out to them

Parameters:
username - Username must exist in the database
email - Email must be the same as the email currently associated with the userRow
Throws:
AccessException - Thrown if the password could not be reset or email sent. If the email server cannot be contacted, the password reset will fail

updateUser

User updateUser(User changedBean)
                throws java.lang.Exception
Deprecated. 
Updates the userRow record in the database. Permission is controlled by the parameter callingUser

Parameters:
changedBean -
Throws:
java.lang.Exception

updateViewSetting

void updateViewSetting(User callingUser,
                       java.lang.String projectName,
                       org.jdom.Element root)
                       throws AccessException
Deprecated. 
Updates the userRow's saved preferences.

Parameters:
projectName - The project for which the settingsClob are to be updated
root - The updated JDOM Element which will be inserted into the XML tree
Throws:
AccessException

createGroup

Group createGroup(java.lang.String groupName)
                  throws AccessException,
                         AlreadyExistsException,
                         java.lang.Exception
Deprecated. 
Assigns a role to a group.

Parameters:
groupName -
Returns:
true if role was assigned, false if it was already assigned
Throws:
AccessException
AlreadyExistsException
java.lang.Exception

deleteGroup

void deleteGroup(java.lang.String groupName)
                 throws AccessException
Deprecated. 
Throws:
AccessException

createRole

Role createRole(java.lang.String roleName)
                throws AccessException,
                       AlreadyExistsException,
                       java.lang.Exception
Deprecated. 
Creates a new role

Parameters:
roleName - The name of the new role
Throws:
AccessException - Exception is thrown if the calling userRow does not have sufficient permission to create a new role
AlreadyExistsException - Exception is thrown if the role already exists
java.lang.Exception

deleteRole

void deleteRole(java.lang.String roleName)
                throws AccessException
Deprecated. 
Deletes a role from the Database

Parameters:
roleName - The name of the role to delete
Throws:
AccessException - Exception is thrown if the calling userRow does not have sufficient permission to delete the role

createPermission

Permission createPermission(java.lang.String permissionName)
                            throws AccessException,
                                   AlreadyExistsException,
                                   java.lang.Exception
Deprecated. 
Create a new permission

Parameters:
permissionName - The name of the new permission
Throws:
AccessException - thrown if the calling userRow does not have sufficient permission to create a new permission
AlreadyExistsException - Thrown if the permission already exists
java.lang.Exception

deletePermission

void deletePermission(java.lang.String permissionName)
                      throws AccessException
Deprecated. 
Deletes a permission from the database

Parameters:
permissionName - Name of the permission to delete
Throws:
AccessException - Thrown if the calling userRow does not have sufficient permission to delete permissions

createUserProperty

UserPropertiesName createUserProperty(java.lang.String propertyName)
                                      throws AlreadyExistsException,
                                             java.lang.Exception
Deprecated. 
Creates a userRow property

Parameters:
propertyName - Name of the property to create
Throws:
AlreadyExistsException - - Exception is thrown if the property already exists
java.lang.Exception