trait Route extends AnyRef
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, Supplierinner) { 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
- Alphabetic
- By Inheritance
- Route
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
- abstract def flow(system: ActorSystem, materializer: Materializer): Flow[HttpRequest, HttpResponse, NotUsed]
- abstract def orElse(alternative: Route): Route
-
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 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.
- The result of the route will always be a complete response, i.e. the result of the future is a
-
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 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.
- The result of the route will always be a complete response, i.e. the result of the future is a
-
abstract
def
seal(routingSettings: RoutingSettings, parserSettings: ParserSettings, 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 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.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 10.1.1) Use the variant without RoutingSettings, ParserSettings parameters.
- The result of the route will always be a complete response, i.e. the result of the future is a
-
abstract
def
seal(routingSettings: RoutingSettings, parserSettings: ParserSettings, rejectionHandler: RejectionHandler, exceptionHandler: ExceptionHandler, system: ActorSystem, materializer: Materializer): 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 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.
- Annotations
- @Deprecated
- Deprecated
Use the variant without ActorSystem and Materializer
- The result of the route will always be a complete response, i.e. the result of the future is a
-
abstract
def
seal(system: ActorSystem, materializer: Materializer): 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 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.
- Annotations
- @Deprecated
- Deprecated
Use the variant without ActorSystem and Materializer
- The result of the route will always be a complete response, i.e. the result of the future is a
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Route, B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asScala: scaladsl.server.Route
Converts to the Scala DSL form of an Route.
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def ensuring(cond: (Route) ⇒ Boolean, msg: ⇒ Any): Route
- def ensuring(cond: (Route) ⇒ Boolean): Route
- def ensuring(cond: Boolean, msg: ⇒ Any): Route
- def ensuring(cond: Boolean): Route
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def →[B](y: B): (Route, B)