org.apache.jmeter.protocol.http.sampler

## Class HTTPJavaImpl

- java.lang.Object
- - org.apache.jmeter.protocol.http.sampler.HTTPAbstractImpl
  - - org.apache.jmeter.protocol.http.sampler.HTTPJavaImpl

- All Implemented Interfaces:
    HTTPConstantsInterface, Interruptible

      public class HTTPJavaImpl
      extends HTTPAbstractImpl

  A sampler which understands all the parts necessary to read statistics about HTTP requests, including cookies and authentication.

- - ### Field Summary

    - ### Fields inherited from class org.apache.jmeter.protocol.http.sampler.HTTPAbstractImpl

      `ADD_CONTENT_TYPE_TO_POST_IF_MISSING, ALL_EXCEPT_COOKIE, ONLY_COOKIE, testElement`

    - ### Fields inherited from interface org.apache.jmeter.protocol.http.util.HTTPConstantsInterface

      `APPLICATION_X_WWW_FORM_URLENCODED, CACHE_CONTROL, CONNECT, CONNECTION_CLOSE, COPY, DATE, DEFAULT_HTTP_PORT, DEFAULT_HTTP_PORT_STRING, DEFAULT_HTTPS_PORT, DEFAULT_HTTPS_PORT_STRING, DELETE, ENCODING_BROTLI, ENCODING_DEFLATE, ENCODING_GZIP, ETAG, EXPIRES, GET, HEAD, HEADER_AUTHORIZATION, HEADER_CONNECTION, HEADER_CONTENT_DISPOSITION, HEADER_CONTENT_ENCODING, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_COOKIE, HEADER_COOKIE_IN_REQUEST, HEADER_HOST, HEADER_LOCAL_ADDRESS, HEADER_LOCATION, HEADER_SET_COOKIE, HTTP_1_1, IF_MODIFIED_SINCE, IF_NONE_MATCH, KEEP_ALIVE, LAST_MODIFIED, LOCK, MKCALENDAR, MKCOL, MOVE, MULTIPART_FORM_DATA, OPTIONS, PATCH, POST, PROPFIND, PROPPATCH, PROTOCOL_HTTP, PROTOCOL_HTTPS, PUT, REPORT, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_SEE_OTHER, SC_TEMPORARY_REDIRECT, SEARCH, TRACE, TRANSFER_ENCODING, UNLOCK, VARY`

  - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `HTTPJavaImpl(HTTPSamplerBase base)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | `disconnect(HttpURLConnection conn)`
    `protected String` | `getResponseHeaders(HttpURLConnection conn)` Gets the ResponseHeaders from the URLConnection
    `boolean` | `interrupt()` Interrupt the current operation if possible.
    `protected byte[]` | `readResponse(HttpURLConnection conn, SampleResult res)` Reads the response from the URL connection.
    `protected HTTPSampleResult` | `sample(URL url, String method, boolean areFollowingRedirect, int frameDepth)` Samples the URL passed in and stores the result in `HTTPSampleResult`, following redirects and downloading page resources as appropriate.
    `protected String` | `sendPostData(URLConnection connection)` Send POST data from `Entry` to the open connection.
    `protected void` | `setPostHeaders(URLConnection conn)` Set request headers in preparation to opening a connection.
    `protected HttpURLConnection` | `setupConnection(URL u, String method, HTTPSampleResult res)` Returns an `HttpURLConnection` fully ready to attempt connection.

    - ### Methods inherited from class org.apache.jmeter.protocol.http.sampler.HTTPAbstractImpl

      `configureSampleLabel, errorResult, getArguments, getAuthManager, getAutoRedirects, getCacheManager, getConnectTimeout, getContentEncoding, getCookieManager, getDoBrowserCompatibleMultipart, getHeaderManager, getHTTPFiles, getIpSource, getIpSourceAddress, getProxyHost, getProxyPass, getProxyPortInt, getProxyScheme, getProxyUser, getResponseTimeout, getSendFileAsPostBody, getSendParameterValuesAsPostBody, getUseKeepAlive, getUseMultipart, getUseMultipartForPost, hasArguments, isMonitor, isSuccessCode, notifyFirstSampleAfterLoopRestart, notifySSLContextWasReset, readResponse, readResponse, readResponse, readResponse, resultProcessing, setUseKeepAlive, threadFinished, updateSampleResultForResourceInCache`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### HTTPJavaImpl

          protected HTTPJavaImpl(HTTPSamplerBase base)

  - ### Method Detail

    - #### setPostHeaders

          protected void setPostHeaders(URLConnection conn)
                                 throws IOException

      Set request headers in preparation to opening a connection.
      Parameters:
        `conn` - `URLConnection` to set headers on
      Throws:
        `IOException` - if an I/O exception occurs

    - #### sendPostData

          protected String sendPostData(URLConnection connection)
                                 throws IOException

      Send POST data from `Entry` to the open connection. This also handles sending data for PUT requests
      Parameters:
        `connection` - `URLConnection` where POST data should be sent
      Returns:
        a String show what was posted. Will not contain actual file upload content
      Throws:
        `IOException` - if an I/O exception occurs

    - #### setupConnection

          protected HttpURLConnection setupConnection(URL u,
                                                      String method,
                                                      HTTPSampleResult res)
                                               throws IOException

      Returns an `HttpURLConnection` fully ready to attempt connection. This means it sets the request method (GET or POST), headers, cookies, and authorization for the URL request.

      The request infos are saved into the sample result if one is provided.

      Parameters:
        `u` - `URL` of the URL request
        `method` - GET, POST etc
        `res` - sample result to save request infos to
      Returns:
        `HttpURLConnection` ready for .connect
      Throws:
        `IOException` - if an I/O Exception occurs

    - #### readResponse

          protected byte[] readResponse(HttpURLConnection conn,
                                        SampleResult res)
                                 throws IOException

      Reads the response from the URL connection.
      Parameters:
        `conn` - URL from which to read response
        `res` - `SampleResult` to read response into
      Returns:
        response content
      Throws:
        `IOException` - if an I/O exception occurs

    - #### getResponseHeaders

          protected String getResponseHeaders(HttpURLConnection conn)

      Gets the ResponseHeaders from the URLConnection
      Parameters:
        `conn` - connection from which the headers are read
      Returns:
        string containing the headers, one per line

    - #### sample

          protected HTTPSampleResult sample(URL url,
                                            String method,
                                            boolean areFollowingRedirect,
                                            int frameDepth)

      Samples the URL passed in and stores the result in `HTTPSampleResult`, following redirects and downloading page resources as appropriate.

      When getting a redirect target, redirects are not followed and resources are not downloaded. The caller will take care of this.

      Specified by:
        `sample` in class `HTTPAbstractImpl`
      Parameters:
        `url` - URL to sample
        `method` - HTTP method: GET, POST,...
        `areFollowingRedirect` - whether we're getting a redirect target
        `frameDepth` - Depth of this target in the frame structure. Used only to prevent infinite recursion.
      Returns:
        results of the sampling

    - #### disconnect

          protected void disconnect(HttpURLConnection conn)

    - #### interrupt

          public boolean interrupt()

      Interrupt the current operation if possible.
      Returns:
        `true` if there was an operation to interrupt.

Copyright © 1998-2021 Apache Software Foundation. All Rights Reserved.