org.apache.pekko.http.scaladsl.server

Class Route

java.lang.Object

org.apache.pekko.http.scaladsl.server.Route

public class Route
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Route()

Method Summary

Modifier and Type	Method and Description
static scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>>	apply(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> f) Helper for constructing a Route from a function literal.
static scala.Function1<HttpRequest,scala.concurrent.Future<HttpResponse>>	asyncHandler(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route, RoutingSettings routingSettings, ParserSettings parserSettings, org.apache.pekko.stream.Materializer materializer, RoutingLog routingLog, scala.concurrent.ExecutionContextExecutor executionContext, RejectionHandler rejectionHandler, ExceptionHandler exceptionHandler) Deprecated. Use `toFunction` instead, which only requires an implicit ActorSystem and no rejection/exception handlers. Use directives to specify custom exceptions or rejection handlers. Since Akka HTTP 10.2.0.
static org.apache.pekko.stream.scaladsl.Flow<HttpRequest,HttpResponse,org.apache.pekko.NotUsed>	handlerFlow(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route, RoutingSettings routingSettings, ParserSettings parserSettings, org.apache.pekko.stream.Materializer materializer, RoutingLog routingLog, scala.concurrent.ExecutionContextExecutor executionContext, RejectionHandler rejectionHandler, ExceptionHandler exceptionHandler) Deprecated. Replaced by `toFlow` that takes an implicit ActorSystem. Since Akka HTTP 10.2.0.
static scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>>	seal(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route, RoutingSettings routingSettings, ParserSettings parserSettings, RejectionHandler rejectionHandler, ExceptionHandler exceptionHandler) "Seals" a route by wrapping it with default exception handling and rejection conversion.
static org.apache.pekko.stream.scaladsl.Flow<HttpRequest,HttpResponse,org.apache.pekko.NotUsed>	toFlow(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route, org.apache.pekko.actor.ClassicActorSystemProvider system) Turns a Route into a server flow.
static scala.Function1<HttpRequest,scala.concurrent.Future<HttpResponse>>	toFunction(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route, org.apache.pekko.actor.ClassicActorSystemProvider system)

Methods inherited from class java.lang.Object

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

Constructor Detail

Route

public Route()

Method Detail

apply

public static scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> apply(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> f)

Helper for constructing a Route from a function literal.

Parameters:

f - (undocumented)

Returns:

(undocumented)

seal

public static scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> seal(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route,
                                                                                        RoutingSettings routingSettings,
                                                                                        ParserSettings parserSettings,
                                                                                        RejectionHandler rejectionHandler,
                                                                                        ExceptionHandler exceptionHandler)

"Seals" a route by wrapping it with default exception handling and rejection conversion.

A sealed route has these properties: - The result of the route will always be a complete response, i.e. the result of the future is a Success(RouteResult.Complete(response)), never a failed future and never a rejected route. These will be already be handled using the implicitly given RejectionHandler and ExceptionHandler (or the default handlers if none are given or can be found implicitly). - Consequently, no route alternatives will be tried that were combined with this route using the ~ on routes or the Directive.| operator on directives.

Parameters:

route - (undocumented)

routingSettings - (undocumented)

parserSettings - (undocumented)

rejectionHandler - (undocumented)

exceptionHandler - (undocumented)

Returns:

(undocumented)

toFlow

public static org.apache.pekko.stream.scaladsl.Flow<HttpRequest,HttpResponse,org.apache.pekko.NotUsed> toFlow(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route,
                                                                                                              org.apache.pekko.actor.ClassicActorSystemProvider system)

Turns a Route into a server flow.

This conversion is also implicitly available wherever a Route is used through RouteResult#routeToFlow.

Parameters:

route - (undocumented)

system - (undocumented)

Returns:

(undocumented)

handlerFlow

public static org.apache.pekko.stream.scaladsl.Flow<HttpRequest,HttpResponse,org.apache.pekko.NotUsed> handlerFlow(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route,
                                                                                                                   RoutingSettings routingSettings,
                                                                                                                   ParserSettings parserSettings,
                                                                                                                   org.apache.pekko.stream.Materializer materializer,
                                                                                                                   RoutingLog routingLog,
                                                                                                                   scala.concurrent.ExecutionContextExecutor executionContext,
                                                                                                                   RejectionHandler rejectionHandler,
                                                                                                                   ExceptionHandler exceptionHandler)

Deprecated. Replaced by `toFlow` that takes an implicit ActorSystem. Since Akka HTTP 10.2.0.

Turns a Route into a server flow.

Parameters:

route - (undocumented)

routingSettings - (undocumented)

parserSettings - (undocumented)

materializer - (undocumented)

routingLog - (undocumented)

executionContext - (undocumented)

rejectionHandler - (undocumented)

exceptionHandler - (undocumented)

Returns:

(undocumented)

toFunction

public static scala.Function1<HttpRequest,scala.concurrent.Future<HttpResponse>> toFunction(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route,
                                                                                            org.apache.pekko.actor.ClassicActorSystemProvider system)

asyncHandler

public static scala.Function1<HttpRequest,scala.concurrent.Future<HttpResponse>> asyncHandler(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route,
                                                                                              RoutingSettings routingSettings,
                                                                                              ParserSettings parserSettings,
                                                                                              org.apache.pekko.stream.Materializer materializer,
                                                                                              RoutingLog routingLog,
                                                                                              scala.concurrent.ExecutionContextExecutor executionContext,
                                                                                              RejectionHandler rejectionHandler,
                                                                                              ExceptionHandler exceptionHandler)

Deprecated. Use `toFunction` instead, which only requires an implicit ActorSystem and no rejection/exception handlers. Use directives to specify custom exceptions or rejection handlers. Since Akka HTTP 10.2.0.

Turns a Route into an async handler function.

Parameters:

route - (undocumented)

routingSettings - (undocumented)

parserSettings - (undocumented)

materializer - (undocumented)

routingLog - (undocumented)

executionContext - (undocumented)

rejectionHandler - (undocumented)

exceptionHandler - (undocumented)

Returns:

(undocumented)