Package org.htmlunit.util

Class DebuggingWebConnection

  • All Implemented Interfaces:
    java.lang.AutoCloseable, WebConnection
    public class DebuggingWebConnection
extends WebConnectionWrapper
    Wrapper around a "real" WebConnection that will use the wrapped web connection to do the real job and save all received responses in the temp directory with an overview page.

    This may be useful at conception time to understand what is "browsed".

    Example: 
     final WebClient client = new WebClient();
 final WebConnection connection = new DebuggingWebConnection(client.getWebConnection(), "myTest");
 client.setWebConnection(connection);
    In this example an overview page will be generated under the name myTest/index.html in the temp directory and all received responses will be saved into the myTest folder.

    This class is only intended as a help during the conception.

    • Constructor Detail

      • DebuggingWebConnection

        public DebuggingWebConnection​(WebConnection webConnection,
                              java.lang.String dirName)
                       throws java.io.IOException
        Wraps a web connection to have a report generated of the received responses.
        Parameters:
        webConnection - the webConnection that do the real work
        dirName - the name of the directory to create in the tmp folder to save received responses. If this folder already exists, it will be deleted first.
        Throws:
        java.io.IOException - in case of problems writing the files

    • Method Detail

      • getResponse

        public WebResponse getResponse​(WebRequest request)
                        throws java.io.IOException
        Calls the wrapped webconnection and save the received response. Submits a request and retrieves a response. The default behavior of this method is to return WebConnection.getResponse(WebRequest) on the wrapped connection object.
        Specified by:
        getResponse in interface WebConnection
        Overrides:
        getResponse in class WebConnectionWrapper
        Parameters:
        request - the request
        Returns:
        the response to the request defined by the specified request
        Throws:
        java.io.IOException - if an IO error occurs

      • uncompressJavaScript

        protected WebResponse uncompressJavaScript​(WebResponse response)
        Tries to uncompress the JavaScript code in the provided response.
        Parameters:
        response - the response to uncompress
        Returns:
        a new response with uncompressed JavaScript code or the original response in case of failure

      • addMark

        public void addMark​(java.lang.String mark)
             throws java.io.IOException
        Adds a mark that will be visible in the HTML result page generated by this class.
        Parameters:
        mark - the text
        Throws:
        java.io.IOException - if a problem occurs writing the file

      • saveResponse

        protected void saveResponse​(WebResponse response,
                            WebRequest request)
                     throws java.io.IOException
        Saves the response content in the temp dir and adds it to the summary page.
        Parameters:
        response - the response to save
        request - the request used to get the response
        Throws:
        java.io.IOException - if a problem occurs writing the file

      • isUncompressJavaScript

        public boolean isUncompressJavaScript()
        Indicates if it should try to format responses recognized as JavaScript.
        Returns:
        default is false to deliver the original content

      • setUncompressJavaScript

        public void setUncompressJavaScript​(boolean decompress)
        Indicates that responses recognized as JavaScript should be formatted or not. Formatting is interesting for debugging when the original script is compressed on a single line. It allows to better follow with a debugger and to obtain more interesting error messages.
        Parameters:
        decompress - true if JavaScript responses should be uncompressed