Package org.keycloak.connections.httpclient

Class ProxyMappings

java.lang.Object

org.keycloak.connections.httpclient.ProxyMappings

public class ProxyMappings
extends Object

ProxyMappings describes an ordered mapping for hostname regex patterns to a HttpHost proxy.

Mappings can be created via valueOf(String...) or valueOf(List). For a description of the mapping format see ProxyMappings.ProxyMapping.valueOf(String)

Author:

Thomas Darimont

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProxyMappings.ProxyMapping	ProxyMappings.ProxyMapping describes a Proxy Mapping with a Hostname Pattern that is mapped to a proxy HttpHost.

Constructor Summary

Constructors

Constructor	Description
ProxyMappings(List<ProxyMappings.ProxyMapping> entries)	Creates a ProxyMappings from the provided Entries.

Method Summary

Modifier and Type	Method	Description
static void	clearCache()
ProxyMappings.ProxyMapping	getProxyFor(String hostname)
boolean	isEmpty()
static ProxyMappings	valueOf(String... proxyMappings)	Creates a new ProxyMappings from the provided String[] of proxy mapping strings.
static ProxyMappings	valueOf(List<String> proxyMappings)	Creates a new ProxyMappings from the provided List of proxy mapping strings.
static ProxyMappings	withFixedProxyMapping(String httpProxy, String noProxy)	Creates a new ProxyMappings from provided parameters representing the established HTTP(S)_PROXY and NO_PROXY environment variables.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProxyMappings

public ProxyMappings(List<ProxyMappings.ProxyMapping> entries)

Creates a ProxyMappings from the provided Entries.

Parameters:

entries -

Method Detail

valueOf

public static ProxyMappings valueOf(List<String> proxyMappings)

Creates a new ProxyMappings from the provided List of proxy mapping strings.

Parameters:

proxyMappings -

valueOf

public static ProxyMappings valueOf(String... proxyMappings)

Creates a new ProxyMappings from the provided String[] of proxy mapping strings.

Parameters:

proxyMappings -

Returns:

See Also:

valueOf(List), valueOf(String...)

withFixedProxyMapping

public static ProxyMappings withFixedProxyMapping(String httpProxy,
                                                  String noProxy)

Creates a new ProxyMappings from provided parameters representing the established HTTP(S)_PROXY and NO_PROXY environment variables.

Parameters:

httpProxy - a proxy used for all hosts except the ones specified in noProxy

noProxy - a list of hosts (separated by comma) that should not use proxy; all suffixes are matched too (e.g. redhat.com will also match access.redhat.com)

Returns:

See Also:

https://about.gitlab.com/blog/2021/01/27/we-need-to-talk-no-proxy/

isEmpty

public boolean isEmpty()

getProxyFor

public ProxyMappings.ProxyMapping getProxyFor(String hostname)

Parameters:

hostname -

Returns:

the ProxyMappings.ProxyMapping associated with the first matching hostname Pattern or the ProxyMappings.ProxyMapping including null as HttpHost if none matches.

clearCache

public static void clearCache()