Package akka.http.scaladsl.server

Class Route$

java.lang.Object

akka.http.scaladsl.server.Route$

public class Route$
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static Route$	MODULE$	Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor	Description
Route$()

Method Summary

Modifier and Type	Method	Description
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.
scala.Function1<HttpRequest,scala.concurrent.Future<HttpResponse>>	asyncHandler(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route, RoutingSettings routingSettings, ParserSettings parserSettings, akka.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.
scala.Function1<HttpRequest,scala.concurrent.Future<HttpResponse>>	createAsyncHandler(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> sealedRoute, RoutingLog routingLog, RoutingSettings routingSettings, ParserSettings parserSettings, scala.concurrent.ExecutionContextExecutor ec, akka.stream.Materializer mat)
akka.stream.scaladsl.Flow<HttpRequest,HttpResponse,akka.NotUsed>	handlerFlow(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route, RoutingSettings routingSettings, ParserSettings parserSettings, akka.stream.Materializer materializer, RoutingLog routingLog, scala.concurrent.ExecutionContextExecutor executionContext, RejectionHandler rejectionHandler, ExceptionHandler exceptionHandler)	Deprecated. Replaced by `toFlow` that takes an implicit ActorSystem.
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.
akka.stream.scaladsl.Flow<HttpRequest,HttpResponse,akka.NotUsed>	toFlow(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route, akka.actor.ClassicActorSystemProvider system)	Turns a Route into a server flow.
akka.stream.scaladsl.Flow<HttpRequest,HttpResponse,akka.NotUsed>	toFlow(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route, scala.concurrent.ExecutionContextExecutor executionContext, akka.stream.Materializer materializer, akka.actor.ClassicActorSystemProvider system)	Turns a Route into a server flow, like toFlow, but allows overriding the ExecutionContext and Materializer used to complete requests.
scala.Function1<HttpRequest,scala.concurrent.Future<HttpResponse>>	toFunction(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route, akka.actor.ClassicActorSystemProvider system)
scala.Function1<HttpRequest,scala.concurrent.Future<HttpResponse>>	toFunction(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route, scala.concurrent.ExecutionContextExecutor executionContext, akka.stream.Materializer materializer, akka.actor.ClassicActorSystemProvider system)	Turns a Route into an async handler function, like toFunction, but allows overriding the ExecutionContext and Materializer used to complete requests, instead of defaulting to system.dispatcher and SystemMaterializer(system).materializer.

Methods inherited from class java.lang.Object

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

Field Detail

MODULE$

public static final Route$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Detail

Route$

public Route$()

Method Detail

apply

public 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 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 {@link Directive.|} operator on directives.

Parameters:

route - (undocumented)

routingSettings - (undocumented)

parserSettings - (undocumented)

rejectionHandler - (undocumented)

exceptionHandler - (undocumented)

Returns:

(undocumented)

toFlow

public akka.stream.scaladsl.Flow<HttpRequest,HttpResponse,akka.NotUsed> toFlow(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route,
                                                                                           akka.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)

toFlow

public akka.stream.scaladsl.Flow<HttpRequest,HttpResponse,akka.NotUsed> toFlow(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route,
                                                                                           scala.concurrent.ExecutionContextExecutor executionContext,
                                                                                           akka.stream.Materializer materializer,
                                                                                           akka.actor.ClassicActorSystemProvider system)

Turns a Route into a server flow, like toFlow, but allows overriding the ExecutionContext and Materializer used to complete requests. Pass null for either parameter to keep its default (system.dispatcher and SystemMaterializer(system).materializer, respectively).

Parameters:

route - (undocumented)

executionContext - (undocumented)

materializer - (undocumented)

system - (undocumented)

Returns:

(undocumented)

handlerFlow

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

Deprecated.

Replaced by `toFlow` that takes an implicit ActorSystem. Since 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 scala.Function1<HttpRequest,scala.concurrent.Future<HttpResponse>> toFunction(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route,
                                                                                           akka.actor.ClassicActorSystemProvider system)

toFunction

public scala.Function1<HttpRequest,scala.concurrent.Future<HttpResponse>> toFunction(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route,
                                                                                           scala.concurrent.ExecutionContextExecutor executionContext,
                                                                                           akka.stream.Materializer materializer,
                                                                                           akka.actor.ClassicActorSystemProvider system)

Turns a Route into an async handler function, like toFunction, but allows overriding the ExecutionContext and Materializer used to complete requests, instead of defaulting to system.dispatcher and SystemMaterializer(system).materializer. Pass null for either parameter to keep its default.

Parameters:

route - (undocumented)

executionContext - (undocumented)

materializer - (undocumented)

system - (undocumented)

Returns:

(undocumented)

asyncHandler

public scala.Function1<HttpRequest,scala.concurrent.Future<HttpResponse>> asyncHandler(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> route,
                                                                                             RoutingSettings routingSettings,
                                                                                             ParserSettings parserSettings,
                                                                                             akka.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 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)

createAsyncHandler

public scala.Function1<HttpRequest,scala.concurrent.Future<HttpResponse>> createAsyncHandler(scala.Function1<RequestContext,scala.concurrent.Future<RouteResult>> sealedRoute,
                                                                                                   RoutingLog routingLog,
                                                                                                   RoutingSettings routingSettings,
                                                                                                   ParserSettings parserSettings,
                                                                                                   scala.concurrent.ExecutionContextExecutor ec,
                                                                                                   akka.stream.Materializer mat)