Builder

HTTP_CACHE_DISABLED

static val HTTP_CACHE_DISABLED: Int

Setting to disable HTTP cache. Some data may still be temporarily stored in memory. Passed to setEnableHttpCache.

Value: 0

HTTP_CACHE_DISK

static val HTTP_CACHE_DISK: Int

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

Value: 3

HTTP_CACHE_DISK_NO_HTTP

static val HTTP_CACHE_DISK_NO_HTTP: Int

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

Value: 2

HTTP_CACHE_IN_MEMORY

static val HTTP_CACHE_IN_MEMORY: Int

Setting to enable in-memory HTTP cache, including HTTP data. Passed to setEnableHttpCache.

Value: 1

Builder

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

open fun addPublicKeyPins(
    hostName: String, 
    pinsSha256: MutableSet<ByteArray!>, 
    includeSubdomains: Boolean, 
    expirationInstant: Instant
): HttpEngine.Builder

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

open fun addQuicHint(
    host: String, 
    port: Int, 
    alternatePort: Int
): HttpEngine.Builder

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

open fun build(): HttpEngine

Build a HttpEngine using this builder's configuration.

getDefaultUserAgent

open fun getDefaultUserAgent(): String

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

setConnectionMigrationOptions

open fun setConnectionMigrationOptions(connectionMigrationOptions: ConnectionMigrationOptions): HttpEngine.Builder

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

open fun setDnsOptions(dnsOptions: DnsOptions): HttpEngine.Builder

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

open fun setEnableBrotli(value: Boolean): HttpEngine.Builder

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

setEnableHttp2

open fun setEnableHttp2(value: Boolean): HttpEngine.Builder

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

setEnableHttpCache

open fun setEnableHttpCache(
    cacheMode: Int, 
    maxSize: Long
): HttpEngine.Builder

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

setEnablePublicKeyPinningBypassForLocalTrustAnchors

open fun setEnablePublicKeyPinningBypassForLocalTrustAnchors(value: Boolean): HttpEngine.Builder

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 likely 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

open fun setEnableQuic(value: Boolean): HttpEngine.Builder

Sets whether QUIC protocol is enabled. Defaults to enabled.

setQuicOptions

open fun setQuicOptions(quicOptions: QuicOptions): HttpEngine.Builder

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

open fun setStoragePath(value: String): HttpEngine.Builder

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

open fun setUserAgent(userAgent: String): HttpEngine.Builder

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.