Package org.apache.pekko.http.javadsl.server.directives

Class BasicDirectives

java.lang.Object
org.apache.pekko.http.javadsl.server.directives.BasicDirectives
Direct Known Subclasses:
CacheConditionDirectives
public abstract class BasicDirectives extends Object

  • Constructor Details

    • BasicDirectives

      public BasicDirectives()

  • Method Details

    • cancelRejection

      public Route cancelRejection(Rejection rejection, Supplier<Route> inner)
      Adds a TransformationRejection cancelling all rejections equal to the given one to the list of rejections potentially coming back from the inner route.
      Parameters:
      rejection - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)

    • cancelRejections

      public Route cancelRejections(Iterable<Class<?>> classes, Supplier<Route> inner)
      Adds a TransformationRejection cancelling all rejections of one of the given classes to the list of rejections potentially coming back from the inner route.
      Parameters:
      classes - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)

    • cancelRejections

      public Route cancelRejections(Predicate<Rejection> filter, Supplier<Route> inner)
      Adds a TransformationRejection cancelling all rejections for which the given filter function returns true to the list of rejections potentially coming back from the inner route.
      Parameters:
      filter - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)

    • extract

      public <T> Route extract(Function<RequestContext,T> extract, Function<T,Route> inner)
      Extracts a single value using the given function.
      Parameters:
      extract - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractActorSystem

      public Route extractActorSystem(Function<org.apache.pekko.actor.ActorSystem,Route> inner)
      Extracts the pekko.actor.ActorSystem if the Materializer is available. Otherwise throws an exception as it won't be able to extract the system from arbitrary materializers.
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractDataBytes

      public RouteAdapter extractDataBytes(Function<org.apache.pekko.stream.javadsl.Source<org.apache.pekko.util.ByteString,Object>,Route> inner)
      Extracts the entities dataBytes pekko.stream.javadsl.Source from the pekko.http.javadsl.server.RequestContext.
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractEntity

      public Route extractEntity(Function<RequestEntity,Route> inner)
      Extracts the current http request entity.
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractExecutionContext

      public Route extractExecutionContext(Function<scala.concurrent.ExecutionContextExecutor,Route> inner)
      Extracts the ExecutionContextExecutor from the RequestContext.
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractLog

      public Route extractLog(Function<org.apache.pekko.event.LoggingAdapter,Route> inner)
      Extracts the LoggingAdapter
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractMatchedPath

      public RouteAdapter extractMatchedPath(Function<String,Route> inner)
      Extracts the already matched path from the RequestContext.
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractMaterializer

      public Route extractMaterializer(Function<org.apache.pekko.stream.Materializer,Route> inner)
      Extracts the Materializer from the RequestContext.
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractParserSettings

      public RouteAdapter extractParserSettings(Function<ParserSettings,Route> inner)
      Extracts the pekko.http.javadsl.settings.ParserSettings from the pekko.http.javadsl.server.RequestContext.
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractRequest

      public RouteAdapter extractRequest(Function<HttpRequest,Route> inner)
      Extracts the current HttpRequest instance.
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractRequestContext

      public RouteAdapter extractRequestContext(Function<RequestContext,Route> inner)
      Extracts the pekko.http.javadsl.server.RequestContext itself.
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractRequestEntity

      public Route extractRequestEntity(Function<RequestEntity,Route> inner)
      Extracts the pekko.http.javadsl.model.RequestEntity from the pekko.http.javadsl.server.RequestContext.
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractSettings

      public RouteAdapter extractSettings(Function<RoutingSettings,Route> inner)
      Extracts the RoutingSettings from the pekko.http.javadsl.server.RequestContext.
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractStrictEntity

      public Route extractStrictEntity(scala.concurrent.duration.FiniteDuration timeout, Function<HttpEntity.Strict,Route> inner)
      Deprecated.
      As of 1.3.0, use the overloaded method taking a java.time.Duration instead.
      WARNING: This will read the entire request entity into memory and effectively disable streaming.

      To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the pekko.http.parsing.max-to-strict-bytes configuration setting.

      Converts the HttpEntity from the pekko.http.javadsl.server.RequestContext into an pekko.http.javadsl.model.HttpEntity.Strict and extracts it, or fails the route if unable to drain the entire request body within the timeout.

      Parameters:
      timeout - The directive is failed if the stream isn't completed after the given timeout.
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractStrictEntity

      public Route extractStrictEntity(Duration timeout, Function<HttpEntity.Strict,Route> inner)
      WARNING: This will read the entire request entity into memory and effectively disable streaming.

      To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the pekko.http.parsing.max-to-strict-bytes configuration setting.

      Converts the HttpEntity from the pekko.http.javadsl.server.RequestContext into an pekko.http.javadsl.model.HttpEntity.Strict and extracts it, or fails the route if unable to drain the entire request body within the timeout.

      Parameters:
      timeout - The directive is failed if the stream isn't completed after the given timeout.
      inner - (undocumented)
      Returns:
      (undocumented)
      Since:
      1.3.0

    • extractStrictEntity

      public Route extractStrictEntity(scala.concurrent.duration.FiniteDuration timeout, long maxBytes, Function<HttpEntity.Strict,Route> inner)
      Deprecated.
      As of 1.3.0, use the overloaded method taking a java.time.Duration instead.
      WARNING: This will read the entire request entity into memory and effectively disable streaming.

      To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the pekko.http.parsing.max-to-strict-bytes configuration setting.

      Converts the HttpEntity from the pekko.http.javadsl.server.RequestContext into an pekko.http.javadsl.model.HttpEntity.Strict and extracts it, or fails the route if unable to drain the entire request body within the timeout.

      Parameters:
      timeout - The directive is failed if the stream isn't completed after the given timeout.
      maxBytes - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractStrictEntity

      public Route extractStrictEntity(Duration timeout, long maxBytes, Function<HttpEntity.Strict,Route> inner)
      WARNING: This will read the entire request entity into memory and effectively disable streaming.

      To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the pekko.http.parsing.max-to-strict-bytes configuration setting.

      Converts the HttpEntity from the pekko.http.javadsl.server.RequestContext into an pekko.http.javadsl.model.HttpEntity.Strict and extracts it, or fails the route if unable to drain the entire request body within the timeout.

      Parameters:
      timeout - The directive is failed if the stream isn't completed after the given timeout.
      maxBytes - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)
      Since:
      1.3.0

    • extractUnmatchedPath

      public RouteAdapter extractUnmatchedPath(Function<String,Route> inner)
      Extracts the yet unmatched path from the RequestContext.
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • extractUri

      public RouteAdapter extractUri(Function<Uri,Route> inner)
      Extracts the complete request URI.
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • mapInnerRoute

      public Route mapInnerRoute(Function<Route,Route> f, Supplier<Route> inner)

    • mapRejections

      public Route mapRejections(Function<List<Rejection>,List<Rejection>> f, Supplier<Route> inner)

    • mapRequest

      public Route mapRequest(Function<HttpRequest,HttpRequest> f, Supplier<Route> inner)

    • mapRequestContext

      public Route mapRequestContext(Function<RequestContext,RequestContext> f, Supplier<Route> inner)

    • mapResponse

      public Route mapResponse(Function<HttpResponse,HttpResponse> f, Supplier<Route> inner)

    • mapResponseEntity

      public Route mapResponseEntity(Function<ResponseEntity,ResponseEntity> f, Supplier<Route> inner)

    • mapResponseHeaders

      public Route mapResponseHeaders(Function<List<HttpHeader>,List<HttpHeader>> f, Supplier<Route> inner)

    • mapRouteResult

      public Route mapRouteResult(Function<RouteResult,RouteResult> f, Supplier<Route> inner)

    • mapRouteResultFuture

      public Route mapRouteResultFuture(Function<CompletionStage<RouteResult>,CompletionStage<RouteResult>> f, Supplier<Route> inner)

    • mapRouteResultPF

      public Route mapRouteResultPF(scala.PartialFunction<RouteResult,RouteResult> f, Supplier<Route> inner)

    • mapRouteResultWith

      public Route mapRouteResultWith(Function<RouteResult,CompletionStage<RouteResult>> f, Supplier<Route> inner)

    • mapRouteResultWithPF

      public Route mapRouteResultWithPF(scala.PartialFunction<RouteResult,CompletionStage<RouteResult>> f, Supplier<Route> inner)

    • mapSettings

      public Route mapSettings(Function<RoutingSettings,RoutingSettings> f, Supplier<Route> inner)
      Runs the inner route with settings mapped by the given function.
      Parameters:
      f - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)

    • mapUnmatchedPath

      public Route mapUnmatchedPath(Function<String,String> f, Supplier<Route> inner)
      Transforms the unmatchedPath of the RequestContext using the given function.
      Parameters:
      f - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)

    • pass

      public Route pass(Supplier<Route> inner)
      Always passes the request on to its inner route (i.e. does nothing with the request or the response).
      Parameters:
      inner - (undocumented)
      Returns:
      (undocumented)

    • provide

      public <T> Route provide(T t, Function<T,Route> inner)
      Injects the given value into a directive.
      Parameters:
      t - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)

    • recoverRejections

      public Route recoverRejections(Function<Iterable<Rejection>,RouteResult> f, Supplier<Route> inner)

    • recoverRejectionsWith

      public Route recoverRejectionsWith(Function<Iterable<Rejection>,CompletionStage<RouteResult>> f, Supplier<Route> inner)

    • toStrictEntity

      public Route toStrictEntity(scala.concurrent.duration.FiniteDuration timeout, Supplier<Route> inner)
      Deprecated.
      As of 1.3.0, use the overloaded method taking a java.time.Duration instead.
      WARNING: This will read the entire request entity into memory and effectively disable streaming.

      To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the pekko.http.parsing.max-to-strict-bytes configuration setting.

      Extracts the pekko.http.javadsl.server.RequestContext itself with the strict HTTP entity, or fails the route if unable to drain the entire request body within the timeout.

      Parameters:
      timeout - The directive is failed if the stream isn't completed after the given timeout.
      inner - (undocumented)
      Returns:
      (undocumented)

    • toStrictEntity

      public Route toStrictEntity(Duration timeout, Supplier<Route> inner)
      WARNING: This will read the entire request entity into memory and effectively disable streaming.

      To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the pekko.http.parsing.max-to-strict-bytes configuration setting.

      Extracts the pekko.http.javadsl.server.RequestContext itself with the strict HTTP entity, or fails the route if unable to drain the entire request body within the timeout.

      Parameters:
      timeout - The directive is failed if the stream isn't completed after the given timeout.
      inner - (undocumented)
      Returns:
      (undocumented)
      Since:
      1.3.0

    • toStrictEntity

      public Route toStrictEntity(scala.concurrent.duration.FiniteDuration timeout, long maxBytes, Supplier<Route> inner)
      Deprecated.
      As of 1.3.0, use the overloaded method taking a java.time.Duration instead.
      WARNING: This will read the entire request entity into memory and effectively disable streaming.

      To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the pekko.http.parsing.max-to-strict-bytes configuration setting.

      Extracts the pekko.http.javadsl.server.RequestContext itself with the strict HTTP entity, or fails the route if unable to drain the entire request body within the timeout.

      Parameters:
      timeout - The directive is failed if the stream isn't completed after the given timeout.
      maxBytes - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)

    • toStrictEntity

      public Route toStrictEntity(Duration timeout, long maxBytes, Supplier<Route> inner)
      WARNING: This will read the entire request entity into memory and effectively disable streaming.

      To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the pekko.http.parsing.max-to-strict-bytes configuration setting.

      Extracts the pekko.http.javadsl.server.RequestContext itself with the strict HTTP entity, or fails the route if unable to drain the entire request body within the timeout.

      Parameters:
      timeout - The directive is failed if the stream isn't completed after the given timeout.
      maxBytes - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)
      Since:
      1.3.0

    • withExecutionContext

      public Route withExecutionContext(scala.concurrent.ExecutionContextExecutor ec, Supplier<Route> inner)
      Runs its inner route with the given alternative ExecutionContextExecutor.
      Parameters:
      ec - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)

    • withLog

      public Route withLog(org.apache.pekko.event.LoggingAdapter log, Supplier<Route> inner)
      Runs its inner route with the given alternative LoggingAdapter.
      Parameters:
      log - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)

    • withMaterializer

      public Route withMaterializer(org.apache.pekko.stream.Materializer mat, Supplier<Route> inner)
      Runs its inner route with the given alternative pekko.stream.Materializer.
      Parameters:
      mat - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)

    • withSettings

      public Route withSettings(RoutingSettings s, Supplier<Route> inner)
      Runs its inner route with the given alternative RoutingSettings.
      Parameters:
      s - (undocumented)
      inner - (undocumented)
      Returns:
      (undocumented)