Class

akka.http.javadsl.server.directives

BasicDirectives

Related Doc: package directives

Permalink

abstract class BasicDirectives extends AnyRef

Source
BasicDirectives.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BasicDirectives
  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

Instance Constructors

  1. new BasicDirectives()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to any2stringadd[BasicDirectives] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BasicDirectives, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to ArrowAssoc[BasicDirectives] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def cancelRejection(rejection: Rejection, inner: Supplier[Route]): Route

    Permalink

    Adds a TransformationRejection cancelling all rejections equal to the given one to the list of rejections potentially coming back from the inner route.

  8. def cancelRejections(filter: Predicate[Rejection], inner: Supplier[Route]): Route

    Permalink

    Adds a TransformationRejection cancelling all rejections for which the given filter function returns true to the list of rejections potentially coming back from the inner route.

  9. def cancelRejections(classes: Iterable[Class[_]], inner: Supplier[Route]): Route

    Permalink

    Adds a TransformationRejection cancelling all rejections of one of the given classes to the list of rejections potentially coming back from the inner route.

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def ensuring(cond: (BasicDirectives) ⇒ Boolean, msg: ⇒ Any): BasicDirectives

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to Ensuring[BasicDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (BasicDirectives) ⇒ Boolean): BasicDirectives

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to Ensuring[BasicDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): BasicDirectives

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to Ensuring[BasicDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): BasicDirectives

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to Ensuring[BasicDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def extract[T](extract: Function[RequestContext, T], inner: Function[T, Route]): Route

    Permalink

    Extracts a single value using the given function.

  18. def extractActorSystem(inner: Function[ActorSystem, Route]): Route

    Permalink

    Extracts the akka.actor.ActorSystem if the available Materializer is an akka.stream.ActorMaterializer.

    Extracts the akka.actor.ActorSystem if the available Materializer is an akka.stream.ActorMaterializer. Otherwise throws an exception as it won't be able to extract the system from arbitrary materializers.

  19. def extractDataBytes(inner: Function[Source[ByteString, Any], Route]): RouteAdapter

    Permalink

    Extracts the entities dataBytes akka.stream.javadsl.Source from the akka.http.javadsl.server.RequestContext.

  20. def extractEntity(inner: Function[RequestEntity, Route]): Route

    Permalink

    Extracts the current http request entity.

    Extracts the current http request entity.

    Annotations
    @CorrespondsTo()
  21. def extractExecutionContext(inner: Function[ExecutionContextExecutor, Route]): Route

    Permalink

    Extracts the ExecutionContextExecutor from the RequestContext.

  22. def extractLog(inner: Function[LoggingAdapter, Route]): Route

    Permalink

    Extracts the LoggingAdapter

  23. def extractMaterializer(inner: Function[Materializer, Route]): Route

    Permalink

    Extracts the Materializer from the RequestContext.

  24. def extractParserSettings(inner: Function[ParserSettings, Route]): RouteAdapter

    Permalink

    Extracts the akka.http.javadsl.settings.ParserSettings from the akka.http.javadsl.server.RequestContext.

  25. def extractRequest(inner: Function[HttpRequest, Route]): RouteAdapter

    Permalink

    Extracts the current HttpRequest instance.

  26. def extractRequestContext(inner: Function[RequestContext, Route]): RouteAdapter

    Permalink

    Extracts the akka.http.javadsl.server.RequestContext itself.

  27. def extractRequestEntity(inner: Function[RequestEntity, Route]): Route

    Permalink

    Extracts the akka.http.javadsl.model.RequestEntity from the akka.http.javadsl.server.RequestContext.

  28. def extractSettings(inner: Function[RoutingSettings, Route]): RouteAdapter

    Permalink

    Extracts the RoutingSettings from the akka.http.javadsl.server.RequestContext.

  29. def extractStrictEntity(timeout: FiniteDuration, inner: Function[Strict, Route]): Route

    Permalink

    WARNING: This will read the entire request entity into memory regardless of size and effectively disable streaming.

    WARNING: This will read the entire request entity into memory regardless of size and effectively disable streaming.

    Converts the HttpEntity from the akka.http.javadsl.server.RequestContext into an akka.http.javadsl.model.HttpEntity.Strict and extracts it, or fails the route if unable to drain the entire request body within the timeout.

    timeout

    The directive is failed if the stream isn't completed after the given timeout.

  30. def extractUnmatchedPath(inner: Function[String, Route]): RouteAdapter

    Permalink

    Extracts the yet unmatched path from the RequestContext.

  31. def extractUri(inner: Function[Uri, Route]): RouteAdapter

    Permalink

    Extracts the complete request URI.

  32. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  33. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to StringFormat[BasicDirectives] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  34. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  35. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  36. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  37. def mapInnerRoute(f: Function[Route, Route], inner: Supplier[Route]): Route

    Permalink
  38. def mapRejections(f: Function[List[Rejection], List[Rejection]], inner: Supplier[Route]): Route

    Permalink
  39. def mapRequest(f: Function[HttpRequest, HttpRequest], inner: Supplier[Route]): Route

    Permalink
  40. def mapRequestContext(f: Function[RequestContext, RequestContext], inner: Supplier[Route]): Route

    Permalink
  41. def mapResponse(f: Function[HttpResponse, HttpResponse], inner: Supplier[Route]): Route

    Permalink
  42. def mapResponseEntity(f: Function[ResponseEntity, ResponseEntity], inner: Supplier[Route]): Route

    Permalink
  43. def mapResponseHeaders(f: Function[List[HttpHeader], List[HttpHeader]], inner: Supplier[Route]): Route

    Permalink
  44. def mapRouteResult(f: Function[RouteResult, RouteResult], inner: Supplier[Route]): Route

    Permalink
  45. def mapRouteResultFuture(f: Function[CompletionStage[RouteResult], CompletionStage[RouteResult]], inner: Supplier[Route]): Route

    Permalink
  46. def mapRouteResultPF(f: PartialFunction[RouteResult, RouteResult], inner: Supplier[Route]): Route

    Permalink
  47. def mapRouteResultWith(f: Function[RouteResult, CompletionStage[RouteResult]], inner: Supplier[Route]): Route

    Permalink
  48. def mapRouteResultWithPF(f: PartialFunction[RouteResult, CompletionStage[RouteResult]], inner: Supplier[Route]): Route

    Permalink
  49. def mapSettings(f: Function[RoutingSettings, RoutingSettings], inner: Supplier[Route]): Route

    Permalink

    Runs the inner route with settings mapped by the given function.

  50. def mapUnmatchedPath(f: Function[String, String], inner: Supplier[Route]): Route

    Permalink

    Transforms the unmatchedPath of the RequestContext using the given function.

  51. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  52. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  53. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  54. def pass(inner: Supplier[Route]): Route

    Permalink

    Always passes the request on to its inner route (i.e.

    Always passes the request on to its inner route (i.e. does nothing with the request or the response).

  55. def provide[T](t: T, inner: Function[T, Route]): Route

    Permalink

    Injects the given value into a directive.

  56. def recoverRejections(f: Function[Iterable[Rejection], RouteResult], inner: Supplier[Route]): Route

    Permalink
  57. def recoverRejectionsWith(f: Function[Iterable[Rejection], CompletionStage[RouteResult]], inner: Supplier[Route]): Route

    Permalink
  58. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  59. def toStrictEntity(timeout: FiniteDuration, inner: Supplier[Route]): Route

    Permalink

    WARNING: This will read the entire request entity into memory regardless of size and effectively disable streaming.

    WARNING: This will read the entire request entity into memory regardless of size and effectively disable streaming.

    Extracts the akka.http.javadsl.server.RequestContext itself with the strict HTTP entity, or fails the route if unable to drain the entire request body within the timeout.

    timeout

    The directive is failed if the stream isn't completed after the given timeout.

  60. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  61. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. def withExecutionContext(ec: ExecutionContextExecutor, inner: Supplier[Route]): Route

    Permalink

    Runs its inner route with the given alternative scala.concurrent.ExecutionContextExecutor.

  65. def withLog(log: LoggingAdapter, inner: Supplier[Route]): Route

    Permalink

    Runs its inner route with the given alternative LoggingAdapter.

  66. def withMaterializer(mat: Materializer, inner: Supplier[Route]): Route

    Permalink

    Runs its inner route with the given alternative akka.stream.Materializer.

  67. def withSettings(s: RoutingSettings, inner: Supplier[Route]): Route

    Permalink

    Runs its inner route with the given alternative RoutingSettings.

  68. def [B](y: B): (BasicDirectives, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to ArrowAssoc[BasicDirectives] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped