edu.ucar.unidata.wmotables.controller

Class TableController

java.lang.Object

edu.ucar.unidata.wmotables.controller.TableController

All Implemented Interfaces:

org.springframework.web.servlet.HandlerExceptionResolver

@Controller
public class TableController
extends Object
implements org.springframework.web.servlet.HandlerExceptionResolver

Controller to handle and modify a WMO table.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
TableController()

Method Summary

Methods

Modifier and Type	Method and Description
String	createTable(String userName, org.springframework.ui.Model model) Accepts a GET request to create a new Table object.
org.springframework.web.servlet.ModelAndView	createTable(Table table, org.springframework.validation.BindingResult result, org.springframework.ui.Model model) Accepts a POST request to create a new Table object and persist it.
void	downloadTable(String checksum, javax.servlet.http.HttpServletResponse response) Accepts a GET request to download a specific Table.
String	getAuthName() Returns the authenticated user name.
List<String>	getTableTypes() Grabs the tableTypeString and returns as a List.
org.springframework.web.servlet.ModelAndView	hideTable(Table table, org.springframework.validation.BindingResult result, org.springframework.ui.Model model) Accepts a POST request to hide a new Table object.
void	initBinder(org.springframework.web.bind.WebDataBinder binder)
boolean	isAuthorized(String userName) Checks the authenticated user's credentials and roles to determine if the user has permission to perform the required method action.
String	listAllTables(org.springframework.ui.Model model) Accepts a GET request for a List of all Table objects.
org.springframework.web.servlet.ModelAndView	resolveException(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler, Exception exception) This method gracefully handles any uncaught exception that are fatal in nature and unresolvable by the user.
void	setAuthName(String authName) Sets the authenticated user name.
String	updateTable(String checksum, org.springframework.ui.Model model) Accepts a GET request to update an existing Table object.
org.springframework.web.servlet.ModelAndView	updateTable(Table table, org.springframework.validation.BindingResult result, org.springframework.ui.Model model) Accepts a POST request to update an existing Table object.
String	viewTable(String checksum, org.springframework.ui.Model model) Accepts a GET request for a specific Table object.
void	viewTableFile(String checksum, javax.servlet.http.HttpServletResponse response) Accepts a GET request to view a specific Table.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static org.apache.log4j.Logger logger

Constructor Detail

TableController

public TableController()

Method Detail

initBinder

@InitBinder(value="table")
public void initBinder(org.springframework.web.bind.WebDataBinder binder)

listAllTables

@RequestMapping(value="/table",
                method=GET)
public String listAllTables(org.springframework.ui.Model model)

Accepts a GET request for a List of all Table objects. View is a list of all Tables in the database. The view can handle an empty list of Tables if no Table objects have been persisted in the database yet.

Parameters:

model - The Model used by the View.

Returns:

The path for the ViewResolver.

viewTable

@RequestMapping(value="/table/{checksum}",
                method=GET)
public String viewTable(@PathVariable
                              String checksum,
                              org.springframework.ui.Model model)

Accepts a GET request for a specific Table object. View is the requested Table object, or a list of all Table objects if unable to find the requested Table in the database.

Parameters:

checksum - The 'checksum' as provided by @PathVariable.

model - The Model used by the View.

Returns:

The path for the ViewResolver.

viewTableFile

@RequestMapping(value="/table/view/{checksum}",
                method=GET)
public void viewTableFile(@PathVariable
                                String checksum,
                                javax.servlet.http.HttpServletResponse response)

Accepts a GET request to view a specific Table. No view is produced. The file is streamed to the client for viewing.

Parameters:

checksum - The 'checksum' as provided by @PathVariable.

response - The HttpServletResponse response.

downloadTable

@RequestMapping(value="/table/download/{checksum}",
                method=GET)
public void downloadTable(@PathVariable
                                String checksum,
                                javax.servlet.http.HttpServletResponse response)

Accepts a GET request to download a specific Table. No view is produced. The file is streamed to the client for download.

Parameters:

checksum - The 'checksum' as provided by @PathVariable.

response - The HttpServletResponse response.

createTable

@PreAuthorize(value="hasRole(\'ROLE_ADMIN\') or #userName == authentication.name")
@RequestMapping(value="/table/create/{userName}",
                method=GET)
public String createTable(@PathVariable
                                             String userName,
                                             org.springframework.ui.Model model)

Accepts a GET request to create a new Table object. View is a web form to upload a new Table. Only the User/owner and Users with a role of 'ROLE_ADMIN' are allowed to create Tables for the user account.

Parameters:

userName - The 'userName' as provided by @PathVariable.

model - The Model used by the View.

Returns:

The path for the ViewResolver.

createTable

@RequestMapping(value="/table/create",
                method=POST)
public org.springframework.web.servlet.ModelAndView createTable(Table table,
                                                                      org.springframework.validation.BindingResult result,
                                                                      org.springframework.ui.Model model)
                                                         throws IOException,
                                                                org.springframework.security.access.AccessDeniedException

Accepts a POST request to create a new Table object and persist it. View is either the newly created Table object or the web form to create a new Table if: 1) a Table of the same checksum has already exists in the database, 2) or if there are validation errors with the user input. Only the User/owner and Users with a role of 'ROLE_ADMIN' are allowed to create new Table objects.

Parameters:

table - The Table to persist.

result - The BindingResult for error handling.

model - The Model used by the View.

Returns:

The redirect to the needed View.

Throws:

IOException - If an IO error occurs when writing the table to the file system.

org.springframework.security.access.AccessDeniedException

updateTable

@RequestMapping(value="/table/update/{checksum}",
                method=GET)
public String updateTable(@PathVariable
                                String checksum,
                                org.springframework.ui.Model model)
                   throws org.springframework.security.access.AccessDeniedException

Accepts a GET request to update an existing Table object. View is a web form to update an existing Table. Only the User/owner and Users with a role of 'ROLE_ADMIN' are allowed to update Table objects.

Parameters:

checksum - The checksum as provided by @PathVariable.

model - The Model used by the View.

Returns:

The path for the ViewResolver.

Throws:

org.springframework.security.access.AccessDeniedException

updateTable

@RequestMapping(value="/table/update",
                method=POST)
public org.springframework.web.servlet.ModelAndView updateTable(Table table,
                                                                      org.springframework.validation.BindingResult result,
                                                                      org.springframework.ui.Model model)
                                                         throws org.springframework.security.access.AccessDeniedException

Accepts a POST request to update an existing Table object. View is the updated Table object, or the web form to update the Table if: 1) unable to locate the Table in the database, 2) or if there are validation errors with the user input. Only the User/owner and Users with a role of 'ROLE_ADMIN' are allowed to update Table objects.

Parameters:

table - The Table to update.

result - The BindingResult for error handling.

model - The Model used by the View.

Returns:

The redirect to the needed View.

Throws:

org.springframework.security.access.AccessDeniedException

hideTable

@RequestMapping(value="/table/hide",
                method=POST)
public org.springframework.web.servlet.ModelAndView hideTable(Table table,
                                                                    org.springframework.validation.BindingResult result,
                                                                    org.springframework.ui.Model model)
                                                       throws org.springframework.security.access.AccessDeniedException

Accepts a POST request to hide a new Table object. View is the hidden Table object in "hidden" view mode. Only the User/owner and Users with a role of 'ROLE_ADMIN' are allowed to hide tables for the user account.

Parameters:

table - The Table to hide.

result - The BindingResult for error handling.

model - The Model used by the View.

Returns:

The redirect to the needed View.

Throws:

org.springframework.security.access.AccessDeniedException

resolveException

public org.springframework.web.servlet.ModelAndView resolveException(javax.servlet.http.HttpServletRequest request,
                                                            javax.servlet.http.HttpServletResponse response,
                                                            Object handler,
                                                            Exception exception)

This method gracefully handles any uncaught exception that are fatal in nature and unresolvable by the user.

Specified by:

resolveException in interface org.springframework.web.servlet.HandlerExceptionResolver

Parameters:

request - The current HttpServletRequest request.

response - The current HttpServletRequest response.

handler - The executed handler, or null if none chosen at the time of the exception.

exception - The exception that got thrown during handler execution.

Returns:

The error page containing the appropriate message to the user.

isAuthorized

public boolean isAuthorized(String userName)

Checks the authenticated user's credentials and roles to determine if the user has permission to perform the required method action. Returns true if authorized.

Parameters:

userName - The user name we will evaluate the logged in user against.

Returns:

The boolean determining if the user is authorized to perform the method action.

getAuthName

public String getAuthName()

Returns the authenticated user name.

Returns:

The authenticated user name.

setAuthName

public void setAuthName(String authName)

Sets the authenticated user name.

Parameters:

authName - The authenticated user name.

getTableTypes

public List<String> getTableTypes()

Grabs the tableTypeString and returns as a List.

Returns:

The list fo table types for display.