system.net.httpClient

Provides a general use object that can be used to send and receive RESTful HTTP requests. The object created by this function is a wrapper around Java's HttpClient class. Typical use involves creating the a JythonHttpClient object with a call to system.net.httpClient, and then utilizing the varous methods (get(), post(), etc) on the JythonHttpClient to handle requests.

This scripting function has no Client Permission restrictions.

system.net.httpClient()

• Parameters

Integer timeout - A value, in milliseconds, to set the client’s connect timeout setting to. [Optional - Defaults to 60000]

Boolean bypass_cert_validation - A value, in milliseconds, to set the client’s read timeout setting to. [Optional - Defaults to False]

String username - A string indicating the username to use for authentication if the remote server requests authentication; specifically, by responding with a WWW-Authenticate or Proxy-Authenticate header. Only supports Basic authorization. If username is present but not password, an empty string will be used for password. [Optional - Defaults to None]

String password - A string indicating the password to use for authentication. [Optional - Defaults to None]

String proxy - The address of a proxy, which will be used for HTTP and HTTPS traffic. If the port is not specified, it will be assumed from the protocol in the URL, i.e. 80/443. [Optional - Defaults to None]

String cookie_policy - A string representing this client’s cookie policy. Accepts values "ACCEPT_ALL", "ACCEPT_NONE", and "ACCEPT_ORIGINAL_SERVER" . [Defaults to "ACCEPT_ORIGINAL_SERVER"]

String redirect_policy - A string representing this client’s redirect policy. Acceptable values are listed below. [Optional - Defaults to "Normal"]

• • • • • • • • • • "NEVER" - never allow redirects
                  • "ALWAYS" - allow redirects,
                  • "NORMAL" - allows redirects, except those that would downgrade to insecure addresses (i.e., HTTPS redirecting to HTTP).

Callable customizer - A reference to a callable function. This function will be called with one argument (an instance of HttpClient.Builder). The function should operate on the builder class and allows for arbitrary customization of the created HTTP client. [Optional - Defaults to None]

• Returns

JythonHttpClient  -  An object wrapped around an instance of Java's HttpClient class. The client object has methods that can be called against a website to get or send information through the web. See the panel below for more details.

• Scope

Gateway, Vision Client, Perspective Session

Once a JythonHttpClient object has been created, HTTP calls can be made with the build in methods detailed below. The various methods available on this object can be split under different categories.

JythonHttpClient Methods

JythonHttpClient Attributes

Once a JythonHttpClient object has been created, HTTP calls can be made with the build in methods detailed below. The various methods available on this object can be split under different categories.

CookieManager Methods

from java.net import CookiePolicy

client = system.net.httpClient()
manager = client.getCookieManager()
manager.setCookiePolicy(CookiePolicy.ACCEPT_NONE)

CookieManager Attributes

from java.net import CookiePolicy

client = system.net.httpClient()
manager = client.getCookieManager()
manager.setCookiePolicy(CookiePolicy.ACCEPT_NONE)

This section documents the Response object, generally returned by the blocking methods returned by the JythonHttpClient object. This object is simply a wrapper for Java's HTTPResponse object.

Response Methods

This section documents the Promise object, generally returned by the non-blocking methods returned by the JythonHttpClient object. This object is simply a wrapper for Java's CompletableFuture object that returns some type <T>.

Promise Methods

This section documents the RequestWrapper object, which is simply a wrapper around Java's HTTPRequest object.

RequestWrapper Methods