reactor.netty.tcp

Class ProxyProvider

java.lang.Object

reactor.netty.tcp.ProxyProvider

public final class ProxyProvider
extends Object

Proxy configuration

Author:

Violeta Georgieva

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProxyProvider.AddressSpec
static interface	ProxyProvider.Builder
static class	ProxyProvider.Proxy Proxy Type
static interface	ProxyProvider.TypeSpec

Method Summary

Modifier and Type	Method and Description
String	asDetailedString() Deprecated. as of 0.9.7. Use toString()
String	asSimpleString() Deprecated. as of 0.9.7. Use toString()
static ProxyProvider.TypeSpec	builder() Creates a builder for ProxyProvider
boolean	equals(Object o)
static ProxyProvider	findProxySupport(Bootstrap b) Find Proxy support in the given client bootstrap
java.util.function.Supplier<? extends InetSocketAddress>	getAddress() The supplier for the address to connect to.
Pattern	getNonProxyHosts() Deprecated. as of 0.9.10. Use getNonProxyHostsPredicate(). This method will be removed in version 1.0.0.
java.util.function.Predicate<SocketAddress>	getNonProxyHostsPredicate() A predicate Predicate on SocketAddress that returns true when the provided address should be reached directly, bypassing the proxy
ProxyProvider.Proxy	getType() The proxy type
int	hashCode()
ProxyHandler	newProxyHandler() Return a new eventual ProxyHandler
boolean	shouldProxy(SocketAddress address) Returns true when the given SocketAddress should be reached via the configured proxy.
boolean	shouldProxy(String hostName) Deprecated. as of 0.9.10. use shouldProxy(SocketAddress). This method will be removed in version 1.0.0.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static ProxyProvider.TypeSpec builder()

Creates a builder for ProxyProvider

Returns:

a new ProxyProvider builder

findProxySupport

@Nullable
public static ProxyProvider findProxySupport(Bootstrap b)

Find Proxy support in the given client bootstrap

Parameters:

b - a bootstrap to search

Returns:

any ProxyProvider found or null

getType

public final ProxyProvider.Proxy getType()

The proxy type

Returns:

The proxy type

getAddress

public final java.util.function.Supplier<? extends InetSocketAddress> getAddress()

The supplier for the address to connect to.

Returns:

The supplier for the address to connect to.

getNonProxyHosts

@Nullable
 @Deprecated
public final Pattern getNonProxyHosts()

Deprecated. as of 0.9.10. Use getNonProxyHostsPredicate(). This method will be removed in version 1.0.0.

Regular expression (using java.util.regex) for a configured list of hosts that should be reached directly, bypassing the proxy.

Returns:

Regular expression (using java.util.regex) for a configured list of hosts that should be reached directly, bypassing the proxy.

getNonProxyHostsPredicate

public final java.util.function.Predicate<SocketAddress> getNonProxyHostsPredicate()

A predicate Predicate on SocketAddress that returns true when the provided address should be reached directly, bypassing the proxy

Returns:

The predicate Predicate to test the incoming SocketAddress if it should be reached directly, bypassing the proxy

Since:

0.9.10

newProxyHandler

public final ProxyHandler newProxyHandler()

Return a new eventual ProxyHandler

Returns:

a new eventual ProxyHandler

shouldProxy

public boolean shouldProxy(SocketAddress address)

Returns true when the given SocketAddress should be reached via the configured proxy. When the method returns false, the client should reach the address directly and bypass the proxy

Parameters:

address - the address to test

Returns:

true if of type InetSocketAddress and hostname candidate to proxy

shouldProxy

@Deprecated
public boolean shouldProxy(@Nullable
                                       String hostName)

Deprecated. as of 0.9.10. use shouldProxy(SocketAddress). This method will be removed in version 1.0.0.

Returns true when the given hostname should be reached via the configured proxy. When the method returns false, the client should reach the address directly and bypass the proxy

Parameters:

hostName - the hostname to test

Returns:

true if should be proxied

asSimpleString

@Deprecated
public String asSimpleString()

Deprecated. as of 0.9.7. Use toString()

asDetailedString

@Deprecated
public String asDetailedString()

Deprecated. as of 0.9.7. Use toString()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object