org.ikasan.console.web.controller
Class WiretapEventsSearchFormController

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

@Controller
@RequestMapping(value="/events")
public class WiretapEventsSearchFormController
extends Object

This class is the Controller for the WiretapEvent Search Form

Author:

Ikasan Development Team

Constructor Summary

WiretapEventsSearchFormController(WiretapService wiretapService, ModuleService moduleService, PointToPointFlowProfileService pointToPointFlowProfileService)
Constructor

Method Summary

Set<Module>	getModules() Get the modules
Set<PointToPointFlowProfile>	getPointToPointFlowProfiles() Get the point to point flow profiles
String	initialiseWiretapEventSearch() Show the combined wiretap event search and search results view
String	listWiretapEvents(javax.servlet.http.HttpServletRequest request, Integer page, String orderBy, Boolean orderAsc, String pointToPointFlowProfileSearch, Boolean pointToPointFlowProfileSelectAll, Boolean moduleSelectAll, Integer pageSize, Set<Long> moduleIds, Set<Long> pointToPointFlowProfileIds, String moduleFlow, String componentName, String eventId, String payloadId, String fromDateString, String fromTimeString, String untilDateString, String untilTimeString, String payloadContent, org.springframework.ui.ModelMap model) Show the combined wiretap event search and search results view
void	outputFile(long wiretapEventId, javax.servlet.http.HttpServletResponse response) Download the payload content as a file TODO Improve Error handling?
org.springframework.web.servlet.ModelAndView	viewEvent(long wiretapEventId, String searchResultsUrl, org.springframework.ui.ModelMap modelMap) View a specified WiretapEvent
org.springframework.web.servlet.ModelAndView	viewModuleDesign(long moduleId, javax.servlet.http.HttpServletResponse response) Retrieve a link to a module design resource that can be displayed to the end user (or perhaps downloaded) TODO Improve Error handling?
org.springframework.web.servlet.ModelAndView	viewPrettyPayloadContent(long wiretapEventId, 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

@Autowired
public WiretapEventsSearchFormController(WiretapService wiretapService,
                                                   ModuleService moduleService,
                                                   PointToPointFlowProfileService pointToPointFlowProfileService)

Constructor

Parameters:

wiretapService - - The wiretap service to use

moduleService - - The module service to use

pointToPointFlowProfileService - - The point to point flow profile container to use

Method Detail

getModules

@ModelAttribute(value="modules")
public Set<Module> getModules()

Get the modules

Returns:

Set of modules

getPointToPointFlowProfiles

@ModelAttribute(value="pointToPointFlowProfiles")
public Set<PointToPointFlowProfile> getPointToPointFlowProfiles()

Get the point to point flow profiles

Returns:

List of point to point flow profiles

initialiseWiretapEventSearch

@RequestMapping(value="newSearch.htm")
public String initialiseWiretapEventSearch()

Show the combined wiretap event search and search results view

Returns:

wiretap events view

listWiretapEvents

@RequestMapping(value="list.htm")
public String listWiretapEvents(javax.servlet.http.HttpServletRequest request,
                                               @RequestParam(required=false)
                                               Integer page,
                                               @RequestParam(required=false)
                                               String orderBy,
                                               @RequestParam(required=false)
                                               Boolean orderAsc,
                                               @RequestParam(required=false)
                                               String pointToPointFlowProfileSearch,
                                               @RequestParam(required=false)
                                               Boolean pointToPointFlowProfileSelectAll,
                                               @RequestParam(required=false)
                                               Boolean moduleSelectAll,
                                               @RequestParam(required=false)
                                               Integer pageSize,
                                               @RequestParam(required=false)
                                               Set<Long> moduleIds,
                                               @RequestParam(required=false)
                                               Set<Long> pointToPointFlowProfileIds,
                                               @RequestParam(required=false)
                                               String moduleFlow,
                                               @RequestParam(required=false)
                                               String componentName,
                                               @RequestParam(required=false)
                                               String eventId,
                                               @RequestParam(required=false)
                                               String payloadId,
                                               @RequestParam(required=false)
                                               String fromDateString,
                                               @RequestParam(required=false)
                                               String fromTimeString,
                                               @RequestParam(required=false)
                                               String untilDateString,
                                               @RequestParam(required=false)
                                               String untilTimeString,
                                               @RequestParam(required=false)
                                               String payloadContent,
                                               org.springframework.ui.ModelMap model)

Show the combined wiretap event search and search results view

Parameters:

request - - Standard HttpRequest

page - - page index into the greater result set

orderBy - - The field to order by

orderAsc - - Ascending flag

pointToPointFlowProfileSearch - - Flag to indicate what type of search

pointToPointFlowProfileSelectAll - - Select all boolean for pointToPointFlowProfile based search

moduleSelectAll - - Select all boolean for module based search

pageSize - - Number of search results to display per page

moduleIds - - Set of ids of modules to include in search - must contain at least one id

pointToPointFlowProfileIds - - Set of ids of point to point flow profiles to include in search - must contain at least one pointToPointFlowProfileId

moduleFlow - - The internal Flow of the Module to search on

componentName - - The name of the component

eventId - - The Event Id

payloadId - - The Payload Id

fromDateString - - Include only events after fromDate

fromTimeString - - Include only events after fromDate

untilDateString - - Include only events before untilDate

untilTimeString - - Include only events before untilDate

payloadContent - - The Payload content

model - - The model (map)

Returns:

wiretap events view

viewEvent

@RequestMapping(value="viewEvent.htm")
public org.springframework.web.servlet.ModelAndView viewEvent(@RequestParam(value="wiretapEventId")
                                                                             long wiretapEventId,
                                                                             @RequestParam(required=false)
                                                                             String searchResultsUrl,
                                                                             org.springframework.ui.ModelMap modelMap)

View a specified WiretapEvent

Parameters:

wiretapEventId - The id of the wiretapped event to get

searchResultsUrl - The Search Results Page we came from

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="wiretapEventId")
                                                                                            long wiretapEventId,
                                                                                            javax.servlet.http.HttpServletResponse response)

View a specific payload content in a best guess native format

Parameters:

wiretapEventId - The id of the wiretap event to get

response - - Standard response stream

Returns:

null

viewModuleDesign

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

Retrieve a link to a module design resource that can be displayed to the end user (or perhaps downloaded) TODO Improve Error handling?

Parameters:

moduleId - - The id of the module to get the resource for

response - - The response stream to output the resource to

Returns:

null

outputFile

@RequestMapping(value="downloadPayloadContent.htm")
public void outputFile(@RequestParam(value="wiretapEventId")
                                      long wiretapEventId,
                                      javax.servlet.http.HttpServletResponse response)

Download the payload content as a file TODO Improve Error handling?

Parameters:

wiretapEventId - - The Event id of the wiretapped event to download

response - - The HttpServletResponse object, content is streamed to this