org.ikasan.framework.web.controller
Class WiretapEventsSearchFormController

java.lang.Object
  org.ikasan.framework.web.controller.WiretapEventsSearchFormController

@Controller
@RequestMapping(value="/events/*.htm")
@SessionAttributes(value={"searchCriteria","pageNo"})
public class WiretapEventsSearchFormController
extends Object

This class is the Controller for the Wiretap search form

Author:

Ikasan Development Team

Constructor Summary

WiretapEventsSearchFormController(WiretapService wiretapService, ModuleService moduleService)
Constructor

Method Summary

List<Module>	getModuleNames() Get the module names
String	housekeepWiretaps() Handle the request to execute the housekeeper
String	next(javax.servlet.http.HttpServletRequest request, org.springframework.ui.ModelMap modelMap) Search for the next page of results
String	previous(javax.servlet.http.HttpServletRequest request, org.springframework.ui.ModelMap modelMap) Search for the previous page of results
String	processSubmit(org.springframework.ui.ModelMap modelMap, WiretapSearchCriteria searchCriteria, org.springframework.validation.BindingResult result) Handle submission of the search form
String	searchResults(javax.servlet.http.HttpServletRequest request, org.springframework.ui.ModelMap modelMap) Return to the search results page
String	setupForm(javax.servlet.http.HttpServletRequest request, org.springframework.ui.ModelMap model) Setup the search form
org.springframework.web.servlet.ModelAndView	viewEvent(long eventId, org.springframework.ui.ModelMap modelMap) View a specified WiretapEvent
org.springframework.web.servlet.ModelAndView	viewPrettyPayloadContent(long eventId, javax.servlet.http.HttpServletResponse response) View a specific payload content in a best guess native format

Methods inherited from class java.lang.Object

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

Constructor Detail

WiretapEventsSearchFormController

public WiretapEventsSearchFormController(WiretapService wiretapService,
                                         ModuleService moduleService)

Constructor

Parameters:

wiretapService - - The wiretap service to use

moduleService - - The module container to use

Method Detail

getModuleNames

@ModelAttribute(value="modules")
public List<Module> getModuleNames()

Get the module names

Returns:

List of module names

setupForm

@RequestMapping(value="search.htm",
                method=GET)
public String setupForm(javax.servlet.http.HttpServletRequest request,
                                       org.springframework.ui.ModelMap model)

Setup the search form

Parameters:

request - The standard HttpServletRequest

model - The model

Returns:

"events/wiretapEvents"

processSubmit

@RequestMapping(method=POST)
public String processSubmit(org.springframework.ui.ModelMap modelMap,
                                           @ModelAttribute(value="searchCriteria")
                                           WiretapSearchCriteria searchCriteria,
                                           org.springframework.validation.BindingResult result)

Handle submission of the search form

Parameters:

modelMap - The model

searchCriteria - The criteria to search on

result - The place holder for the result

Returns:

The model and its corresponding view (search results)

next

@RequestMapping(value="next.htm")
public String next(javax.servlet.http.HttpServletRequest request,
                                  org.springframework.ui.ModelMap modelMap)

Search for the next page of results

Parameters:

request - The standard HttpServletRequest

modelMap - The model

Returns:

The next page of search results (as a Model/View pairing)

searchResults

@RequestMapping(value="searchResults.htm")
public String searchResults(javax.servlet.http.HttpServletRequest request,
                                           org.springframework.ui.ModelMap modelMap)

Return to the search results page

Parameters:

request - The standard HttpServletRequest

modelMap - The model

Returns:

The next page of search results (as a Model/View pairing)

previous

@RequestMapping(value="previous.htm")
public String previous(javax.servlet.http.HttpServletRequest request,
                                      org.springframework.ui.ModelMap modelMap)

Search for the previous page of results

Parameters:

request - The standard HttpServletRequest

modelMap - The model

Returns:

The previous page of search results (as a Model/View pairing)

viewEvent

@RequestMapping(value="viewEvent.htm")
public org.springframework.web.servlet.ModelAndView viewEvent(@RequestParam(value="eventId")
                                                                             long eventId,
                                                                             org.springframework.ui.ModelMap modelMap)

View a specified WiretapEvent

Parameters:

eventId - The id of the event to get

modelMap - The model

Returns:

The model and view representing the wiretap event

viewPrettyPayloadContent

@RequestMapping(value="viewPrettyPayloadContent.htm")
public org.springframework.web.servlet.ModelAndView viewPrettyPayloadContent(@RequestParam(value="eventId")
                                                                                            long eventId,
                                                                                            javax.servlet.http.HttpServletResponse response)

View a specific payload content in a best guess native format

Parameters:

eventId - The id of the event to get

response - - Standard response stream

Returns:

null

housekeepWiretaps

@RequestMapping(value="housekeeping.htm",
                method=POST)
public String housekeepWiretaps()
                         throws Exception

Handle the request to execute the housekeeper

Returns:

a redirect to search form

Throws:

Exception - - Catch all