Package org.apache.pekko.http.scaladsl

Class HttpExt

java.lang.Object
org.apache.pekko.http.scaladsl.HttpExt
All Implemented Interfaces:
org.apache.pekko.actor.Extension
public class HttpExt extends Object implements org.apache.pekko.actor.Extension
Pekko extension for HTTP which serves as the main entry point into pekko-http.

Use as Http().bindAndHandle etc. with an implicit ActorSystem in scope.

  • Constructor Details

    • HttpExt

      public HttpExt(com.typesafe.config.Config config, org.apache.pekko.actor.ExtendedActorSystem system)

  • Method Details

    • bindAndHandleAsyncImpl

      public scala.concurrent.Future<Http.ServerBinding> bindAndHandleAsyncImpl(scala.Function1<HttpRequest,scala.concurrent.Future<HttpResponse>> handler, String interface_, int port, ConnectionContext connectionContext, ServerSettings settings, int parallelism, org.apache.pekko.event.LoggingAdapter log, org.apache.pekko.stream.Materializer fm)

    • bindAndHandleImpl

      public scala.concurrent.Future<Http.ServerBinding> bindAndHandleImpl(org.apache.pekko.stream.scaladsl.Flow<HttpRequest,HttpResponse,Object> handler, String interface_, int port, ConnectionContext connectionContext, ServerSettings settings, org.apache.pekko.event.LoggingAdapter log, org.apache.pekko.stream.Materializer fm)
      Convenience method which starts a new HTTP server at the given endpoint and uses the given handler pekko.stream.scaladsl.Flow for processing all incoming connections.

      The number of concurrently accepted connections can be configured by overriding the pekko.http.server.max-connections setting. Please see the documentation in the reference.conf for more information about what kind of guarantees to expect.

      To configure additional settings for a server started using this method, use the pekko.http.server config section or pass in a pekko.http.scaladsl.settings.ServerSettings explicitly.

      Parameters:
      handler - (undocumented)
      interface_ - (undocumented)
      port - (undocumented)
      connectionContext - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      fm - (undocumented)
      Returns:
      (undocumented)

    • bindImpl

      public org.apache.pekko.stream.scaladsl.Source<Http.IncomingConnection,scala.concurrent.Future<Http.ServerBinding>> bindImpl(String interface_, int port, ConnectionContext connectionContext, ServerSettings settings, org.apache.pekko.event.LoggingAdapter log)
      Creates a pekko.stream.scaladsl.Source of pekko.http.scaladsl.Http.IncomingConnection instances which represents a prospective HTTP server binding on the given endpoint.

      If the given port is 0 the resulting source can be materialized several times. Each materialization will then be assigned a new local port by the operating system, which can then be retrieved by the materialized pekko.http.scaladsl.Http.ServerBinding.

      If the given port is non-zero subsequent materialization attempts of the produced source will immediately fail, unless the first materialization has already been unbound. Unbinding can be triggered via the materialized pekko.http.scaladsl.Http.ServerBinding.

      If an ConnectionContext is given it will be used for setting up TLS encryption on the binding. Otherwise the binding will be unencrypted.

      If no port is explicitly given (or the port value is negative) the protocol's default port will be used, which is 80 for HTTP and 443 for HTTPS.

      To configure additional settings for a server started using this method, use the pekko.http.server config section or pass in a pekko.http.scaladsl.settings.ServerSettings explicitly.

      Parameters:
      interface_ - (undocumented)
      port - (undocumented)
      connectionContext - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      Returns:
      (undocumented)

    • cachedHostConnectionPool

      public <T> org.apache.pekko.stream.scaladsl.Flow<scala.Tuple2<HttpRequest,T>,scala.Tuple2<scala.util.Try<HttpResponse>,T>,Http.HostConnectionPool> cachedHostConnectionPool(String host, int port, ConnectionPoolSettings settings, org.apache.pekko.event.LoggingAdapter log)
      Returns a pekko.stream.scaladsl.Flow which dispatches incoming HTTP requests to the per-ActorSystem pool of outgoing HTTP connections to the given target host endpoint. For every ActorSystem, target host and pool configuration a separate connection pool is maintained. The HTTP layer transparently manages idle shutdown and restarting of connections pools as configured. The returned pekko.stream.scaladsl.Flow instances therefore remain valid throughout the lifetime of the application.

      The internal caching logic guarantees that there will never be more than a single pool running for the given target host endpoint and configuration (in this ActorSystem).

      Since the underlying transport usually comprises more than a single connection the produced flow might generate responses in an order that doesn't directly match the consumed requests. For example, if two requests A and B enter the flow in that order the response for B might be produced before the response for A. In order to allow for easy response-to-request association the flow takes in a custom, opaque context object of type T from the application which is emitted together with the corresponding response.

      To configure additional settings for the pool (and requests made using it), use the pekko.http.host-connection-pool config section or pass in a ConnectionPoolSettings explicitly.

      Parameters:
      host - (undocumented)
      port - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      Returns:
      (undocumented)

    • cachedHostConnectionPoolHttps

      public <T> org.apache.pekko.stream.scaladsl.Flow<scala.Tuple2<HttpRequest,T>,scala.Tuple2<scala.util.Try<HttpResponse>,T>,Http.HostConnectionPool> cachedHostConnectionPoolHttps(String host, int port, HttpsConnectionContext connectionContext, ConnectionPoolSettings settings, org.apache.pekko.event.LoggingAdapter log)
      Same as cachedHostConnectionPool(java.lang.String, int, org.apache.pekko.http.scaladsl.settings.ConnectionPoolSettings, org.apache.pekko.event.LoggingAdapter) but for encrypted (HTTPS) connections.

      If an explicit ConnectionContext is given then it rather than the configured default ConnectionContext will be used for encryption on the connections.

      To configure additional settings for the pool (and requests made using it), use the pekko.http.host-connection-pool config section or pass in a ConnectionPoolSettings explicitly.

      Parameters:
      host - (undocumented)
      port - (undocumented)
      connectionContext - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      Returns:
      (undocumented)

    • clientLayer

      public org.apache.pekko.stream.scaladsl.BidiFlow<HttpRequest,org.apache.pekko.stream.TLSProtocol.SslTlsOutbound,org.apache.pekko.stream.TLSProtocol.SslTlsInbound,HttpResponse,org.apache.pekko.NotUsed> clientLayer(Host hostHeader)
      Constructs a pekko.http.scaladsl.Http.ClientLayer stage using the configured default pekko.http.scaladsl.settings.ClientConnectionSettings, configured using the pekko.http.client config section.
      Parameters:
      hostHeader - (undocumented)
      Returns:
      (undocumented)

    • clientLayer

      public org.apache.pekko.stream.scaladsl.BidiFlow<HttpRequest,org.apache.pekko.stream.TLSProtocol.SslTlsOutbound,org.apache.pekko.stream.TLSProtocol.SslTlsInbound,HttpResponse,org.apache.pekko.NotUsed> clientLayer(Host hostHeader, ClientConnectionSettings settings, org.apache.pekko.event.LoggingAdapter log)
      Constructs a pekko.http.scaladsl.Http.ClientLayer stage using the given pekko.http.scaladsl.settings.ClientConnectionSettings.
      Parameters:
      hostHeader - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      Returns:
      (undocumented)

    • connectionTo

      public OutgoingConnectionBuilder connectionTo(String host)
      Creates a builder which will create a single connection to a host every time the built flow is materialized. There is no pooling and you are yourself responsible for lifecycle management of the connection. For a more convenient Request level API see singleRequest()

      Parameters:
      host - (undocumented)
      Returns:
      A builder to configure more specific setup for the connection and then build a Flow[Request, Response, Future[OutgoingConnection}.

    • dateHeaderRendering

      public DateHeaderRendering dateHeaderRendering()

    • defaultClientHttpsContext

      public HttpsConnectionContext defaultClientHttpsContext()
      Gets the current default client-side HttpsConnectionContext. Defaults used here can be configured using ssl-config or the context can be replaced using setDefaultClientHttpsContext(org.apache.pekko.http.scaladsl.HttpsConnectionContext)
      Returns:
      (undocumented)

    • newHostConnectionPool

      public <T> org.apache.pekko.stream.scaladsl.Flow<scala.Tuple2<HttpRequest,T>,scala.Tuple2<scala.util.Try<HttpResponse>,T>,Http.HostConnectionPool> newHostConnectionPool(String host, int port, ConnectionPoolSettings settings, org.apache.pekko.event.LoggingAdapter log, org.apache.pekko.stream.Materializer fm)
      Starts a new connection pool to the given host and configuration and returns a pekko.stream.scaladsl.Flow which dispatches the requests from all its materializations across this pool. While the started host connection pool internally shuts itself down automatically after the configured idle timeout it will spin itself up again if more requests arrive from an existing or a new client flow materialization. The returned flow therefore remains usable for the full lifetime of the application.

      Since the underlying transport usually comprises more than a single connection the produced flow might generate responses in an order that doesn't directly match the consumed requests. For example, if two requests A and B enter the flow in that order the response for B might be produced before the response for A. In order to allow for easy response-to-request association the flow takes in a custom, opaque context object of type T from the application which is emitted together with the corresponding response.

      To configure additional settings for the pool (and requests made using it), use the pekko.http.host-connection-pool config section or pass in a ConnectionPoolSettings explicitly.

      Parameters:
      host - (undocumented)
      port - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      fm - (undocumented)
      Returns:
      (undocumented)

    • newHostConnectionPool

      public <T> org.apache.pekko.stream.scaladsl.Flow<scala.Tuple2<HttpRequest,T>,scala.Tuple2<scala.util.Try<HttpResponse>,T>,Http.HostConnectionPool> newHostConnectionPool(HostConnectionPoolSetup setup, org.apache.pekko.stream.Materializer fm)
      INTERNAL API
      Parameters:
      setup - (undocumented)
      fm - (undocumented)
      Returns:
      (undocumented)

    • newHostConnectionPoolHttps

      public <T> org.apache.pekko.stream.scaladsl.Flow<scala.Tuple2<HttpRequest,T>,scala.Tuple2<scala.util.Try<HttpResponse>,T>,Http.HostConnectionPool> newHostConnectionPoolHttps(String host, int port, HttpsConnectionContext connectionContext, ConnectionPoolSettings settings, org.apache.pekko.event.LoggingAdapter log, org.apache.pekko.stream.Materializer fm)
      Same as newHostConnectionPool(java.lang.String, int, org.apache.pekko.http.scaladsl.settings.ConnectionPoolSettings, org.apache.pekko.event.LoggingAdapter, org.apache.pekko.stream.Materializer) but for encrypted (HTTPS) connections.

      If an explicit ConnectionContext is given then it rather than the configured default ConnectionContext will be used for encryption on the connections.

      To configure additional settings for the pool (and requests made using it), use the pekko.http.host-connection-pool config section or pass in a ConnectionPoolSettings explicitly.

      Parameters:
      host - (undocumented)
      port - (undocumented)
      connectionContext - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      fm - (undocumented)
      Returns:
      (undocumented)

    • newServerAt

      public ServerBuilder newServerAt(String interface_, int port)
      Main entry point to create a server binding.

      Parameters:
      interface - The interface to bind to.
      port - The port to bind to or 0 if the port should be automatically assigned.
      interface_ - (undocumented)
      Returns:
      (undocumented)

    • outgoingConnection

      public org.apache.pekko.stream.scaladsl.Flow<HttpRequest,HttpResponse,scala.concurrent.Future<Http.OutgoingConnection>> outgoingConnection(String host, int port, scala.Option<InetSocketAddress> localAddress, ClientConnectionSettings settings, org.apache.pekko.event.LoggingAdapter log)
      Creates a pekko.stream.scaladsl.Flow representing a prospective HTTP client connection to the given endpoint. Every materialization of the produced flow will attempt to establish a new outgoing connection.

      To configure additional settings for requests made using this method, use the pekko.http.client config section or pass in a pekko.http.scaladsl.settings.ClientConnectionSettings explicitly.

      Prefer connectionTo(java.lang.String) over this method.

      Parameters:
      host - (undocumented)
      port - (undocumented)
      localAddress - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      Returns:
      (undocumented)

    • outgoingConnectionHttps

      public org.apache.pekko.stream.scaladsl.Flow<HttpRequest,HttpResponse,scala.concurrent.Future<Http.OutgoingConnection>> outgoingConnectionHttps(String host, int port, HttpsConnectionContext connectionContext, scala.Option<InetSocketAddress> localAddress, ClientConnectionSettings settings, org.apache.pekko.event.LoggingAdapter log)
      Same as outgoingConnection(java.lang.String, int, scala.Option<java.net.InetSocketAddress>, org.apache.pekko.http.scaladsl.settings.ClientConnectionSettings, org.apache.pekko.event.LoggingAdapter) but for encrypted (HTTPS) connections.

      If an explicit HttpsConnectionContext is given then it rather than the configured default HttpsConnectionContext will be used for encryption on the connection.

      To configure additional settings for requests made using this method, use the pekko.http.client config section or pass in a pekko.http.scaladsl.settings.ClientConnectionSettings explicitly.

      Prefer connectionTo(java.lang.String) over this method.

      Parameters:
      host - (undocumented)
      port - (undocumented)
      connectionContext - (undocumented)
      localAddress - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      Returns:
      (undocumented)

    • outgoingConnectionUsingContext

      public org.apache.pekko.stream.scaladsl.Flow<HttpRequest,HttpResponse,scala.concurrent.Future<Http.OutgoingConnection>> outgoingConnectionUsingContext(String host, int port, ConnectionContext connectionContext, ClientConnectionSettings settings, org.apache.pekko.event.LoggingAdapter log)
      Similar to outgoingConnection but allows to specify a user-defined context to run the connection on.

      Depending on the kind of ConnectionContext the implementation will add TLS between the given transport and the HTTP implementation

      To configure additional settings for requests made using this method, use the pekko.http.client config section or pass in a pekko.http.scaladsl.settings.ClientConnectionSettings explicitly.

      Prefer connectionTo(java.lang.String) over this method.

      Parameters:
      host - (undocumented)
      port - (undocumented)
      connectionContext - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      Returns:
      (undocumented)

    • poolMaster

      public PoolMaster poolMaster()

    • poolSize

      public scala.concurrent.Future<Object> poolSize()
      INTERNAL API

      For testing only

      Returns:
      (undocumented)

    • serverLayer

      public org.apache.pekko.stream.scaladsl.BidiFlow<HttpResponse,org.apache.pekko.stream.TLSProtocol.SslTlsOutbound,org.apache.pekko.stream.TLSProtocol.SslTlsInbound,HttpRequest,org.apache.pekko.NotUsed> serverLayer(ServerSettings settings, scala.Option<InetSocketAddress> remoteAddress, org.apache.pekko.event.LoggingAdapter log, boolean isSecureConnection)
      Constructs a pekko.http.scaladsl.Http.ServerLayer stage using the given pekko.http.scaladsl.settings.ServerSettings. The returned pekko.stream.scaladsl.BidiFlow isn't reusable and can only be materialized once.
      Parameters:
      settings - (undocumented)
      remoteAddress - (undocumented)
      log - (undocumented)
      isSecureConnection - (undocumented)
      Returns:
      (undocumented)

    • setDefaultClientHttpsContext

      public void setDefaultClientHttpsContext(HttpsConnectionContext context)
      Sets the default client-side HttpsConnectionContext.
      Parameters:
      context - (undocumented)

    • shutdownAllConnectionPools

      public scala.concurrent.Future<scala.runtime.BoxedUnit> shutdownAllConnectionPools()
      Triggers an orderly shutdown of all host connections pools currently maintained by the pekko.actor.ActorSystem. The returned future is completed when all pools that were live at the time of this method call have completed their shutdown process.

      If existing pool client flows are re-used or new ones materialized concurrently with or after this method call the respective connection pools will be restarted and not contribute to the returned future.

      Returns:
      (undocumented)

    • singleRequest

      public scala.concurrent.Future<HttpResponse> singleRequest(HttpRequest request, HttpsConnectionContext connectionContext, ConnectionPoolSettings settings, org.apache.pekko.event.LoggingAdapter log)
      Fires a single pekko.http.scaladsl.model.HttpRequest across the (cached) host connection pool for the request's effective URI to produce a response future.

      If an explicit ConnectionContext is given then it rather than the configured default ConnectionContext will be used for setting up the HTTPS connection pool, if the request is targeted towards an https endpoint.

      Note that the request must have an absolute URI, otherwise the future will be completed with an error.

      Parameters:
      request - (undocumented)
      connectionContext - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      Returns:
      (undocumented)

    • singleWebSocketRequest

      public <T> scala.Tuple2<scala.concurrent.Future<WebSocketUpgradeResponse>,T> singleWebSocketRequest(WebSocketRequest request, org.apache.pekko.stream.scaladsl.Flow<Message,Message,T> clientFlow, ConnectionContext connectionContext, scala.Option<InetSocketAddress> localAddress, ClientConnectionSettings settings, org.apache.pekko.event.LoggingAdapter log, org.apache.pekko.stream.Materializer mat)
      Runs a single WebSocket conversation given a Uri and a flow that represents the client side of the WebSocket conversation.
      Parameters:
      request - (undocumented)
      clientFlow - (undocumented)
      connectionContext - (undocumented)
      localAddress - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      mat - (undocumented)
      Returns:
      (undocumented)

    • sslTlsClientStage

      public org.apache.pekko.stream.scaladsl.BidiFlow<org.apache.pekko.stream.TLSProtocol.SslTlsOutbound,org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.stream.TLSProtocol.SslTlsInbound,org.apache.pekko.NotUsed> sslTlsClientStage(ConnectionContext connectionContext, String host, int port)
      Creates real or placebo SslTls stage based on if ConnectionContext is HTTPS or not.

    • sslTlsServerStage

      public org.apache.pekko.stream.scaladsl.BidiFlow<org.apache.pekko.stream.TLSProtocol.SslTlsOutbound,org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.stream.TLSProtocol.SslTlsInbound,org.apache.pekko.NotUsed> sslTlsServerStage(ConnectionContext connectionContext)

    • superPool

      public <T> org.apache.pekko.stream.scaladsl.Flow<scala.Tuple2<HttpRequest,T>,scala.Tuple2<scala.util.Try<HttpResponse>,T>,org.apache.pekko.NotUsed> superPool(HttpsConnectionContext connectionContext, ConnectionPoolSettings settings, org.apache.pekko.event.LoggingAdapter log)
      Creates a new "super connection pool flow", which routes incoming requests to a (cached) host connection pool depending on their respective effective URIs. Note that incoming requests must have an absolute URI.

      If an explicit ConnectionContext is given then it rather than the configured default ConnectionContext will be used for setting up HTTPS connection pools, if required.

      Since the underlying transport usually comprises more than a single connection the produced flow might generate responses in an order that doesn't directly match the consumed requests. For example, if two requests A and B enter the flow in that order the response for B might be produced before the response for A. In order to allow for easy response-to-request association the flow takes in a custom, opaque context object of type T from the application which is emitted together with the corresponding response.

      To configure additional settings for the pool (and requests made using it), use the pekko.http.host-connection-pool config section or pass in a ConnectionPoolSettings explicitly.

      Parameters:
      connectionContext - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      Returns:
      (undocumented)

    • system

      public org.apache.pekko.actor.ExtendedActorSystem system()

    • webSocketClientFlow

      public org.apache.pekko.stream.scaladsl.Flow<Message,Message,scala.concurrent.Future<WebSocketUpgradeResponse>> webSocketClientFlow(WebSocketRequest request, ConnectionContext connectionContext, scala.Option<InetSocketAddress> localAddress, ClientConnectionSettings settings, org.apache.pekko.event.LoggingAdapter log)
      Constructs a flow that once materialized establishes a WebSocket connection to the given Uri.

      The layer is not reusable and must only be materialized once.

      Parameters:
      request - (undocumented)
      connectionContext - (undocumented)
      localAddress - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      Returns:
      (undocumented)

    • webSocketClientLayer

      public org.apache.pekko.stream.scaladsl.BidiFlow<Message,org.apache.pekko.stream.TLSProtocol.SslTlsOutbound,org.apache.pekko.stream.TLSProtocol.SslTlsInbound,Message,scala.concurrent.Future<WebSocketUpgradeResponse>> webSocketClientLayer(WebSocketRequest request, ClientConnectionSettings settings, org.apache.pekko.event.LoggingAdapter log)
      Constructs a pekko.http.scaladsl.Http.WebSocketClientLayer stage using the configured default pekko.http.scaladsl.settings.ClientConnectionSettings, configured using the pekko.http.client config section.

      The layer is not reusable and must only be materialized once.

      Parameters:
      request - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      Returns:
      (undocumented)