Class Web

java.lang.Object

com.codename1.backend.Web

public final class Web
extends Object

Outbound HTTP and HTTPS for server-side binaries. Backed by libcurl, so TLS verification, redirects, chunked decoding and the system certificate store all come from a library that is maintained for the purpose.

Distinct from Http, which is a raw-socket plaintext client for the host runtime's loopback control protocol. Use this one for anything real.

Certificate store. A dynamically linked build finds the system CA bundle. A fully static build has whatever the image provides, which for a scratch container is nothing - and TLS then fails with "unable to get local issuer certificate". Ship a ca-certificates.crt and point curl at it with the CURL_CA_BUNDLE or SSL_CERT_FILE environment variable (the first one set wins). The native client reads them and hands the file to libcurl, which would not read either on its own.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Web.Exchange	One streamed HTTP exchange: the request body written as it is produced, the response read as it arrives, neither held in memory whole.
static final class	Web.Result	An outbound response: status, body, and libcurl's message when it failed.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	NO_BODY	The request has no body.
static final long	UNKNOWN_LENGTH	The request has a body whose length is not known in advance: chunked on HTTP/1.1, DATA frames until the end on HTTP/2.

Method Summary

Modifier and Type	Method	Description
static Web.Result	get(String url)
static Web.Result	getJson(String url, String bearerToken)
static Web.Exchange	open(String method, String url, List headers, long requestLength)	Opens a streamed exchange; see Web.Exchange.
static Web.Result	postJson(String url, String json, String bearerToken)
static Web.Result	request(String method, String url, List headers, byte[] body)	headers: a list of "Name: value" strings, or null

Methods inherited from class Object

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

Field Details

NO_BODY

public static final long NO_BODY

The request has no body.

See Also:

• Constant Field Values

UNKNOWN_LENGTH

public static final long UNKNOWN_LENGTH

The request has a body whose length is not known in advance: chunked on HTTP/1.1, DATA frames until the end on HTTP/2.

See Also:

• Constant Field Values

Method Details

get

public static Web.Result get(String url)
                      throws IOException

Throws:

IOException

getJson

public static Web.Result getJson(String url,
 String bearerToken)
                          throws IOException

Throws:

IOException

postJson

public static Web.Result postJson(String url,
 String json,
 String bearerToken)
                           throws IOException

Throws:

IOException

request

public static Web.Result request(String method,
 String url,
 List headers,
 byte[] body)
                          throws IOException

• headers: a list of "Name: value" strings, or null

Every default and no connection pool; a WebClient is the way to set a client certificate, require HTTP/2, change a timeout or reuse connections.

Throws:

IOException

open

public static Web.Exchange open(String method,
 String url,
 List headers,
 long requestLength)
                         throws IOException

Opens a streamed exchange; see Web.Exchange. Every default, no pool.

Throws:

IOException