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, executionContext: ExecutionContextExecutor, materializer: Materializer): Function[HttpRequest, CompletionStage[HttpResponse]]

    Like handler(system), but allows overriding the ExecutionContext and Materializer used to complete requests, instead of defaulting to system.dispatcher() and the SystemMaterializer.

    Like handler(system), but allows overriding the ExecutionContext and Materializer used to complete requests, instead of defaulting to system.dispatcher() and the SystemMaterializer. Pass null for either parameter to keep its default.

  3. abstract def handler(system: ClassicActorSystemProvider): Function[HttpRequest, CompletionStage[HttpResponse]]
    Definition Classes
    Route → HandlerProvider
  4. abstract def orElse(alternative: Route): Route
  5. 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.
  6. 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. 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 toany2stringadd[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 toArrowAssoc[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(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. def ensuring(cond: (Route) => Boolean, msg: => Any): Route
    Implicit
    This member is added by an implicit conversion from Route toEnsuring[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 toEnsuring[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 toEnsuring[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 toEnsuring[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: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def flow(system: ClassicActorSystemProvider): Flow[HttpRequest, HttpResponse, NotUsed]
  16. def function(system: ClassicActorSystemProvider): Function[HttpRequest, CompletionStage[HttpResponse]]
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @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
    @HotSpotIntrinsicCandidate() @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Route toStringFormat[Route] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (Route, B)
    Implicit
    This member is added by an implicit conversion from Route toArrowAssoc[Route] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from HandlerProvider

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromRoute to any2stringadd[Route]

Inherited by implicit conversion StringFormat fromRoute to StringFormat[Route]

Inherited by implicit conversion Ensuring fromRoute to Ensuring[Route]

Inherited by implicit conversion ArrowAssoc fromRoute to ArrowAssoc[Route]

Ungrouped