OpenLegacy REST Connector – Proxy Configuration Guide
OpenLegacy REST Connector – Proxy Configuration Guide
Overview
The OpenLegacy REST Connector supports outbound HTTP and HTTPS requests through a proxy server.
This feature is implemented using the Vert.x WebClient and its native ProxyOptions configuration.
This document describes the supported proxy parameters and their purpose.
Supported Proxy Properties
The following configuration parameters are available for the REST Connector:
| Property | Type | Description | Default |
|---|---|---|---|
proxyHost | String | Hostname or IP address of the proxy server. | "" (not set) |
proxyPort | Int | Port number of the proxy server. | null (not set) |
proxyUser | String | Username for proxy authentication, if required. | "" (not set) |
proxyPassword | String | Password for proxy authentication, if required. | "" (not set) |
proxyType | String | Type of proxy to use. Supported values: HTTP, SOCKS4, SOCKS5. | "HTTP" |
Each property can be configured in the Connection definition.
Note: The Proxy configuration is also used by the OAuth2 configuration if any.
Supported Proxy Types
The connector supports the following proxy types:
| Proxy Type | Description |
|---|---|
HTTP | Standard HTTP proxy supporting CONNECT tunneling for HTTPS. |
SOCKS4 | SOCKS version 4 proxy protocol. |
SOCKS5 | SOCKS version 5 proxy protocol with optional authentication. |
Note: When usingSOCKS5,proxyUserandproxyPasswordcan be provided if the proxy requires authentication.
Example Configuration
Module Configuration Example
{
"host": "api.mycompany.com",
"proxyHost": "proxy.mycompany.com",
"proxyPort": "8080",
"proxyUser": "myProxyUser",
"proxyPassword": "mySecretPassword",
"proxyType": "HTTP"
}Updated 17 days ago