Class PrintingResultHandler

java.lang.Object

org.springframework.test.web.servlet.result.PrintingResultHandler

All Implemented Interfaces:

ResultHandler

public class PrintingResultHandler
extends Object
implements ResultHandler

Result handler that prints MvcResult details to a given output stream — for example: System.out, System.err, a custom java.io.PrintWriter, etc.

An instance of this class is typically accessed via one of the print or log methods in MockMvcResultHandlers.

Since:

3.2

Author:

Rossen Stoyanchev, Sam Brannen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	PrintingResultHandler.ResultValuePrinter	A contract for how to actually write result information.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrintingResultHandler(PrintingResultHandler.ResultValuePrinter printer)	Protected constructor.

Method Summary

Modifier and Type	Method	Description
protected final MultiValueMap<String,String>	getParamsMultiValueMap(MockHttpServletRequest request)
protected PrintingResultHandler.ResultValuePrinter	getPrinter()	Return the result value printer.
protected final HttpHeaders	getRequestHeaders(MockHttpServletRequest request)
protected final HttpHeaders	getResponseHeaders(MockHttpServletResponse response)
protected final Map<String,Object>	getSessionAttributes(MockHttpServletRequest request)
final void	handle(MvcResult result)	Print MvcResult details.
protected void	printAsyncResult(MvcResult result)
protected void	printFlashMap(FlashMap flashMap)	Print "output" flash attributes.
protected void	printHandler(@Nullable Object handler, HandlerInterceptor @Nullable [] interceptors)	Print the handler.
protected void	printModelAndView(@Nullable ModelAndView mav)	Print the ModelAndView.
protected void	printRequest(MockHttpServletRequest request)	Print the request.
protected void	printResolvedException(@Nullable Exception resolvedException)	Print exceptions resolved through a HandlerExceptionResolver.
protected void	printResponse(MockHttpServletResponse response)	Print the response.

Methods inherited from class java.lang.Object

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

Constructor Details

PrintingResultHandler

protected PrintingResultHandler(PrintingResultHandler.ResultValuePrinter printer)

Protected constructor.

Parameters:

printer - a PrintingResultHandler.ResultValuePrinter to do the actual writing

Method Details

getPrinter

protected PrintingResultHandler.ResultValuePrinter getPrinter()

Return the result value printer.

Returns:

the printer

handle

public final void handle(MvcResult result)
                  throws Exception

Print MvcResult details.

Specified by:

handle in interface ResultHandler

Parameters:

result - the result of the executed request

Throws:

Exception - if a failure occurs

printRequest

protected void printRequest(MockHttpServletRequest request)
                     throws Exception

Print the request.

Throws:

Exception

getRequestHeaders

protected final HttpHeaders getRequestHeaders(MockHttpServletRequest request)

getParamsMultiValueMap

protected final MultiValueMap<String,String> getParamsMultiValueMap(MockHttpServletRequest request)

getSessionAttributes

protected final Map<String,Object> getSessionAttributes(MockHttpServletRequest request)

printAsyncResult

protected void printAsyncResult(MvcResult result)
                         throws Exception

Throws:

Exception

printHandler

protected void printHandler(@Nullable Object handler,
 HandlerInterceptor @Nullable [] interceptors)
                     throws Exception

Print the handler.

Throws:

Exception

printResolvedException

protected void printResolvedException(@Nullable Exception resolvedException)
                               throws Exception

Print exceptions resolved through a HandlerExceptionResolver.

Throws:

Exception

printModelAndView

protected void printModelAndView(@Nullable ModelAndView mav)
                          throws Exception

Print the ModelAndView.

Throws:

Exception

printFlashMap

protected void printFlashMap(FlashMap flashMap)
                      throws Exception

Print "output" flash attributes.

Throws:

Exception

printResponse

protected void printResponse(MockHttpServletResponse response)
                      throws Exception

Print the response.

Throws:

Exception

getResponseHeaders

protected final HttpHeaders getResponseHeaders(MockHttpServletResponse response)