Packages

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, 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
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Route
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def flow(system: ActorSystem, materializer: Materializer): Flow[HttpRequest, HttpResponse, NotUsed]
  2. abstract def orElse(alternative: Route): Route
  3. 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.
  4. 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.
  5. 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.

  6. 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

  7. 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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Route to any2stringadd[Route] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Route, B)
    Implicit
    This member is added by an implicit conversion from Route to ArrowAssoc[Route] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def asScala: scaladsl.server.Route

    Converts to the Scala DSL form of an Route.

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def ensuring(cond: (Route) ⇒ Boolean, msg: ⇒ Any): Route
    Implicit
    This member is added by an implicit conversion from Route to Ensuring[Route] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (Route) ⇒ Boolean): Route
    Implicit
    This member is added by an implicit conversion from Route to Ensuring[Route] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): Route
    Implicit
    This member is added by an implicit conversion from Route to Ensuring[Route] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): Route
    Implicit
    This member is added by an implicit conversion from Route to Ensuring[Route] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Route to StringFormat[Route] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  28. def [B](y: B): (Route, B)
    Implicit
    This member is added by an implicit conversion from Route to ArrowAssoc[Route] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Route to any2stringadd[Route]

Inherited by implicit conversion StringFormat from Route to StringFormat[Route]

Inherited by implicit conversion Ensuring from Route to Ensuring[Route]

Inherited by implicit conversion ArrowAssoc from Route to ArrowAssoc[Route]

Ungrouped