adswizz-core/com.adswizz.core.proxy/ProxyURLConfig

ProxyURLConfig

data class ProxyURLConfig(val baseURL: String, val path: String = "", val additionalHeaders: Map<String, String> = emptyMap(), val strategy: ProxyStrategy = ProxyStrategy.HEADER_ORIGINAL_URL, val originalUrlHeaderName: String? = "X-Adswizz-Proxy-Original-URL", val originalUrlQueryParam: String? = "target_uri")

Configuration object that defines how a network request should be mapped to a proxy.

Constructors

ProxyURLConfig

constructor(baseURL: String, path: String = "", additionalHeaders: Map<String, String> = emptyMap(), strategy: ProxyStrategy = ProxyStrategy.HEADER_ORIGINAL_URL, originalUrlHeaderName: String? = "X-Adswizz-Proxy-Original-URL", originalUrlQueryParam: String? = "target_uri")

Properties

additionalHeaders

val additionalHeaders: Map<String, String>

Optional headers appended to every proxied request.

baseURL

val baseURL: String

Base url of the publisher proxy (e.g. https://proxy.com). Must be https in production builds Must be a valid absolute URL. SHOULD use HTTPS in production environments. May include a custom port (e.g., https://proxy.com:8443).

originalUrlHeaderName

val originalUrlHeaderName: String?

The header name used to transmit the original request URL when using ProxyStrategy.HEADER_ORIGINAL_URL

originalUrlQueryParam

val originalUrlQueryParam: String?

The query parameter name used to embed the original request URL when using ProxyStrategy.QUERY_PARAM_ORIGINAL_URL.

path

val path: String

Optional path appended to baseURL to form the final proxy endpoint.

strategy

val strategy: ProxyStrategy

Determines how the original destination URL is embedded into the proxied request.