HttpEngine.Builder

HTTP_CACHE_DISABLED

public static final int HTTP_CACHE_DISABLED

Setting to disable HTTP cache. Some data may still be temporarily stored in memory. Passed to setEnableHttpCache(int, long).

Constant Value: 0 (0x00000000)

HTTP_CACHE_DISK

public static final int HTTP_CACHE_DISK

Setting to enable on-disk cache, including HTTP data. setStoragePath(String) must be called prior to passing this constant to setEnableHttpCache(int, long).

Constant Value: 3 (0x00000003)

HTTP_CACHE_DISK_NO_HTTP

public static final int HTTP_CACHE_DISK_NO_HTTP

Setting to enable on-disk cache, excluding HTTP data. setStoragePath(String) must be called prior to passing this constant to setEnableHttpCache(int, long).

Constant Value: 2 (0x00000002)

HTTP_CACHE_IN_MEMORY

public static final int HTTP_CACHE_IN_MEMORY

Setting to enable in-memory HTTP cache, including HTTP data. Passed to setEnableHttpCache(int, long).

Constant Value: 1 (0x00000001)

Builder

public Builder (Context context)

Constructs a Builder object that facilitates creating a HttpEngine. The default configuration enables HTTP/2 and QUIC, but disables the HTTP cache.

addPublicKeyPins

public HttpEngine.Builder addPublicKeyPins (String hostName, 
                Set<byte[]> pinsSha256, 
                boolean includeSubdomains, 
                Instant expirationInstant)

Pins a set of public keys for a given host. By pinning a set of public keys, pinsSha256, communication with hostName is required to authenticate with a certificate with a public key from the set of pinned ones. An app can pin the public key of the root certificate, any of the intermediate certificates or the end-entry certificate. Authentication will fail and secure communication will not be established if none of the public keys is present in the host's certificate chain, even if the host attempts to authenticate with a certificate allowed by the device's trusted store of certificates.

Calling this method multiple times with the same host name overrides the previously set pins for the host.

More information about the public key pinning can be found in RFC 7469.

addQuicHint

public HttpEngine.Builder addQuicHint (String host, 
                int port, 
                int alternatePort)

Adds hint that host supports QUIC. Note that enableHttpCache (HTTP_CACHE_DISK) is needed to take advantage of 0-RTT connection establishment between sessions.

build

public HttpEngine build ()

Build a HttpEngine using this builder's configuration.

getDefaultUserAgent

public String getDefaultUserAgent ()

Constructs a default User-Agent string including the system build version, model and id, and the HTTP stack version.

setConnectionMigrationOptions

public HttpEngine.Builder setConnectionMigrationOptions (ConnectionMigrationOptions connectionMigrationOptions)

Configures the behavior of connection migration. For more details, see documentation of ConnectionMigrationOptions and the individual methods of ConnectionMigrationOptions.Builder.

Only relevant if setEnableQuic(boolean) is enabled.

setDnsOptions

public HttpEngine.Builder setDnsOptions (DnsOptions dnsOptions)

Configures the behavior of hostname lookup. For more details, see documentation of DnsOptions and the individual methods of DnsOptions.Builder.

Only relevant if setEnableQuic(boolean) is enabled.

setEnableBrotli

public HttpEngine.Builder setEnableBrotli (boolean value)

Sets whether Brotli compression is enabled. If enabled, Brotli will be advertised in Accept-Encoding request headers. Defaults to disabled.

setEnableHttp2

public HttpEngine.Builder setEnableHttp2 (boolean value)

Sets whether HTTP/2 protocol is enabled. Defaults to enabled.

setEnableHttpCache

public HttpEngine.Builder setEnableHttpCache (int cacheMode, 
                long maxSize)

Enables or disables caching of HTTP data and other information like QUIC server information.

setEnablePublicKeyPinningBypassForLocalTrustAnchors

public HttpEngine.Builder setEnablePublicKeyPinningBypassForLocalTrustAnchors (boolean value)

Enables or disables public key pinning bypass for local trust anchors. Disabling the bypass for local trust anchors is highly discouraged since it may prohibit the app from communicating with the pinned hosts. E.g., a user may want to send all traffic through an SSL enabled proxy by changing the device proxy settings and adding the proxy certificate to the list of local trust anchor. Disabling the bypass will most likly prevent the app from sending any traffic to the pinned hosts. For more information see 'How does key pinning interact with local proxies and filters?' at https://www.chromium.org/Home/chromium-security/security-faq

setEnableQuic

public HttpEngine.Builder setEnableQuic (boolean value)

Sets whether QUIC protocol is enabled. Defaults to enabled.

setQuicOptions

public HttpEngine.Builder setQuicOptions (QuicOptions quicOptions)

Configures the behavior of the HTTP stack when using QUIC. For more details, see documentation of QuicOptions and the individual methods of QuicOptions.Builder.

Only relevant if setEnableQuic(boolean) is enabled.

setStoragePath

public HttpEngine.Builder setStoragePath (String value)

Sets directory for HTTP Cache and Cookie Storage. The directory must exist.

NOTE: Do not use the same storage directory with more than one HttpEngine at a time. Access to the storage directory does not support concurrent access by multiple HttpEngine instances.

setUserAgent

public HttpEngine.Builder setUserAgent (String userAgent)

Overrides the User-Agent header for all requests. An explicitly set User-Agent header (set using UrlRequest.Builder#addHeader) will override a value set using this function.