org.apache.pekko.http.javadsl

Class ClientTransport

java.lang.Object

org.apache.pekko.http.javadsl.ClientTransport

public abstract class ClientTransport
extends java.lang.Object

(Still unstable) SPI for implementors of custom client transports.

Constructor Summary

Constructors

Constructor and Description
ClientTransport()

Method Summary

Modifier and Type	Method and Description
abstract org.apache.pekko.stream.javadsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,java.util.concurrent.CompletionStage<OutgoingConnection>>	connectTo(java.lang.String host, int port, ClientConnectionSettings settings, org.apache.pekko.actor.ActorSystem system)
static ClientTransport	fromScala(ClientTransport scalaTransport)
static ClientTransport	httpsProxy(org.apache.pekko.actor.ActorSystem system) Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method.
static ClientTransport	httpsProxy(HttpCredentials proxyCredentials, org.apache.pekko.actor.ActorSystem system) Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method.
static ClientTransport	httpsProxy(java.net.InetSocketAddress proxyAddress) Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method.
static ClientTransport	httpsProxy(java.net.InetSocketAddress proxyAddress, HttpCredentials proxyCredentials) Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method.
static ClientTransport	TCP()
static ClientTransport	toScala(ClientTransport javaTransport)
static ClientTransport	withCustomResolver(java.util.function.BiFunction<java.lang.String,java.lang.Object,java.util.concurrent.CompletionStage<java.net.InetSocketAddress>> lookup) Returns a ClientTransport that allows to customize host name resolution.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientTransport

public ClientTransport()

Method Detail

TCP

public static ClientTransport TCP()

httpsProxy

public static ClientTransport httpsProxy(java.net.InetSocketAddress proxyAddress)

Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method.

An HTTP(S) proxy is a proxy that will create one TCP connection to the HTTP(S) proxy for each target connection. The proxy transparently forwards the TCP connection to the target host.

For more information about HTTP CONNECT tunnelling see https://tools.ietf.org/html/rfc7231#section-4.3.6.

Parameters:

proxyAddress - (undocumented)

Returns:

(undocumented)

httpsProxy

public static ClientTransport httpsProxy(org.apache.pekko.actor.ActorSystem system)

Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method.

Pulls the host/port pair from the application.conf: pekko.client.proxy.https.{host, port}

Parameters:

system - (undocumented)

Returns:

(undocumented)

httpsProxy

public static ClientTransport httpsProxy(java.net.InetSocketAddress proxyAddress,
                                         HttpCredentials proxyCredentials)

Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method. This call also takes HttpCredentials to base proxy credentials along with the request.

An HTTP(S) proxy is a proxy that will create one TCP connection to the HTTP(S) proxy for each target connection. The proxy transparently forwards the TCP connection to the target host.

For more information about HTTP CONNECT tunnelling see https://tools.ietf.org/html/rfc7231#section-4.3.6.

Parameters:

proxyAddress - (undocumented)

proxyCredentials - (undocumented)

Returns:

(undocumented)

httpsProxy

public static ClientTransport httpsProxy(HttpCredentials proxyCredentials,
                                         org.apache.pekko.actor.ActorSystem system)

Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method. This method also takes HttpCredentials in order to pass along to the proxy.

Pulls the host/port pair from the application.conf: pekko.client.proxy.https.{host, port}

Parameters:

proxyCredentials - (undocumented)

system - (undocumented)

Returns:

(undocumented)

withCustomResolver

public static ClientTransport withCustomResolver(java.util.function.BiFunction<java.lang.String,java.lang.Object,java.util.concurrent.CompletionStage<java.net.InetSocketAddress>> lookup)

Returns a ClientTransport that allows to customize host name resolution.

Parameters:

lookup - A function that will be called with hostname and port and that should (potentially asynchronously resolve the given host/port to an InetSocketAddress

Returns:

(undocumented)

fromScala

public static ClientTransport fromScala(ClientTransport scalaTransport)

toScala

public static ClientTransport toScala(ClientTransport javaTransport)

connectTo

public abstract org.apache.pekko.stream.javadsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,java.util.concurrent.CompletionStage<OutgoingConnection>> connectTo(java.lang.String host,
                                                                                                                                                                                           int port,
                                                                                                                                                                                           ClientConnectionSettings settings,
                                                                                                                                                                                           org.apache.pekko.actor.ActorSystem system)