system.net.httpClient

Provides a general use object that can be used to send and receive HTTP requests. The object created by this function is a wrapper around Java's HttpClient class. Usage requires creating a JythonHttpClient object with a call to system.net.httpClient, then calling a method (such as get(), post()) on the JythonHttpClient to actually issue a request.

system.net.httpClient([timeout], [bypass_cert_validation], [username], [password], [proxy],  [cookie_policy], [redirect_policy], [customizer])

• Parameters

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

Boolean bypass_cert_validation - A boolean indicating whether the client should attempt to validate the certificates of remote servers, if connecting via HTTPS/SSL. Defaults to False. [optional]

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 authentication. If username is specified but not password, an empty string will be used for the password in the Basic Authentication response. Defaults to None. [optional]

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

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

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. Defaults to "Never". [optional]

• • • • • "NEVER" - never allow redirects
        • "ALWAYS" - allow redirects

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

String version - A string specifying either HTTP_2 or HTTP_1_1 for the HTTP protocol. When omitted, the previous default of HTTP_2 is implied. [optional]

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

• Returns

JythonHttpClient  -  An object wrapped around an instance of Java's HttpClient class. The httpClient object has methods that can be called to execute HTTP requests against a server. See the panel below for more details.

• Scope

Gateway, Vision Client, Perspective Session

Once a JythonHttpClient object has been created, it can be used to handle many HTTP requests without needing to create a new client. Individual HTTP requests can be made with the methods detailed below.

JythonHttpClient Methods

.get()

.getAsync()

.post()

.postAsync()

.put()

.putAsync()

.delete()

.deleteAsync()

.patch()

.patchAsync()

.head()

.headAsync()

.options()

.optionsAsync()

.trace()

.traceAsync()

.request()

.requestAsync()

from com.inductiveautomation.ignition.common.gson import GsonBuilder

# Create the client instance
client = system.net.httpClient()

# Create a new 
altGson = GsonBuilder().serializeNulls().create()
client.setGson(altGson)

JythonHttpClient Attributes

.javaClient

.cookieManager

Each JythonHttpClient instance has an attached CookieManager. This CookieManager can be accessed to retrieve cookies set by external web services, or to set cookies (i.e., for authentication) before a request is made.

CookieManager Methods and Attributes

.getCookieStore()

.cookieStore

.setCookiePolicy(policy)

from java.net import CookiePolicy

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

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

Response Methods and Attributes

.getBody()

.body

.getJson([encoding])

.json

.getText([encoding])

.text

.getStatusCode()

.statusCode

.isGood()

.good

.isClientError()

.clientError

.isServerError()

.serverError

.getUrl()

.url

.getHeaders()

.headers

.getJavaResponse()

.javaResponse

.getCookieManager()

.cookieManager

This section documents the Promise object, which is returned by the asynchronous methods available on the JythonHttpClient object. This object is a wrapper around Java's CompletableFuture class, and will return some different object once completed with .get().

Promise Methods and Attributes

.get([timeout])

.then(callback)

.handleException(callback)

.whenComplete(callback)

.cancel()

.getFuture()

.future

.isDone()

.done

This section documents the RequestWrapper object, which is simply a wrapper around Java's HTTPRequest object. This object can be used to determine details about the request that was originally sent to populate a Response object.

RequestWrapper Methods and Attributes

.getUrl()

.url

.getMethod()

.method

.getHeaders()

.headers

.getTimeout()

.timeout

.getVersion()

.version

.getJavaRequest()

.javaRequest

system nav httpClient, nav.httpClient