org.ikasan.console.web.controller

Class UsersController

java.lang.Object

org.ikasan.console.web.controller.UsersController

@Controller
@RequestMapping(value="/admin/users")
@SessionAttributes(value="user")
public class UsersController
extends Object

The controller for the various user views

Author:

Ikasan Development Team

Constructor Summary

Constructors

Constructor and Description
UsersController(UserService userService) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.web.servlet.ModelAndView	changeEmail(User user, org.springframework.ui.ModelMap model) Accepts submission of the changeEmail form
org.springframework.web.servlet.ModelAndView	changePassword(User user, String confirmNewPassword, org.springframework.ui.ModelMap model) Accepts submission of the changePassword form
org.springframework.web.servlet.ModelAndView	createUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Navigate to the create user page
org.springframework.web.servlet.ModelAndView	deleteUser(String username, org.springframework.ui.ModelMap model) Delete a existing user
org.springframework.web.servlet.ModelAndView	disableUser(String username, org.springframework.ui.ModelMap model) Disable an existing user
org.springframework.web.servlet.ModelAndView	enableUser(String username, org.springframework.ui.ModelMap model) Enable an existing user
org.springframework.web.servlet.ModelAndView	grantAuthority(String username, String authority, org.springframework.ui.ModelMap model) Grant a new authority to an existing user
org.springframework.web.servlet.ModelAndView	listUsers(org.springframework.ui.ModelMap model) List the users known to the system
org.springframework.web.servlet.ModelAndView	maintainUser(String username, org.springframework.ui.ModelMap model) Maintain a user known to the system
org.springframework.web.servlet.ModelAndView	revokeAuthority(String username, String authority, org.springframework.ui.ModelMap model) Revoke an authority from a existing user
org.springframework.web.servlet.ModelAndView	saveUser(org.springframework.ui.ModelMap model, String username, String password, String email, Boolean enabled) Accepts submission of the createUser form

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersController

@Autowired
public UsersController(UserService userService)

Constructor

Parameters:

userService - - The user service to use

Method Detail

listUsers

@RequestMapping(value="list.htm")
public org.springframework.web.servlet.ModelAndView listUsers(org.springframework.ui.ModelMap model)

List the users known to the system

Parameters:

model - - The model (map)

Returns:

"modules/modules"

createUser

@RequestMapping(value="createUser.htm",
                method=GET)
public org.springframework.web.servlet.ModelAndView createUser(javax.servlet.http.HttpServletRequest request,
                                                                     javax.servlet.http.HttpServletResponse response)

Navigate to the create user page

Parameters:

request - - Standard HTTP Request

response - - Standard HTTP Response

Returns:

- Model and View for createUser

saveUser

@RequestMapping(value="saveUser.htm",
                method=POST)
public org.springframework.web.servlet.ModelAndView saveUser(org.springframework.ui.ModelMap model,
                                                                   @RequestParam(required=false)
                                                                   String username,
                                                                   @RequestParam(required=false)
                                                                   String password,
                                                                   @RequestParam(required=false)
                                                                   String email,
                                                                   @RequestParam(required=false)
                                                                   Boolean enabled)

Accepts submission of the createUser form

Parameters:

model - - The model (map)

username - - The name of the user we're trying to create

password - - The password of the user we're trying to create

email - - The email address of the user we're trying to create

enabled - - Whether or not the user starts off as enabled in the system

Returns:

view the user

maintainUser

@RequestMapping(value="maintainUser.htm",
                method=GET)
public org.springframework.web.servlet.ModelAndView maintainUser(@RequestParam(value="username")
                                                                       String username,
                                                                       org.springframework.ui.ModelMap model)

Maintain a user known to the system

Parameters:

username - - The name of the user we're trying to view

model - - The model (map)

Returns:

path to user view

changePassword

@RequestMapping(value="changePassword.htm",
                method=POST)
public org.springframework.web.servlet.ModelAndView changePassword(@ModelAttribute(value="user")
                                                                         User user,
                                                                         @RequestParam(value="confirm_password")
                                                                         String confirmNewPassword,
                                                                         org.springframework.ui.ModelMap model)

Accepts submission of the changePassword form

Parameters:

user - - The user we're changing the password for

confirmNewPassword - - The password again, for confirmation

model - - The model (map)

Returns:

view the user

changeEmail

@RequestMapping(value="changeEmail.htm",
                method=POST)
public org.springframework.web.servlet.ModelAndView changeEmail(@ModelAttribute(value="user")
                                                                      User user,
                                                                      org.springframework.ui.ModelMap model)

Accepts submission of the changeEmail form

Parameters:

user - - The user we're changing the email for

model - - The model (map)

Returns:

view the user

grantAuthority

@RequestMapping(value="grantAuthority.htm",
                method=POST)
public org.springframework.web.servlet.ModelAndView grantAuthority(@RequestParam(value="username")
                                                                         String username,
                                                                         @RequestParam(value="authority")
                                                                         String authority,
                                                                         org.springframework.ui.ModelMap model)

Grant a new authority to an existing user

Parameters:

username - - The name of the user we're granting authority to

authority - - The authority we're granting the user

model - - The model (map)

Returns:

to the view users

revokeAuthority

@RequestMapping(value="revokeAuthority.htm",
                method=POST)
public org.springframework.web.servlet.ModelAndView revokeAuthority(@RequestParam(value="username")
                                                                          String username,
                                                                          @RequestParam(value="authority")
                                                                          String authority,
                                                                          org.springframework.ui.ModelMap model)

Revoke an authority from a existing user

Parameters:

username - - The name of the user we're revoking authority from

authority - - The authority we're revoking from the user

model - - The model (map)

Returns:

to the view users

deleteUser

@RequestMapping(value="delete.htm",
                method=POST)
public org.springframework.web.servlet.ModelAndView deleteUser(@RequestParam(value="username")
                                                                     String username,
                                                                     org.springframework.ui.ModelMap model)

Delete a existing user

Parameters:

username - - The name of the user we're deleting

model - - The model (map)

Returns:

to the view users

disableUser

@RequestMapping(value="disable.htm",
                method=POST)
public org.springframework.web.servlet.ModelAndView disableUser(@RequestParam(value="username")
                                                                      String username,
                                                                      org.springframework.ui.ModelMap model)

Disable an existing user

Parameters:

username - - The name of the user we're disabling

model - - The model (map)

Returns:

to the view users

enableUser

@RequestMapping(value="enable.htm",
                method=POST)
public org.springframework.web.servlet.ModelAndView enableUser(@RequestParam(value="username")
                                                                     String username,
                                                                     org.springframework.ui.ModelMap model)

Enable an existing user

Parameters:

username - - The name of the user we're enabling

model - - The model (map)

Returns:

to the view users