Apache Pekko HTTP
1.1.0
API
Generated with
Apache Pekko HTTP/org.apache.pekko.http/org.apache.pekko.http.javadsl/org.apache.pekko.http.javadsl.server/Route

Route

org.apache.pekko.http.javadsl.server.Route
@DoNotInherit
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.

Attributes

Source
Route.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class RouteAdapter

Members list

Value members

Abstract methods

def flow(system: ActorSystem, materializer: Materializer): Flow[HttpRequest, HttpResponse, NotUsed]

Attributes

Source
Route.scala
def orElse(alternative: Route): Route

Attributes

Source
Route.scala
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.

Attributes

Source
Route.scala
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.

Attributes

Source
Route.scala

Concrete methods

def asScala: Route

Converts to the Scala DSL form of an Route.

Converts to the Scala DSL form of an Route.

Attributes

Source
Route.scala
Generated with