Package com.inductiveautomation.ignition.common.script.builtin.http

Class Response

java.lang.Object

com.inductiveautomation.ignition.common.script.builtin.http.Response

public class Response
extends Object

The result of an HTTP request.

Provides access to status codes, headers, and body content. In Python, this object's properties (e.g., status, body, json, text) can be accessed directly.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Response.RequestWrapper

Constructor Summary

Constructors

Constructor	Description
Response(HttpResponse<byte[]> httpResponse, JythonHttpClient client)

Method Summary

Modifier and Type	Method	Description
byte[]	getBody()
CookieManager	getCookieManager()
Map<String,List<String>>	getHeaders()
HttpResponse<byte[]>	getJavaResponse()
org.python.core.PyObject	getJson()
@NonNull org.python.core.PyObject	getJson(org.python.core.PyObject[] args, String[] kwargs)	Attempt to decode the raw byte[] this Response contains to a string with the specified charset, and then decode that string to a direct Python representation (ie, dictionaries and lists).
Response.RequestWrapper	getRequest()
int	getStatusCode()
String	getText()
@NonNull String	getText(org.python.core.PyObject[] args, String[] kwargs)	Attempt to decode the raw byte[] this Response contains to a string with the specified charset.
String	getUrl()
boolean	isClientError()
boolean	isGood()
boolean	isServerError()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Response

public Response(HttpResponse<byte[]> httpResponse,
 JythonHttpClient client)

Method Details

getBody

public byte[] getBody()

Returns:

The raw byte array of the response body. Accessible as body in Python.

getJson

public org.python.core.PyObject getJson()

Returns:

The response body decoded as a PyObject (e.g., dictionary or list). Accessible as json in Python.

getJson

public @NonNull org.python.core.PyObject getJson(org.python.core.PyObject[] args,
 String[] kwargs)

Attempt to decode the raw byte[] this Response contains to a string with the specified charset, and then decode that string to a direct Python representation (ie, dictionaries and lists). Encoding defaults to the charset specified in the response, or StandardCharsets.UTF_8 if the response did not specify a charset.

getText

public String getText()

Returns:

The response body as a string. Accessible as text in Python.

getText

public @NonNull String getText(org.python.core.PyObject[] args,
 String[] kwargs)

Attempt to decode the raw byte[] this Response contains to a string with the specified charset. Caches decoded bodies so they can be quickly retrieved again, per charset. Encoding defaults to the charset specified in the response, or StandardCharsets.UTF_8 if the response did not specify a charset.

getUrl

public String getUrl()

getHeaders

public Map<String,List<String>> getHeaders()

getStatusCode

public int getStatusCode()

Returns:

The HTTP status code (e.g., 200, 404). Accessible as statusCode in Python.

isGood

public boolean isGood()

Returns:

true if the response code was not any error.

isClientError

public boolean isClientError()

Returns:

true if the response code was a 4XX error.

isServerError

public boolean isServerError()

Returns:

true if the response code was a 5XX error.

getCookieManager

public CookieManager getCookieManager()

getJavaResponse

public HttpResponse<byte[]> getJavaResponse()

getRequest

public Response.RequestWrapper getRequest()

toString

public String toString()

Overrides:

toString in class Object