Configure a Proxy

Configure proxy servers for webmate tests when the application under test requires controlled network routing.

Multiple types of proxy servers are supported in webmate, such as unauthenticated proxies and authenticated proxies via username/password or NTLM authentication.

Credentials

You can also use webmate as a proxy. The following credentials, the proxy host and port are always required. The user and password are only required for username/password authentication with the proxy and user domain and password are required for NTLM authentication.

Basic setup

To use a proxy, you have to use a HttpClientBuilder and specify the host and port. If the proxy does not need authentication, this is all you need to do.

HttpClientBuilder builder = HttpClientBuilder.create();
HttpHost proxy = new HttpHost(proxyHost, proxyPort);
builder.setProxy(proxy);
WebmateAPISession apiSession = new WebmateAPISession(authInfo, env, builder);

All code:

String PROXY_HOST = "localhost";
int PROXY_PORT = 3128;

String PROXY_USER = "proxyuser";
String PROXY_PASSWORD = "proxypass";

String PROXY_USER_DOMAIN = "userdomain";
        
HttpClientBuilder builder = HttpClientBuilder.create();
HttpHost proxy = new HttpHost(proxyHost, proxyPort);
builder.setProxy(proxy);
WebmateAPISession apiSession = new WebmateAPISession(authInfo, env, builder);

Authenticated proxy

To use a proxy with authentication you also have to provide a CredentialsProvider and set it as provider for the builder

Username + password authentication proxy

To use a proxy with username/password authentication you have to provide the credentials.

All code:

String PROXY_HOST = "localhost";
int PROXY_PORT = 3128;

String PROXY_USER = "proxyuser";
String PROXY_PASSWORD = "proxypass";

String PROXY_USER_DOMAIN = "userdomain";
        
HttpClientBuilder builder = HttpClientBuilder.create();
HttpHost proxy = new HttpHost(proxyHost, proxyPort);
builder.setProxy(proxy);

CredentialsProvider credsProvider = new BasicCredentialsProvider();
credsProvider.setCredentials(new AuthScope(proxyHost, proxyPort), new UsernamePasswordCredentials(proxyUser, proxyPassword));
builder.setDefaultCredentialsProvider(credsProvider);
        
WebmateAPISession apiSession = new WebmateAPISession(authInfo, env, builder);

NTLM authentication proxy

To use a proxy with NTLM authentication, you have to provide the credentials, which is more complex than password authentication.

WebmateEnvironment webmateEnv = WebmateEnvironment.create()
URI apiUrl = webmateEnv.baseURI;

String workstation;
Map<String, String> env = System.getenv();
if (env.containsKey("COMPUTERNAME")) {
    workstation = env.get("COMPUTERNAME");
} else if (env.containsKey("HOSTNAME")) {
    workstation = env.get("HOSTNAME");
} else {
    try {
        workstation = InetAddress.getLocalHost().getHostName();
    }
    catch (UnknownHostException ex) {
        workstation = "Unknown";
    }
}
        
credsProvider.setCredentials(new AuthScope(proxyHost, proxyPort), new NTCredentials(proxyUser, proxyPassword, workstation, proxyUserDomain));
if (apiUrl.getUserInfo() != null && !apiUrl.getUserInfo().isEmpty()) {
    credsProvider.setCredentials(new AuthScope(apiUrl.getHost(), apiUrl.getPort() > 0 ? apiUrl.getPort() : 443),
            new UsernamePasswordCredentials(apiUrl.getUserInfo()));
}

All code: