Package org.springframework.test.web.servlet.htmlunit

Class MockMvcWebConnection

  • All Implemented Interfaces:
    com.gargoylesoftware.htmlunit.WebConnection, AutoCloseable
    public final class MockMvcWebConnection
extends Object
implements com.gargoylesoftware.htmlunit.WebConnection
    MockMvcWebConnection enables MockMvc to transform a WebRequest into a WebResponse.

    This is the core integration with HtmlUnit.

    Example usage can be seen below. 

     WebClient webClient = new WebClient();
 MockMvc mockMvc = ...
 MockMvcWebConnection webConnection = new MockMvcWebConnection(mockMvc, webClient);
 webClient.setWebConnection(webConnection);

 // Use webClient as normal ...
    Since:
    4.2
    Author:
    Rob Winch, Sam Brannen
    See Also:
    WebConnectionHtmlUnitDriver

    • Constructor Detail

      • MockMvcWebConnection

        public MockMvcWebConnection​(MockMvc mockMvc,
                            com.gargoylesoftware.htmlunit.WebClient webClient)
        Create a new instance that assumes the context path of the application is "" (i.e., the root context).

        For example, the URL http://localhost/test/this would use "" as the context path.

        Parameters:
        mockMvc - the MockMvc instance to use; never null
        webClient - the WebClient to use. never null

      • MockMvcWebConnection

        public MockMvcWebConnection​(MockMvc mockMvc,
                            com.gargoylesoftware.htmlunit.WebClient webClient,
                            @Nullable
                            String contextPath)
        Create a new instance with the specified context path.

        The path may be null in which case the first path segment of the URL is turned into the contextPath. Otherwise it must conform to HttpServletRequest.getContextPath() which states that it can be an empty string and otherwise must start with a "/" character and not end with a "/" character.

        Parameters:
        mockMvc - the MockMvc instance to use (never null)
        webClient - the WebClient to use (never null)
        contextPath - the contextPath to use

    • Method Detail

      • setWebClient

        public void setWebClient​(com.gargoylesoftware.htmlunit.WebClient webClient)

      • getResponse

        public com.gargoylesoftware.htmlunit.WebResponse getResponse​(com.gargoylesoftware.htmlunit.WebRequest webRequest)
                                                      throws IOException
        Specified by:
        getResponse in interface com.gargoylesoftware.htmlunit.WebConnection
        Throws:
        IOException

      • close

        public void close()
        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface com.gargoylesoftware.htmlunit.WebConnection