Package uk.ac.manchester.spinnaker.alloc.web

Class SystemControllerImpl

java.lang.Object

uk.ac.manchester.spinnaker.alloc.web.SystemControllerImpl

All Implemented Interfaces:

SystemController

@Controller("mvc.mainUI")
public class SystemControllerImpl
extends Object
implements SystemController

The main web interface controller.

Author:

Donal Fellows

Field Summary

Fields inherited from interface uk.ac.manchester.spinnaker.alloc.web.SystemController

ROOT_PATH, USER_MAY_CHANGE_PASSWORD, USER_PASSWORD_CHANGE_ATTR

Constructor Summary

Constructors

Constructor	Description
SystemControllerImpl()

Method Summary

Modifier and Type	Method	Description
ModelAndView	destroyJob(int id, String reason)	Delete a job.
ModelAndView	getJobInfo(int id)	Get the view for some job details.
ModelAndView	getJobList()	Get the view for the general job list.
ModelAndView	getMachineInfo(String machine)	Get the view for some machine details.
ModelAndView	getMachineList()	Get the view for the general machine list.
ModelAndView	getPasswordChangeForm(Principal principal)	Get the view and model for the password change form.
ModelAndView	index()	Get the view for the main page of the service.
List<Process>	listProcesses(int id, int x, int y)	Get job processes on a chip.
ModelAndView	login()	Get the login form page.
String	performLogout(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Log the user out.
ModelAndView	postPasswordChangeForm(PasswordChangeRecord user, Principal principal)	Carry out a password change.
ModelAndView	powerJob(int id, boolean power)	Set the power of a job.

Methods inherited from class java.lang.Object

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

Constructor Details

SystemControllerImpl

public SystemControllerImpl()

Method Details

index

@GetMapping("/")
public ModelAndView index()

Description copied from interface: SystemController

Get the view for the main page of the service.

Specified by:

index in interface SystemController

Returns:

View (index.jsp)

login

@GetMapping("/login.html")
public ModelAndView login()

Description copied from interface: SystemController

Get the login form page. Note that this must be a resource that can be accessed without authentication; it is part of the auth flow!

Specified by:

login in interface SystemController

Returns:

View (login.jsp)

getPasswordChangeForm

@GetMapping("/change_password")
public ModelAndView getPasswordChangeForm(Principal principal)

Description copied from interface: SystemController

Get the view and model for the password change form.

Specified by:

getPasswordChangeForm in interface SystemController

Parameters:

principal - Who is changing their password.

Returns:

View (password.jsp) and model (based on PasswordChangeRecord)

postPasswordChangeForm

public ModelAndView postPasswordChangeForm(PasswordChangeRecord user,
 Principal principal)

Description copied from interface: SystemController

Carry out a password change.

Specified by:

postPasswordChangeForm in interface SystemController

Parameters:

user - The description of what to change.

principal - Who is changing their password.

Returns:

View (password.jsp) and model (based on PasswordChangeRecord)

performLogout

public String performLogout(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Description copied from interface: SystemController

Log the user out.

Specified by:

performLogout in interface SystemController

Parameters:

request - What request was made

response - What response to build

Returns:

Redirect to the login page

See Also:

• LogoutHandler

getMachineList

@PreAuthorize("hasRole(\'READER\')")
public ModelAndView getMachineList()

Description copied from interface: SystemController

Get the view for the general machine list.

Specified by:

getMachineList in interface SystemController

Returns:

View (listmachines.jsp) and model (based on MachineListEntryRecord)

getMachineInfo

@PreAuthorize("hasRole(\'READER\')")
public ModelAndView getMachineInfo(String machine)

Description copied from interface: SystemController

Get the view for some machine details.

Specified by:

getMachineInfo in interface SystemController

Parameters:

machine - Which machine is being asked for

Returns:

View (machinedetails.jsp) and model (based on MachineDescription)

getJobList

@PreAuthorize("hasRole(\'READER\')")
public ModelAndView getJobList()

Description copied from interface: SystemController

Get the view for the general job list.

Specified by:

getJobList in interface SystemController

Returns:

View (listjobs.jsp) and model (based on JobListEntryRecord)

getJobInfo

@PreAuthorize("hasRole(\'READER\')")
public ModelAndView getJobInfo(int id)

Description copied from interface: SystemController

Get the view for some job details.

Specified by:

getJobInfo in interface SystemController

Parameters:

id - Which job is being asked for

Returns:

View (jobdetails.jsp) and model (based on JobDescription)

destroyJob

@PreAuthorize("hasRole(\'READER\')")
public ModelAndView destroyJob(int id,
 String reason)

Description copied from interface: SystemController

Delete a job.

Specified by:

destroyJob in interface SystemController

Parameters:

id - Which job is being deleted

reason - Why the job is being deleted

Returns:

View (jobdetails.jsp) and model (based on JobDescription)

powerJob

@PreAuthorize("hasRole(\'READER\')")
public ModelAndView powerJob(int id,
 boolean power)

Description copied from interface: SystemController

Set the power of a job.

Specified by:

powerJob in interface SystemController

Parameters:

id - Which job is being deleted

power - Whether to power on or off

Returns:

View (jobdetails.jsp) and model (based on JobDescription)

listProcesses

@PreAuthorize("hasRole(\'READER\')")
public List<Process> listProcesses(int id,
 int x,
 int y)

Description copied from interface: SystemController

Get job processes on a chip.

Specified by:

listProcesses in interface SystemController

Parameters:

id - Which job is being asked for

x - The x coordinate of the chip

y - The y coordinate of the chip

Returns:

List of Processes. Note all cores are returned though there may be no process on some of them and some may be dead cores.