Packages

trait Route extends HandlerProvider

In the Java DSL, a Route can only consist of combinations of the built-in directives. A Route can not be instantiated directly.

However, the built-in directives may be combined methods like:

Route myDirective(String test, Supplier inner) {
  return
    path("fixed", () ->
      path(test),
        inner
      )
    );
}

The above example will invoke [inner] whenever the path "fixed/{test}" is matched, where "{test}" is the actual String that was given as method argument.

Annotations
@DoNotInherit()
Source
Route.scala
Linear Supertypes
HandlerProvider, AnyRef, Any
Known Subclasses
RouteAdapter
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Route
  2. HandlerProvider
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def flow(system: ActorSystem, materializer: Materializer): Flow[HttpRequest, HttpResponse, NotUsed]
  2. abstract def handler(system: ClassicActorSystemProvider): Function[HttpRequest, CompletionStage[HttpResponse]]
    Definition Classes
    Route → HandlerProvider
  3. abstract def orElse(alternative: Route): Route
  4. abstract def seal(rejectionHandler: RejectionHandler, exceptionHandler: ExceptionHandler): Route

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

    Seals a route by wrapping it with explicit 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 given RejectionHandler and ExceptionHandler.
    • Consequently, no route alternatives will be tried that were combined with this route.
  5. abstract def seal(): Route

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

    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 default RejectionHandler and ExceptionHandler.
    • Consequently, no route alternatives will be tried that were combined with this route.

Concrete Value Members

  1. def asScala: scaladsl.server.Route

    Converts to the Scala DSL form of an Route.

  2. def flow(system: ClassicActorSystemProvider): Flow[HttpRequest, HttpResponse, NotUsed]
  3. def function(system: ClassicActorSystemProvider): Function[HttpRequest, CompletionStage[HttpResponse]]