abstract class RouteDirectives extends RespondWithDirectives

Source
RouteDirectives.scala
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. RouteDirectives
  2. RespondWithDirectives
  3. RangeDirectives
  4. PathDirectives
  5. ParameterDirectives
  6. MiscDirectives
  7. MethodDirectives
  8. MarshallingDirectives
  9. HostDirectives
  10. AttributeDirectives
  11. HeaderDirectives
  12. FutureDirectives
  13. FormFieldDirectives
  14. FileUploadDirectives
  15. FileAndResourceDirectives
  16. ExecutionDirectives
  17. DebuggingDirectives
  18. CookieDirectives
  19. CodingDirectives
  20. CacheConditionDirectives
  21. BasicDirectives
  22. AnyRef
  23. 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

future

  1. def completeOrRecoverWith[T](f: Supplier[CompletionStage[T]], marshaller: Marshaller[T, RequestEntity], inner: Function[Throwable, Route]): Route

    "Unwraps" a CompletionStage<T> and runs the inner route when the stage has failed with the stage's failure exception as an extraction of type Throwable.

    "Unwraps" a CompletionStage<T> and runs the inner route when the stage has failed with the stage's failure exception as an extraction of type Throwable. If the completion stage succeeds the request is completed using the values marshaller (This directive therefore requires a marshaller for the completion stage value type to be provided.)

    Definition Classes
    FutureDirectives
  2. def onComplete[T](cs: CompletionStage[T], inner: Function[Try[T], Route]): RouteAdapter

    "Unwraps" a CompletionStage<T> and runs the inner route after future completion with the future's value as an extraction of type Try<T>.

    "Unwraps" a CompletionStage<T> and runs the inner route after future completion with the future's value as an extraction of type Try<T>.

    Definition Classes
    FutureDirectives
  3. def onComplete[T](f: Supplier[CompletionStage[T]], inner: Function[Try[T], Route]): RouteAdapter

    "Unwraps" a CompletionStage<T> and runs the inner route after future completion with the future's value as an extraction of type Try<T>.

    "Unwraps" a CompletionStage<T> and runs the inner route after future completion with the future's value as an extraction of type Try<T>.

    Definition Classes
    FutureDirectives
  4. def onCompleteWithBreaker[T](breaker: CircuitBreaker, f: Supplier[CompletionStage[T]], inner: Function[Try[T], Route]): RouteAdapter

    "Unwraps" a CompletionStage[T] and runs the inner route after future completion with the future's value as an extraction of type T if the supplied CircuitBreaker is closed.

    "Unwraps" a CompletionStage[T] and runs the inner route after future completion with the future's value as an extraction of type T if the supplied CircuitBreaker is closed.

    If the supplied CircuitBreaker is open the request is rejected with a akka.http.javadsl.server.CircuitBreakerOpenRejection.

    Definition Classes
    FutureDirectives
  5. def onSuccess[T](cs: CompletionStage[T], inner: Function[T, Route]): RouteAdapter

    "Unwraps" a CompletionStage<T> and runs the inner route after stage completion with the stage's value as an extraction of type T.

    "Unwraps" a CompletionStage<T> and runs the inner route after stage completion with the stage's value as an extraction of type T. If the stage fails its failure Throwable is bubbled up to the nearest ExceptionHandler.

    Definition Classes
    FutureDirectives
  6. def onSuccess[T](f: Supplier[CompletionStage[T]], inner: Function[T, Route]): RouteAdapter

    "Unwraps" a CompletionStage<T> and runs the inner route after stage completion with the stage's value as an extraction of type T.

    "Unwraps" a CompletionStage<T> and runs the inner route after stage completion with the stage's value as an extraction of type T. If the stage fails its failure Throwable is bubbled up to the nearest ExceptionHandler.

    Definition Classes
    FutureDirectives

header

  1. def checkSameOrigin(allowed: HttpOriginRange, inner: Supplier[Route]): Route

    Checks that request comes from the same origin.

    Checks that request comes from the same origin. Extracts the Origin header value and verifies that allowed range contains the obtained value. In the case of absent of the Origin header rejects with MissingHeaderRejection. If the origin value is not in the allowed range rejects with an InvalidOriginRejection and StatusCodes.FORBIDDEN status.

    Definition Classes
    HeaderDirectives

Ungrouped

  1. def attribute[T](key: AttributeKey[T], inner: Function[T, Route]): RouteAdapter

    Extracts the value of the request attribute with the given key.

    Extracts the value of the request attribute with the given key. If no attribute is found the request is rejected with a akka.http.javadsl.server.MissingAttributeRejection.

    Definition Classes
    AttributeDirectives
  2. def cancelRejection(rejection: Rejection, inner: Supplier[Route]): Route

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

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

    Definition Classes
    BasicDirectives
  3. def cancelRejections(filter: Predicate[Rejection], inner: Supplier[Route]): Route

    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.

    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.

    Definition Classes
    BasicDirectives
  4. def cancelRejections(classes: Iterable[Class[_]], inner: Supplier[Route]): Route

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

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

    Definition Classes
    BasicDirectives
  5. def complete(entity: RequestEntity): RouteAdapter

    Completes the request as HTTP 200 OK with the given value as response entity.

  6. def complete(entity: ResponseEntity): RouteAdapter

    Completes the request as HTTP 200 OK with the given value as response entity.

  7. def complete(headers: Iterable[HttpHeader], entity: RequestEntity): RouteAdapter

    Completes the request as HTTP 200 OK, adding the given headers and response entity.

  8. def complete(headers: Iterable[HttpHeader], entity: ResponseEntity): RouteAdapter

    Completes the request as HTTP 200 OK, adding the given headers and response entity.

  9. def complete[T](headers: Iterable[HttpHeader], value: T, marshaller: Marshaller[T, RequestEntity]): RouteAdapter

    Completes the request as HTTP 200 OK, adding the given headers, and marshalling the given value as response entity.

  10. def complete(status: StatusCode, entity: String): RouteAdapter

    Completes the request using the given status code and the given body as UTF-8.

  11. def complete(status: StatusCode, entity: RequestEntity): RouteAdapter

    Completes the request using the given status code and response entity.

  12. def complete(status: StatusCode, entity: ResponseEntity): RouteAdapter

    Completes the request using the given status code and response entity.

  13. def complete[T](status: StatusCode, value: T, marshaller: Marshaller[T, RequestEntity]): RouteAdapter

    Completes the request using the given status code, marshalling the given value as response entity.

  14. def complete(status: StatusCode, headers: Iterable[HttpHeader], entity: RequestEntity): RouteAdapter

    Completes the request using the given status code, headers, and response entity.

  15. def complete(status: StatusCode, headers: Iterable[HttpHeader], entity: ResponseEntity): RouteAdapter

    Completes the request using the given status code, headers, and response entity.

  16. def complete[T](status: StatusCode, headers: Iterable[HttpHeader], value: T, marshaller: Marshaller[T, RequestEntity]): RouteAdapter

    Completes the request using the given status code and headers, marshalling the given value as response entity.

  17. def complete[T](value: T, marshaller: Marshaller[T, HttpResponse]): RouteAdapter

    Completes the request by marshalling the given value into an http response.

  18. def complete(status: StatusCode): Route

    Completes the request using the given status code.

  19. def complete(response: HttpResponse): Route

    Completes the request using the given http response.

  20. def complete(body: String): Route

    Completes the request using an HTTP 200 OK status code and the given body as UTF-8 entity.

  21. def completeOK[T](value: T, marshaller: Marshaller[T, RequestEntity]): RouteAdapter

    Completes the request as HTTP 200 OK, marshalling the given value as response entity.

    Completes the request as HTTP 200 OK, marshalling the given value as response entity.

    Annotations
    @CorrespondsTo()
  22. def completeOKWithFuture[T](value: CompletionStage[T], marshaller: Marshaller[T, RequestEntity]): RouteAdapter

    Completes the request with an OK status code by marshalling the given value into an http response.

    Completes the request with an OK status code by marshalling the given value into an http response.

    Annotations
    @CorrespondsTo()
  23. def completeOKWithFuture(value: CompletionStage[RequestEntity]): RouteAdapter

    Completes the request by marshalling the given future value into an http response.

    Completes the request by marshalling the given future value into an http response.

    Annotations
    @CorrespondsTo()
  24. def completeOKWithFuture[T](value: Future[T], marshaller: Marshaller[T, RequestEntity]): RouteAdapter

    Completes the request by marshalling the given value into an http response.

    Completes the request by marshalling the given value into an http response.

    Annotations
    @CorrespondsTo()
  25. def completeOKWithFutureString(value: CompletionStage[String]): RouteAdapter

    Completes the request by marshalling the given future value into an http response.

    Completes the request by marshalling the given future value into an http response.

    Annotations
    @CorrespondsTo()
  26. def completeOKWithFutureString(value: Future[String]): RouteAdapter

    Completes the request by marshalling the given future value into an http response.

    Completes the request by marshalling the given future value into an http response.

    Annotations
    @CorrespondsTo()
  27. def completeWith[T](marshaller: Marshaller[T, _ <: HttpResponse], inner: Consumer[Consumer[T]]): Route

    Uses the marshaller for the given type to produce a completion function that is passed to its inner function.

    Uses the marshaller for the given type to produce a completion function that is passed to its inner function. You can use it do decouple marshaller resolution from request completion.

    Definition Classes
    MarshallingDirectives
  28. def completeWithFuture[T](value: CompletionStage[T], marshaller: Marshaller[T, HttpResponse]): RouteAdapter

    Completes the request by marshalling the given value into an http response.

    Completes the request by marshalling the given value into an http response.

    Annotations
    @CorrespondsTo()
  29. def completeWithFuture(value: CompletionStage[HttpResponse]): RouteAdapter

    Completes the request by marshalling the given future value into an http response.

    Completes the request by marshalling the given future value into an http response.

    Annotations
    @CorrespondsTo()
  30. def completeWithFuture[T](value: Future[T], marshaller: Marshaller[T, HttpResponse]): RouteAdapter

    Completes the request by marshalling the given value into an http response.

    Completes the request by marshalling the given value into an http response.

    Annotations
    @CorrespondsTo()
  31. def completeWithFutureResponse(value: Future[HttpResponse]): RouteAdapter

    Completes the request by marshalling the given future value into an http response.

    Completes the request by marshalling the given future value into an http response.

    Annotations
    @CorrespondsTo()
  32. def completeWithFutureStatus(status: CompletionStage[StatusCode]): Route

    Completes the request using the given future status code.

    Completes the request using the given future status code.

    Annotations
    @CorrespondsTo()
  33. def completeWithFutureStatus(status: Future[StatusCode]): Route

    Completes the request using the given future status code.

    Completes the request using the given future status code.

    Annotations
    @CorrespondsTo()
  34. def concat(first: Route, alternatives: Route*): Route

    Used to chain multiple alternate routes using comma, rather than having to explicitly call route1.orElse(route2).orElse(route3).

    Used to chain multiple alternate routes using comma, rather than having to explicitly call route1.orElse(route2).orElse(route3).

    Annotations
    @varargs()
  35. def conditional(eTag: Optional[EntityTag], lastModified: Optional[DateTime], inner: Supplier[Route]): Route

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

    Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

    Definition Classes
    CacheConditionDirectives
  36. def conditional(eTag: EntityTag, lastModified: DateTime, inner: Supplier[Route]): Route

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

    Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

    Definition Classes
    CacheConditionDirectives
  37. def conditional(lastModified: DateTime, inner: Supplier[Route]): Route

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

    Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

    Definition Classes
    CacheConditionDirectives
  38. def conditional(eTag: EntityTag, inner: Supplier[Route]): Route

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

    Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

    Definition Classes
    CacheConditionDirectives
  39. def cookie(name: String, inner: Function[HttpCookiePair, Route]): Route

    Extracts the HttpCookiePair with the given name.

    Extracts the HttpCookiePair with the given name. If the cookie is not present the request is rejected with a respective akka.http.javadsl.server.MissingCookieRejection.

    Definition Classes
    CookieDirectives
  40. def decodeRequest(inner: Supplier[Route]): Route

    Decompresses the incoming request if it is gzip or deflate compressed.

    Decompresses the incoming request if it is gzip or deflate compressed. Uncompressed requests are passed through untouched. If the request encoded with another encoding the request is rejected with an UnsupportedRequestEncodingRejection.

    Definition Classes
    CodingDirectives
  41. def decodeRequestWith(coders: Iterable[Coder], inner: Supplier[Route]): Route

    Decodes the incoming request if it is encoded with one of the given encoders.

    Decodes the incoming request if it is encoded with one of the given encoders. If the request encoding doesn't match one of the given encoders the request is rejected with an UnsupportedRequestEncodingRejection. If no decoders are given the default encoders (Gzip, Deflate, NoCoding) are used.

    Definition Classes
    CodingDirectives
  42. def decodeRequestWith(coder: Coder, inner: Supplier[Route]): Route

    Decodes the incoming request using the given Decoder.

    Decodes the incoming request using the given Decoder. If the request encoding doesn't match the request is rejected with an UnsupportedRequestEncodingRejection.

    Definition Classes
    CodingDirectives
  43. def defaultContentTypeResolver: ContentTypeResolver

    Default ContentTypeResolver.

  44. def defaultDirectoryRenderer: DirectoryRenderer

    Default DirectoryRenderer to be used with directory listing directives.

    Default DirectoryRenderer to be used with directory listing directives.

    Definition Classes
    FileAndResourceDirectives
  45. def delete(inner: Supplier[Route]): Route
    Definition Classes
    MethodDirectives
  46. def deleteCookie(name: String, domain: String, path: String, inner: Supplier[Route]): Route

    Adds a Set-Cookie response header expiring the cookie with the given properties.

    Adds a Set-Cookie response header expiring the cookie with the given properties.

    name

    Name of the cookie to match

    domain

    Domain of the cookie to match, or empty string to match any domain

    path

    Path of the cookie to match, or empty string to match any path

    Definition Classes
    CookieDirectives
  47. def deleteCookie(name: String, domain: String, inner: Supplier[Route]): Route

    Adds a Set-Cookie response header expiring the cookie with the given properties.

    Adds a Set-Cookie response header expiring the cookie with the given properties.

    name

    Name of the cookie to match

    domain

    Domain of the cookie to match, or empty string to match any domain

    Definition Classes
    CookieDirectives
  48. def deleteCookie(name: String, inner: Supplier[Route]): Route

    Adds a Set-Cookie response header expiring the cookie with the given properties.

    Adds a Set-Cookie response header expiring the cookie with the given properties.

    name

    Name of the cookie to match

    Definition Classes
    CookieDirectives
  49. def deleteCookie(cookies: Iterable[HttpCookie], inner: Supplier[Route]): Route

    Adds a Set-Cookie response header expiring the given cookies.

    Adds a Set-Cookie response header expiring the given cookies.

    Definition Classes
    CookieDirectives
  50. def deleteCookie(cookie: HttpCookie, inner: Supplier[Route]): Route

    Adds a Set-Cookie response header expiring the given cookie.

    Adds a Set-Cookie response header expiring the given cookie.

    Definition Classes
    CookieDirectives
  51. def encodeResponse(inner: Supplier[Route]): Route

    Encodes the response with the encoding that is requested by the client via the Accept- Encoding header.

    Encodes the response with the encoding that is requested by the client via the Accept- Encoding header. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.

    If the Accept-Encoding header is missing or empty or specifies an encoding other than identity, gzip or deflate then no encoding is used.

    Definition Classes
    CodingDirectives
  52. def encodeResponseWith(coders: Iterable[Coder], inner: Supplier[Route]): Route

    Encodes the response with the encoding that is requested by the client via the Accept- Encoding header.

    Encodes the response with the encoding that is requested by the client via the Accept- Encoding header. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.

    If the Accept-Encoding header is missing then the response is encoded using the first encoder.

    If the Accept-Encoding header is empty and NoCoding is part of the encoders then no response encoding is used. Otherwise the request is rejected.

    If [encoders] is empty, no encoding is performed.

    Definition Classes
    CodingDirectives
  53. def entity[T](unmarshaller: Unmarshaller[_ >: HttpEntity, T], inner: Function[T, Route]): Route

    Unmarshalls the requests entity using the given unmarshaller, and passes the result to [inner].

    Unmarshalls the requests entity using the given unmarshaller, and passes the result to [inner]. If there is a problem with unmarshalling the request is rejected with the akka.http.javadsl.server.Rejection produced by the unmarshaller.

    Definition Classes
    MarshallingDirectives
  54. def extract[T](extract: Function[RequestContext, T], inner: Function[T, Route]): Route

    Extracts a single value using the given function.

    Extracts a single value using the given function.

    Definition Classes
    BasicDirectives
  55. def extractActorSystem(inner: Function[ActorSystem, Route]): Route

    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.

    Definition Classes
    BasicDirectives
  56. def extractClientIP(inner: Function[RemoteAddress, Route]): Route

    Extracts the client's IP from either the X-Forwarded-For, Remote-Address, X-Real-IP header or akka.http.javadsl.model.AttributeKeys.remoteAddress attribute (in that order of priority).

    Extracts the client's IP from either the X-Forwarded-For, Remote-Address, X-Real-IP header or akka.http.javadsl.model.AttributeKeys.remoteAddress attribute (in that order of priority).

    Definition Classes
    MiscDirectives
  57. def extractDataBytes(inner: Function[Source[ByteString, Any], Route]): RouteAdapter

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

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

    Definition Classes
    BasicDirectives
  58. def extractEntity(inner: Function[RequestEntity, Route]): Route

    Extracts the current http request entity.

    Extracts the current http request entity.

    Definition Classes
    BasicDirectives
    Annotations
    @CorrespondsTo()
  59. def extractExecutionContext(inner: Function[ExecutionContextExecutor, Route]): Route

    Extracts the ExecutionContextExecutor from the RequestContext.

    Extracts the ExecutionContextExecutor from the RequestContext.

    Definition Classes
    BasicDirectives
  60. def extractHost(inner: Function[String, Route]): Route

    Extracts the hostname part of the Host request header value.

    Extracts the hostname part of the Host request header value.

    Definition Classes
    HostDirectives
  61. def extractLog(inner: Function[LoggingAdapter, Route]): Route

    Extracts the LoggingAdapter

    Extracts the LoggingAdapter

    Definition Classes
    BasicDirectives
  62. def extractMatchedPath(inner: Function[String, Route]): RouteAdapter

    Extracts the already matched path from the RequestContext.

    Extracts the already matched path from the RequestContext.

    Definition Classes
    BasicDirectives
  63. def extractMaterializer(inner: Function[Materializer, Route]): Route

    Extracts the Materializer from the RequestContext.

    Extracts the Materializer from the RequestContext.

    Definition Classes
    BasicDirectives
  64. def extractMethod(inner: Function[HttpMethod, Route]): RouteAdapter
    Definition Classes
    MethodDirectives
  65. def extractParserSettings(inner: Function[ParserSettings, Route]): RouteAdapter

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

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

    Extracts the current HttpRequest instance.

    Extracts the current HttpRequest instance.

    Definition Classes
    BasicDirectives
  67. def extractRequestContext(inner: Function[RequestContext, Route]): RouteAdapter

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

    Definition Classes
    BasicDirectives
  68. def extractRequestEntity(inner: Function[RequestEntity, Route]): Route

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

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

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

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

    Definition Classes
    BasicDirectives
  70. def extractStrictEntity(timeout: FiniteDuration, maxBytes: Long, inner: Function[Strict, Route]): Route

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

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

    To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the akka.http.parsing.max-to-strict-bytes configuration setting.

    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.

    Definition Classes
    BasicDirectives
  71. def extractStrictEntity(timeout: FiniteDuration, inner: Function[Strict, Route]): Route

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

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

    To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the akka.http.parsing.max-to-strict-bytes configuration setting.

    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.

    Definition Classes
    BasicDirectives
  72. def extractUnmatchedPath(inner: Function[String, Route]): RouteAdapter

    Extracts the yet unmatched path from the RequestContext.

    Extracts the yet unmatched path from the RequestContext.

    Definition Classes
    BasicDirectives
  73. def extractUri(inner: Function[Uri, Route]): RouteAdapter

    Extracts the complete request URI.

    Extracts the complete request URI.

    Definition Classes
    BasicDirectives
  74. def failWith(error: Throwable): Route

    Bubbles the given error up the response chain, where it is dealt with by the closest handleExceptions directive and its ExceptionHandler.

  75. def fileUpload(fieldName: String, inner: BiFunction[FileInfo, Source[ByteString, Any], Route]): Route

    Collects each body part that is a multipart file as a tuple containing metadata and a Source for streaming the file contents somewhere.

    Collects each body part that is a multipart file as a tuple containing metadata and a Source for streaming the file contents somewhere. If there is no such field the request will be rejected, if there are multiple file parts with the same name, the first one will be used and the subsequent ones ignored.

    Definition Classes
    FileUploadDirectives
  76. def fileUploadAll(fieldName: String, inner: Function[List[Entry[FileInfo, Source[ByteString, Any]]], Route]): Route

    Collects each body part that is a multipart file as a tuple containing metadata and a Source for streaming the file contents somewhere.

    Collects each body part that is a multipart file as a tuple containing metadata and a Source for streaming the file contents somewhere. If there is no such field the request will be rejected. Files are buffered into temporary files on disk so in-memory buffers don't overflow. The temporary files are cleaned up once materialized, or on exit if the stream is not consumed.

    Definition Classes
    FileUploadDirectives
  77. def formField[T](t: Unmarshaller[String, T], name: String, inner: Function[T, Route]): Route
    Definition Classes
    FormFieldDirectives
  78. def formField(name: String, inner: Function[String, Route]): Route
    Definition Classes
    FormFieldDirectives
  79. def formFieldList(inner: Function[List[Entry[String, String]], Route]): Route

    Extracts HTTP form fields from the request as a Map.Entry<String, String>>.

    Extracts HTTP form fields from the request as a Map.Entry<String, String>>.

    Definition Classes
    FormFieldDirectives
    Annotations
    @CorrespondsTo()
  80. def formFieldList[T](t: Unmarshaller[String, T], name: String, inner: Function[List[T], Route]): Route
    Definition Classes
    FormFieldDirectives
    Annotations
    @CorrespondsTo()
  81. def formFieldList(name: String, inner: Function[List[String], Route]): Route
    Definition Classes
    FormFieldDirectives
    Annotations
    @CorrespondsTo()
  82. def formFieldMap(inner: Function[Map[String, String], Route]): Route

    Extracts HTTP form fields from the request as a Map<String, String>.

    Extracts HTTP form fields from the request as a Map<String, String>.

    Definition Classes
    FormFieldDirectives
  83. def formFieldMultiMap(inner: Function[Map[String, List[String]], Route]): Route

    Extracts HTTP form fields from the request as a Map<String, List<String>>.

    Extracts HTTP form fields from the request as a Map<String, List<String>>.

    Definition Classes
    FormFieldDirectives
  84. def formFieldOptional[T](t: Unmarshaller[String, T], name: String, inner: Function[Optional[T], Route]): Route
    Definition Classes
    FormFieldDirectives
    Annotations
    @CorrespondsTo()
  85. def formFieldOptional(name: String, inner: Function[Optional[String], Route]): Route
    Definition Classes
    FormFieldDirectives
    Annotations
    @CorrespondsTo()
  86. def get(inner: Supplier[Route]): Route
    Definition Classes
    MethodDirectives
  87. def getFromBrowseableDirectories(directories: String*): Route

    Serves the content of the given directories as a file system browser, i.e.

    Serves the content of the given directories as a file system browser, i.e. files are sent and directories served as browseable listings.

    Definition Classes
    FileAndResourceDirectives
    Annotations
    @varargs()
  88. def getFromBrowseableDirectories(directories: Iterable[String], resolver: ContentTypeResolver): Route

    Serves the content of the given directories as a file system browser, i.e.

    Serves the content of the given directories as a file system browser, i.e. files are sent and directories served as browseable listings.

    Definition Classes
    FileAndResourceDirectives
  89. def getFromBrowseableDirectories(directories: Iterable[String], renderer: DirectoryRenderer): Route

    Serves the content of the given directories as a file system browser, i.e.

    Serves the content of the given directories as a file system browser, i.e. files are sent and directories served as browseable listings.

    Definition Classes
    FileAndResourceDirectives
  90. def getFromBrowseableDirectories(directories: Iterable[String], renderer: DirectoryRenderer, resolver: ContentTypeResolver): Route

    Serves the content of the given directories as a file system browser, i.e.

    Serves the content of the given directories as a file system browser, i.e. files are sent and directories served as browseable listings.

    Definition Classes
    FileAndResourceDirectives
  91. def getFromBrowseableDirectory(directory: String): Route

    Same as getFromBrowseableDirectories with only one directory.

    Same as getFromBrowseableDirectories with only one directory.

    Definition Classes
    FileAndResourceDirectives
  92. def getFromBrowseableDirectory(directory: String, resolver: ContentTypeResolver): Route

    Same as getFromBrowseableDirectories with only one directory.

    Same as getFromBrowseableDirectories with only one directory.

    Definition Classes
    FileAndResourceDirectives
  93. def getFromBrowseableDirectory(directory: String, renderer: DirectoryRenderer): Route

    Same as getFromBrowseableDirectories with only one directory.

    Same as getFromBrowseableDirectories with only one directory.

    Definition Classes
    FileAndResourceDirectives
  94. def getFromBrowseableDirectory(directory: String, renderer: DirectoryRenderer, resolver: ContentTypeResolver): Route

    Same as getFromBrowseableDirectories with only one directory.

    Same as getFromBrowseableDirectories with only one directory.

    Definition Classes
    FileAndResourceDirectives
  95. def getFromDirectory(directoryPath: String, resolver: ContentTypeResolver): Route

    Completes GET requests with the content of a file underneath the given directory, using the given content-type resolver.

    Completes GET requests with the content of a file underneath the given directory, using the given content-type resolver. If the file cannot be read the Route rejects the request.

    Definition Classes
    FileAndResourceDirectives
  96. def getFromDirectory(directoryPath: String): Route

    Completes GET requests with the content of a file underneath the given directory, using the default content-type resolver.

    Completes GET requests with the content of a file underneath the given directory, using the default content-type resolver. If the file cannot be read the Route rejects the request.

    Definition Classes
    FileAndResourceDirectives
  97. def getFromFile(file: String, resolver: ContentTypeResolver): Route

    Completes GET requests with the content of the given file, resolving the content type using the given resolver.

    Completes GET requests with the content of the given file, resolving the content type using the given resolver. If the file cannot be found or read the request is rejected.

    Definition Classes
    FileAndResourceDirectives
  98. def getFromFile(file: String): Route

    Completes GET requests with the content of the given file, resolving the content type using the default resolver.

    Completes GET requests with the content of the given file, resolving the content type using the default resolver. If the file cannot be found or read the request is rejected.

    Definition Classes
    FileAndResourceDirectives
  99. def getFromFile(file: File, contentType: ContentType): Route

    Completes GET requests with the content of the given file, using the content type.

    Completes GET requests with the content of the given file, using the content type. If the file cannot be found or read the request is rejected.

    Definition Classes
    FileAndResourceDirectives
  100. def getFromFile(file: File, resolver: ContentTypeResolver): Route

    Completes GET requests with the content of the given file, resolving the content type using the given resolver.

    Completes GET requests with the content of the given file, resolving the content type using the given resolver. If the file cannot be found or read the request is rejected.

    Definition Classes
    FileAndResourceDirectives
  101. def getFromFile(file: File): Route

    Completes GET requests with the content of the given file, resolving the content type using the default resolver.

    Completes GET requests with the content of the given file, resolving the content type using the default resolver. If the file cannot be found or read the request is rejected.

    Definition Classes
    FileAndResourceDirectives
  102. def getFromResource(path: String, contentType: ContentType, classLoader: ClassLoader): Route

    Completes GET requests with the content of the given resource loaded from the given ClassLoader, with the given content type.

    Completes GET requests with the content of the given resource loaded from the given ClassLoader, with the given content type. If the resource cannot be found or read the Route rejects the request.

    Definition Classes
    FileAndResourceDirectives
  103. def getFromResource(path: String, contentType: ContentType): Route

    Completes GET requests with the content of the given resource loaded from the default ClassLoader, with the given content type.

    Completes GET requests with the content of the given resource loaded from the default ClassLoader, with the given content type. If the resource cannot be found or read the Route rejects the request.

    Definition Classes
    FileAndResourceDirectives
  104. def getFromResource(path: String, resolver: ContentTypeResolver): Route

    Completes GET requests with the content of the given resource loaded from the default ClassLoader, using the given content type resolver.

    Completes GET requests with the content of the given resource loaded from the default ClassLoader, using the given content type resolver. If the resource cannot be found or read the Route rejects the request.

    Definition Classes
    FileAndResourceDirectives
  105. def getFromResource(path: String): Route

    Completes GET requests with the content of the given resource loaded from the default ClassLoader, using the default content type resolver.

    Completes GET requests with the content of the given resource loaded from the default ClassLoader, using the default content type resolver. If the resource cannot be found or read the Route rejects the request.

    Definition Classes
    FileAndResourceDirectives
  106. def getFromResourceDirectory(directoryName: String, resolver: ContentTypeResolver, classLoader: ClassLoader): Route

    Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the given ClassLoader, resolving content type using the given content type resolver.

    Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the given ClassLoader, resolving content type using the given content type resolver.

    If the requested resource is itself a directory or cannot be found or read the Route rejects the request.

    Definition Classes
    FileAndResourceDirectives
  107. def getFromResourceDirectory(directoryName: String, resolver: ContentTypeResolver): Route

    Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the default ClassLoader, resolving content type using the given content type resolver.

    Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the default ClassLoader, resolving content type using the given content type resolver.

    If the requested resource is itself a directory or cannot be found or read the Route rejects the request.

    Definition Classes
    FileAndResourceDirectives
  108. def getFromResourceDirectory(directoryName: String, classLoader: ClassLoader): Route

    Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the given ClassLoader, resolving content type using the default content type resolver.

    Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the given ClassLoader, resolving content type using the default content type resolver.

    If the requested resource is itself a directory or cannot be found or read the Route rejects the request.

    Definition Classes
    FileAndResourceDirectives
  109. def getFromResourceDirectory(directoryName: String): Route

    Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the default ClassLoader, resolving content type using the default content type resolver.

    Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the default ClassLoader, resolving content type using the default content type resolver.

    If the requested resource is itself a directory or cannot be found or read the Route rejects the request.

    Definition Classes
    FileAndResourceDirectives
  110. def handle(handler: Function[HttpRequest, CompletionStage[HttpResponse]]): Route

    Handle the request using a function.

  111. def handleExceptions(handler: ExceptionHandler, inner: Supplier[Route]): RouteAdapter

    Transforms exceptions thrown during evaluation of its inner route using the given akka.http.javadsl.server.ExceptionHandler.

    Transforms exceptions thrown during evaluation of its inner route using the given akka.http.javadsl.server.ExceptionHandler.

    Definition Classes
    ExecutionDirectives
  112. def handleRejections(handler: RejectionHandler, inner: Supplier[Route]): RouteAdapter

    Transforms rejections produced by its inner route using the given akka.http.scaladsl.server.RejectionHandler.

    Transforms rejections produced by its inner route using the given akka.http.scaladsl.server.RejectionHandler.

    Definition Classes
    ExecutionDirectives
  113. def handleSync(handler: Function[HttpRequest, HttpResponse]): Route

    Handle the request using a function.

  114. def handleWith[T, R](unmarshaller: Unmarshaller[_ >: HttpEntity, T], marshaller: Marshaller[R, _ <: HttpResponse], inner: Function[T, R]): Route

    Completes the request using the given function.

    Completes the request using the given function. The input to the function is produced with the in-scope entity unmarshaller and the result value of the function is marshalled with the in-scope marshaller.

    Definition Classes
    MarshallingDirectives
  115. def head(inner: Supplier[Route]): Route
    Definition Classes
    MethodDirectives
  116. def headerValue[T](f: Function[HttpHeader, Optional[T]], inner: Function[T, Route]): RouteAdapter

    Extracts an HTTP header value using the given function.

    Extracts an HTTP header value using the given function. If the function result is undefined for all headers the request is rejected with an empty rejection set. If the given function throws an exception the request is rejected with a akka.http.javadsl.server.MalformedHeaderRejection.

    Definition Classes
    HeaderDirectives
  117. def headerValueByName(headerName: String, inner: Function[String, Route]): RouteAdapter

    Extracts the value of the first HTTP request header with the given name.

    Extracts the value of the first HTTP request header with the given name. If no header with a matching name is found the request is rejected with a akka.http.javadsl.server.MissingHeaderRejection.

    Definition Classes
    HeaderDirectives
  118. def headerValueByType[T <: HttpHeader](t: Class[T], inner: Function[T, Route]): RouteAdapter

    Extracts the first HTTP request header of the given type.

    Extracts the first HTTP request header of the given type. If no header with a matching type is found the request is rejected with a akka.http.javadsl.server.MissingHeaderRejection.

    Definition Classes
    HeaderDirectives
  119. def headerValuePF[T](pf: PartialFunction[HttpHeader, T], inner: Function[T, Route]): RouteAdapter

    Extracts an HTTP header value using the given partial function.

    Extracts an HTTP header value using the given partial function. If the function is undefined for all headers the request is rejected with an empty rejection set.

    Definition Classes
    HeaderDirectives
  120. def host(regex: Pattern, inner: Function[String, Route]): Route

    Rejects all requests with a host name that doesn't have a prefix matching the given regular expression.

    Rejects all requests with a host name that doesn't have a prefix matching the given regular expression. For all matching requests the prefix string matching the regex is extracted and passed to the inner route. If the regex contains a capturing group only the string matched by this group is extracted. If the regex contains more than one capturing group an IllegalArgumentException is thrown.

    Definition Classes
    HostDirectives
  121. def host(predicate: Predicate[String], inner: Supplier[Route]): Route

    Rejects all requests for whose host name the given predicate function returns false.

    Rejects all requests for whose host name the given predicate function returns false.

    Definition Classes
    HostDirectives
  122. def host(hostName: String, inner: Supplier[Route]): Route

    Rejects all requests with a host name different from the given one.

    Rejects all requests with a host name different from the given one.

    Definition Classes
    HostDirectives
  123. def host(hostNames: Iterable[String], inner: Supplier[Route]): Route

    Rejects all requests with a host name different from the given ones.

    Rejects all requests with a host name different from the given ones.

    Definition Classes
    HostDirectives
  124. def ignoreTrailingSlash(inner: Supplier[Route]): Route

    Tries to match the inner route and if it fails with an empty rejection, it tries it again adding (or removing) the trailing slash on the given path.

    Tries to match the inner route and if it fails with an empty rejection, it tries it again adding (or removing) the trailing slash on the given path.

    Definition Classes
    PathDirectives
  125. def listDirectoryContents(directoryRenderer: DirectoryRenderer, directories: String*): Route

    Completes GET requests with a unified listing of the contents of all given directories.

    Completes GET requests with a unified listing of the contents of all given directories. The actual rendering of the directory contents is performed by the in-scope Marshaller[DirectoryListing].

    Definition Classes
    FileAndResourceDirectives
    Annotations
    @varargs()
  126. def listDirectoryContents(directories: String*): Route

    Completes GET requests with a unified listing of the contents of all given directories.

    Completes GET requests with a unified listing of the contents of all given directories. The actual rendering of the directory contents is performed by the in-scope Marshaller[DirectoryListing].

    Definition Classes
    FileAndResourceDirectives
    Annotations
    @varargs()
  127. def logRequest(show: Function[HttpRequest, LogEntry], inner: Supplier[Route]): Route

    Produces a log entry for every incoming request.

    Produces a log entry for every incoming request.

    Definition Classes
    DebuggingDirectives
  128. def logRequest(marker: String, level: LogLevel, inner: Supplier[Route]): Route

    Produces a log entry for every incoming request.

    Produces a log entry for every incoming request.

    level

    One of the log levels defined in akka.event.Logging

    Definition Classes
    DebuggingDirectives
  129. def logRequest(marker: String, inner: Supplier[Route]): Route

    Produces a log entry for every incoming request.

    Produces a log entry for every incoming request.

    Definition Classes
    DebuggingDirectives
  130. def logRequestResult(showSuccess: BiFunction[HttpRequest, HttpResponse, LogEntry], showRejection: BiFunction[HttpRequest, List[Rejection], LogEntry], inner: Supplier[Route]): RouteAdapter

    Produces a log entry for every request/response combination.

    Produces a log entry for every request/response combination.

    showSuccess

    Function invoked when the route result was successful and yielded an HTTP response

    showRejection

    Function invoked when the route yielded a rejection

    Definition Classes
    DebuggingDirectives
  131. def logRequestResultOptional(showSuccess: BiFunction[HttpRequest, HttpResponse, Optional[LogEntry]], showRejection: BiFunction[HttpRequest, List[Rejection], Optional[LogEntry]], inner: Supplier[Route]): RouteAdapter

    Optionally produces a log entry for every request/response combination.

    Optionally produces a log entry for every request/response combination.

    showSuccess

    Function invoked when the route result was successful and yielded an HTTP response

    showRejection

    Function invoked when the route yielded a rejection

    Definition Classes
    DebuggingDirectives
    Annotations
    @CorrespondsTo()
  132. def logResult(showSuccess: Function[HttpResponse, LogEntry], showRejection: Function[List[Rejection], LogEntry], inner: Supplier[Route]): RouteAdapter

    Produces a log entry for every route result.

    Produces a log entry for every route result.

    showSuccess

    Function invoked when the route result was successful and yielded an HTTP response

    showRejection

    Function invoked when the route yielded a rejection

    Definition Classes
    DebuggingDirectives
  133. def logResult(marker: String, level: LogLevel, inner: Supplier[Route]): Route

    Produces a log entry for every route result.

    Produces a log entry for every route result.

    level

    One of the log levels defined in akka.event.Logging

    Definition Classes
    DebuggingDirectives
  134. def logResult(marker: String, inner: Supplier[Route]): Route

    Produces a log entry for every route result.

    Produces a log entry for every route result.

    Definition Classes
    DebuggingDirectives
  135. def mapInnerRoute(f: Function[Route, Route], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  136. def mapRejections(f: Function[List[Rejection], List[Rejection]], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  137. def mapRequest(f: Function[HttpRequest, HttpRequest], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  138. def mapRequestContext(f: Function[RequestContext, RequestContext], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  139. def mapResponse(f: Function[HttpResponse, HttpResponse], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  140. def mapResponseEntity(f: Function[ResponseEntity, ResponseEntity], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  141. def mapResponseHeaders(f: Function[List[HttpHeader], List[HttpHeader]], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  142. def mapRouteResult(f: Function[RouteResult, RouteResult], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  143. def mapRouteResultFuture(f: Function[CompletionStage[RouteResult], CompletionStage[RouteResult]], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  144. def mapRouteResultPF(f: PartialFunction[RouteResult, RouteResult], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  145. def mapRouteResultWith(f: Function[RouteResult, CompletionStage[RouteResult]], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  146. def mapRouteResultWithPF(f: PartialFunction[RouteResult, CompletionStage[RouteResult]], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  147. def mapSettings(f: Function[RoutingSettings, RoutingSettings], inner: Supplier[Route]): Route

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

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

    Definition Classes
    BasicDirectives
  148. def mapUnmatchedPath(f: Function[String, String], inner: Supplier[Route]): Route

    Transforms the unmatchedPath of the RequestContext using the given function.

    Transforms the unmatchedPath of the RequestContext using the given function.

    Definition Classes
    BasicDirectives
  149. def method(method: HttpMethod, inner: Supplier[Route]): Route
    Definition Classes
    MethodDirectives
  150. def optionalAttribute[T](key: AttributeKey[T], inner: Function[Optional[T], Route]): RouteAdapter

    Extracts the value of the optional request attribute with the given key.

    Extracts the value of the optional request attribute with the given key.

    Definition Classes
    AttributeDirectives
  151. def optionalCookie(name: String, inner: Function[Optional[HttpCookiePair], Route]): Route

    Extracts the HttpCookiePair with the given name as an Option[HttpCookiePair].

    Extracts the HttpCookiePair with the given name as an Option[HttpCookiePair]. If the cookie is not present a value of None is extracted.

    Definition Classes
    CookieDirectives
  152. def optionalHeaderValue[T](f: Function[HttpHeader, Optional[T]], inner: Function[Optional[T], Route]): RouteAdapter

    Extracts an optional HTTP header value using the given function.

    Extracts an optional HTTP header value using the given function. If the given function throws an exception the request is rejected with a akka.http.javadsl.server.MalformedHeaderRejection.

    Definition Classes
    HeaderDirectives
  153. def optionalHeaderValueByName(headerName: String, inner: Function[Optional[String], Route]): RouteAdapter

    Extracts the value of the optional HTTP request header with the given name.

    Extracts the value of the optional HTTP request header with the given name.

    Definition Classes
    HeaderDirectives
  154. def optionalHeaderValueByType[T <: HttpHeader](t: Class[T], inner: Function[Optional[T], Route]): RouteAdapter

    FIXME: WARNING: Custom headers don't work yet with this directive!

    FIXME: WARNING: Custom headers don't work yet with this directive!

    Extract the header value of the optional HTTP request header with the given type.

    Definition Classes
    HeaderDirectives
  155. def optionalHeaderValuePF[T](pf: PartialFunction[HttpHeader, T], inner: Function[Optional[T], Route]): RouteAdapter

    Extracts an optional HTTP header value using the given partial function.

    Extracts an optional HTTP header value using the given partial function. If the given function throws an exception the request is rejected with a akka.http.javadsl.server.MalformedHeaderRejection.

    Definition Classes
    HeaderDirectives
  156. def options(inner: Supplier[Route]): Route
    Definition Classes
    MethodDirectives
  157. def overrideMethodWithParameter(paramName: String, inner: Supplier[Route]): Route

    Changes the HTTP method of the request to the value of the specified query string parameter.

    Changes the HTTP method of the request to the value of the specified query string parameter. If the query string parameter is not specified this directive has no effect. If the query string is specified as something that is not a HTTP method, then this directive completes the request with a 501 Not Implemented response.

    This directive is useful for:

    • Use in combination with JSONP (JSONP only supports GET)
    • Supporting older browsers that lack support for certain HTTP methods. E.g. IE8 does not support PATCH
    Definition Classes
    MethodDirectives
  158. def parameter[T](t: Unmarshaller[String, T], name: String, inner: Function[T, Route]): Route
    Definition Classes
    ParameterDirectives
  159. def parameter(name: String, inner: Function[String, Route]): Route
    Definition Classes
    ParameterDirectives
  160. def parameterList(inner: Function[List[Entry[String, String]], Route]): Route
    Definition Classes
    ParameterDirectives
    Annotations
    @CorrespondsTo()
  161. def parameterList[T](t: Unmarshaller[String, T], name: String, inner: Function[List[T], Route]): Route
    Definition Classes
    ParameterDirectives
    Annotations
    @CorrespondsTo()
  162. def parameterList(name: String, inner: Function[List[String], Route]): Route
    Definition Classes
    ParameterDirectives
    Annotations
    @CorrespondsTo()
  163. def parameterMap(inner: Function[Map[String, String], Route]): Route
    Definition Classes
    ParameterDirectives
  164. def parameterMultiMap(inner: Function[Map[String, List[String]], Route]): Route
    Definition Classes
    ParameterDirectives
  165. def parameterOptional[T](t: Unmarshaller[String, T], name: String, inner: Function[Optional[T], Route]): Route
    Definition Classes
    ParameterDirectives
    Annotations
    @CorrespondsTo()
  166. def parameterOptional(name: String, inner: Function[Optional[String], Route]): Route
    Definition Classes
    ParameterDirectives
    Annotations
    @CorrespondsTo()
  167. def parameterOrDefault[T](t: Unmarshaller[String, T], defaultValue: T, name: String, inner: Function[T, Route]): Route
    Definition Classes
    ParameterDirectives
    Annotations
    @CorrespondsTo()
  168. def parameterRequiredValue[T](t: Unmarshaller[String, T], requiredValue: T, name: String, inner: Supplier[Route]): Route
    Definition Classes
    ParameterDirectives
    Annotations
    @CorrespondsTo()
  169. def pass(inner: Supplier[Route]): Route

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

    Definition Classes
    BasicDirectives
  170. def patch(inner: Supplier[Route]): Route
    Definition Classes
    MethodDirectives
  171. def path[T](t: Unmarshaller[String, T], inner: Function[T, Route]): Route

    Consumes a leading slash and extracts the next path segment, unmarshalling it and passing the result to the inner function, expecting the full path to have been consumed then.

    Consumes a leading slash and extracts the next path segment, unmarshalling it and passing the result to the inner function, expecting the full path to have been consumed then.

    Definition Classes
    PathDirectives
  172. def path[T1, T2](p: PathMatcher2[T1, T2], inner: BiFunction[T1, T2, Route]): Route
    Definition Classes
    PathDirectives
  173. def path[T](p: PathMatcher1[T], inner: Function[T, Route]): Route
    Definition Classes
    PathDirectives
  174. def path(p: PathMatcher0, inner: Supplier[Route]): Route

    Applies the given PathMatcher0 to the remaining unmatched path after consuming a leading slash.

    Applies the given PathMatcher0 to the remaining unmatched path after consuming a leading slash. The matcher has to match the remaining path completely. If matched the value extracted by the PathMatcher0 is extracted on the directive level.

    Definition Classes
    PathDirectives
  175. def path(inner: Function[String, Route]): Route
    Definition Classes
    PathDirectives
  176. def path(segment: String, inner: Supplier[Route]): Route

    Matches a prefix to the remaining unmatched path after consuming a leading slash.

    Matches a prefix to the remaining unmatched path after consuming a leading slash. The matcher has to match the remaining path completely. If matched the value matching the prefix is extracted on the directive level.

    Definition Classes
    PathDirectives
  177. def pathEnd(inner: Supplier[Route]): Route

    Rejects the request if the unmatchedPath of the akka.http.javadsl.server.RequestContext is non-empty, or said differently: only passes on the request to its inner route if the request path has been matched completely.

    Rejects the request if the unmatchedPath of the akka.http.javadsl.server.RequestContext is non-empty, or said differently: only passes on the request to its inner route if the request path has been matched completely.

    Definition Classes
    PathDirectives
  178. def pathEndOrSingleSlash(inner: Supplier[Route]): Route

    Only passes on the request to its inner route if the request path has been matched completely or only consists of exactly one remaining slash.

    Only passes on the request to its inner route if the request path has been matched completely or only consists of exactly one remaining slash.

    Note that trailing slash and non-trailing slash URLs are not the same, although they often serve the same content. It is recommended to serve only one URL version and make the other redirect to it using #redirectToTrailingSlashIfMissing or #redirectToNoTrailingSlashIfPresent directive.

    For example:

    def route = {
      // redirect '/users/' to '/users', '/users/:userId/' to '/users/:userId'
      redirectToNoTrailingSlashIfPresent(Found) {
        pathPrefix("users") {
          concat(
            pathEnd {
              // user list ...
            },
            path(UUID) { userId =>
              // user profile ...
            }
          )
        }
      }
    }

    For further information, refer to: http://googlewebmastercentral.blogspot.de/2010/04/to-slash-or-not-to-slash.html

    Definition Classes
    PathDirectives
  179. def pathPrefix[T](t: Unmarshaller[String, T], inner: Function[T, Route]): Route

    Consumes a leading slash and extracts the next path segment, unmarshalling it and passing the result to the inner function.

    Consumes a leading slash and extracts the next path segment, unmarshalling it and passing the result to the inner function.

    Definition Classes
    PathDirectives
  180. def pathPrefix[T1, T2](p: PathMatcher2[T1, T2], inner: BiFunction[T1, T2, Route]): Route
    Definition Classes
    PathDirectives
  181. def pathPrefix[T](p: PathMatcher1[T], inner: Function[T, Route]): Route
    Definition Classes
    PathDirectives
  182. def pathPrefix(p: PathMatcher0, inner: Supplier[Route]): Route

    Applies the given PathMatcher0 to the remaining unmatched path after consuming a leading slash.

    Applies the given PathMatcher0 to the remaining unmatched path after consuming a leading slash. The matcher has to match a prefix of the remaining path. If matched the value extracted by the PathMatcher is extracted on the directive level.

    Definition Classes
    PathDirectives
  183. def pathPrefix(inner: Function[String, Route]): Route
    Definition Classes
    PathDirectives
  184. def pathPrefix(segment: String, inner: Supplier[Route]): Route

    Matches a prefix to the remaining unmatched path after consuming a leading slash.

    Matches a prefix to the remaining unmatched path after consuming a leading slash. The matcher has to match a prefix of the remaining path. If matched the value matching the prefix is extracted on the directive level.

    Definition Classes
    PathDirectives
  185. def pathPrefixTest[T1, T2](pm: PathMatcher2[T1, T2], inner: BiFunction[T1, T2, Route]): Route
    Definition Classes
    PathDirectives
  186. def pathPrefixTest[T1](pm: PathMatcher1[T1], inner: Function[T1, Route]): Route
    Definition Classes
    PathDirectives
  187. def pathPrefixTest(pm: PathMatcher0, inner: Supplier[Route]): Route
    Definition Classes
    PathDirectives
  188. def pathPrefixTest(segment: String, inner: Supplier[Route]): Route

    Checks whether the unmatchedPath of the akka.http.javadsl.server.RequestContext has a prefix matched by the given PathMatcher.

    Checks whether the unmatchedPath of the akka.http.javadsl.server.RequestContext has a prefix matched by the given PathMatcher. In analogy to the pathPrefix directive a leading slash is implied.

    Definition Classes
    PathDirectives
  189. def pathSingleSlash(inner: Supplier[Route]): Route

    Only passes on the request to its inner route if the request path consists of exactly one remaining slash.

    Only passes on the request to its inner route if the request path consists of exactly one remaining slash.

    Definition Classes
    PathDirectives
  190. def pathSuffix[T1, T2](pm: PathMatcher2[T1, T2], inner: BiFunction[T1, T2, Route]): Route
    Definition Classes
    PathDirectives
  191. def pathSuffix[T1](pm: PathMatcher1[T1], inner: Function[T1, Route]): Route
    Definition Classes
    PathDirectives
  192. def pathSuffix(pm: PathMatcher0, inner: Supplier[Route]): Route
    Definition Classes
    PathDirectives
  193. def pathSuffix(segment: String, inner: Supplier[Route]): Route

    Applies the given akka.http.scaladsl.server.PathMatcher to a suffix of the remaining unmatchedPath of the akka.http.javadsl.server.RequestContext.

    Applies the given akka.http.scaladsl.server.PathMatcher to a suffix of the remaining unmatchedPath of the akka.http.javadsl.server.RequestContext. If matched the value extracted by the akka.http.javadsl.server.PathMatcher0 is extracted and the matched parts of the path are consumed. Note that, for efficiency reasons, the given akka.http.javadsl.server.PathMatcher0 must match the desired suffix in reversed-segment order, i.e. pathSuffix("baz" / "bar") would match /foo/bar/baz!

    Definition Classes
    PathDirectives
  194. def pathSuffixTest[T1, T2](pm: PathMatcher2[T1, T2], inner: BiFunction[T1, T2, Route]): Route
    Definition Classes
    PathDirectives
  195. def pathSuffixTest[T1](pm: PathMatcher1[T1], inner: Function[T1, Route]): Route
    Definition Classes
    PathDirectives
  196. def pathSuffixTest(pm: PathMatcher0, inner: Supplier[Route]): Route
    Definition Classes
    PathDirectives
  197. def pathSuffixTest(segment: String, inner: Supplier[Route]): Route

    Checks whether the unmatchedPath of the akka.http.javadsl.server.RequestContext has a suffix matched by the given PathMatcher.

    Checks whether the unmatchedPath of the akka.http.javadsl.server.RequestContext has a suffix matched by the given PathMatcher. However, as opposed to the pathSuffix directive the matched path is not actually "consumed". Note that, for efficiency reasons, the given PathMatcher must match the desired suffix in reversed-segment order, i.e. pathSuffixTest("baz" / "bar") would match /foo/bar/baz!

    Definition Classes
    PathDirectives
  198. def post(inner: Supplier[Route]): Route
    Definition Classes
    MethodDirectives
  199. def provide[T](t: T, inner: Function[T, Route]): Route

    Injects the given value into a directive.

    Injects the given value into a directive.

    Definition Classes
    BasicDirectives
  200. def put(inner: Supplier[Route]): Route
    Definition Classes
    MethodDirectives
  201. def rawPathPrefix[T1, T2](pm: PathMatcher2[T1, T2], inner: BiFunction[T1, T2, Route]): Route
    Definition Classes
    PathDirectives
  202. def rawPathPrefix[T1](pm: PathMatcher1[T1], inner: Function[T1, Route]): Route
    Definition Classes
    PathDirectives
  203. def rawPathPrefix(pm: PathMatcher0, inner: Supplier[Route]): Route
    Definition Classes
    PathDirectives
  204. def rawPathPrefix(segment: String, inner: Supplier[Route]): Route

    Applies the given matcher directly to a prefix of the unmatched path of the akka.http.javadsl.server.RequestContext (i.e.

    Applies the given matcher directly to a prefix of the unmatched path of the akka.http.javadsl.server.RequestContext (i.e. without implicitly consuming a leading slash). The matcher has to match a prefix of the remaining path. If matched the value extracted by the PathMatcher is extracted on the directive level.

    Definition Classes
    PathDirectives
  205. def rawPathPrefixTest[T1, T2](pm: PathMatcher2[T1, T2], inner: BiFunction[T1, T2, Route]): Route
    Definition Classes
    PathDirectives
  206. def rawPathPrefixTest[T1](pm: PathMatcher1[T1], inner: Function[T1, Route]): Route
    Definition Classes
    PathDirectives
  207. def rawPathPrefixTest(pm: PathMatcher0, inner: Supplier[Route]): Route
    Definition Classes
    PathDirectives
  208. def rawPathPrefixTest(segment: String, inner: Supplier[Route]): Route

    Checks whether the unmatchedPath of the akka.http.javadsl.server.RequestContext has a prefix matched by the given PathMatcher.

    Checks whether the unmatchedPath of the akka.http.javadsl.server.RequestContext has a prefix matched by the given PathMatcher. However, as opposed to the pathPrefix directive the matched path is not actually "consumed".

    Definition Classes
    PathDirectives
  209. def recoverRejections(f: Function[Iterable[Rejection], RouteResult], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  210. def recoverRejectionsWith(f: Function[Iterable[Rejection], CompletionStage[RouteResult]], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  211. def redirect(uri: Uri, redirectionType: StatusCode): Route

    Completes the request with redirection response of the given type to the given URI.

    Completes the request with redirection response of the given type to the given URI.

    redirectionType

    A status code from StatusCodes, which must be a redirection type.

  212. def redirectToNoTrailingSlashIfPresent(redirectionType: StatusCode, inner: Supplier[Route]): Route

    If the request path ends with a slash, redirect to the same uri without trailing slash in the path.

    If the request path ends with a slash, redirect to the same uri without trailing slash in the path.

    Caveat: #pathSingleSlash directive will not match inside of this directive.

    redirectionType

    A status code from StatusCodes, which must be a redirection type.

    Definition Classes
    PathDirectives
  213. def redirectToTrailingSlashIfMissing(redirectionType: StatusCode, inner: Supplier[Route]): Route

    If the request path doesn't end with a slash, redirect to the same uri with trailing slash in the path.

    If the request path doesn't end with a slash, redirect to the same uri with trailing slash in the path.

    Caveat: #path without trailing slash and #pathEnd directives will not match inside of this directive.

    redirectionType

    A status code from StatusCodes, which must be a redirection type.

    Definition Classes
    PathDirectives
  214. def reject(): Route

    Rejects the request with an empty rejection (usually used for "no directive matched").

  215. def reject(rejection: Rejection, rejections: Rejection*): Route

    Rejects the request with the given rejections, or with an empty set of rejections if no rejections are given.

    Rejects the request with the given rejections, or with an empty set of rejections if no rejections are given.

    Annotations
    @varargs()
  216. def rejectEmptyResponse(inner: Supplier[Route]): Route

    Converts responses with an empty entity into (empty) rejections.

    Converts responses with an empty entity into (empty) rejections. This way you can, for example, have the marshalling of a None option be treated as if the request could not be matched.

    Definition Classes
    MiscDirectives
  217. def request[T](unmarshaller: Unmarshaller[_ >: HttpRequest, T], inner: Function[T, Route]): Route

    Unmarshalls the request using the given unmarshaller, and passes the result to [inner].

    Unmarshalls the request using the given unmarshaller, and passes the result to [inner]. If there is a problem with unmarshalling the request is rejected with the akka.http.javadsl.server.Rejection produced by the unmarshaller.

    Definition Classes
    MarshallingDirectives
  218. def requestEncodedWith(encoding: HttpEncoding, inner: Supplier[Route]): Route

    Rejects the request with an UnsupportedRequestEncodingRejection if its encoding doesn't match the given one.

    Rejects the request with an UnsupportedRequestEncodingRejection if its encoding doesn't match the given one.

    Definition Classes
    CodingDirectives
  219. def requestEntityEmpty(inner: Supplier[Route]): Route

    Rejects if the request entity is non-empty.

    Rejects if the request entity is non-empty.

    Definition Classes
    MiscDirectives
  220. def requestEntityPresent(inner: Supplier[Route]): Route

    Rejects with a RequestEntityExpectedRejection if the request entity is empty.

    Rejects with a RequestEntityExpectedRejection if the request entity is empty. Non-empty requests are passed on unchanged to the inner route.

    Definition Classes
    MiscDirectives
  221. def respondWithDefaultHeader(responseHeader: HttpHeader, inner: Supplier[Route]): Route

    Adds the given response header to all HTTP responses of its inner Route, if the response from the inner Route doesn't already contain a header with the same name.

    Adds the given response header to all HTTP responses of its inner Route, if the response from the inner Route doesn't already contain a header with the same name.

    Definition Classes
    RespondWithDirectives
  222. def respondWithDefaultHeaders(responseHeaders: Iterable[HttpHeader], inner: Supplier[Route]): Route

    Adds the given response headers to all HTTP responses of its inner Route, if a header already exists it is not added again.

    Adds the given response headers to all HTTP responses of its inner Route, if a header already exists it is not added again.

    Definition Classes
    RespondWithDirectives
  223. def respondWithHeader(responseHeader: HttpHeader, inner: Supplier[Route]): Route

    Unconditionally adds the given response header to all HTTP responses of its inner Route.

    Unconditionally adds the given response header to all HTTP responses of its inner Route.

    Definition Classes
    RespondWithDirectives
  224. def respondWithHeaders(responseHeaders: Iterable[HttpHeader], inner: Supplier[Route]): Route

    Unconditionally adds the given response headers to all HTTP responses of its inner Route.

    Unconditionally adds the given response headers to all HTTP responses of its inner Route.

    Definition Classes
    RespondWithDirectives
  225. def responseEncodingAccepted(encoding: HttpEncoding, inner: Supplier[Route]): Route

    Rejects the request with an UnacceptedResponseEncodingRejection if the given response encoding is not accepted by the client.

    Rejects the request with an UnacceptedResponseEncodingRejection if the given response encoding is not accepted by the client.

    Definition Classes
    CodingDirectives
  226. def selectPreferredLanguage(languages: Iterable[Language], inner: Function[Language, Route]): Route

    Inspects the request's Accept-Language header and determines, which of the given language alternatives is preferred by the client.

    Inspects the request's Accept-Language header and determines, which of the given language alternatives is preferred by the client. (See http://tools.ietf.org/html/rfc7231#section-5.3.5 for more details on the negotiation logic.) If there are several best language alternatives that the client has equal preference for (even if this preference is zero!) the order of the arguments is used as a tie breaker (First one wins).

    If [languages] is empty, the route is rejected.

    Definition Classes
    MiscDirectives
  227. def setCookie(cookies: Iterable[HttpCookie], inner: Supplier[Route]): Route

    Adds a Set-Cookie response header with the given cookies.

    Adds a Set-Cookie response header with the given cookies.

    Definition Classes
    CookieDirectives
  228. def setCookie(cookie: HttpCookie, inner: Supplier[Route]): Route

    Adds a Set-Cookie response header with the given cookie.

    Adds a Set-Cookie response header with the given cookie.

    Definition Classes
    CookieDirectives
  229. def storeUploadedFile(fieldName: String, destFn: Function[FileInfo, File], inner: BiFunction[FileInfo, File, Route]): Route

    Streams the bytes of the file submitted using multipart with the given file name into a designated file on disk.

    Streams the bytes of the file submitted using multipart with the given file name into a designated file on disk. If there is an error writing to disk the request will be failed with the thrown exception, if there is no such field the request will be rejected, if there are multiple file parts with the same name, the first one will be used and the subsequent ones ignored.

    Definition Classes
    FileUploadDirectives
  230. def storeUploadedFiles(fieldName: String, destFn: Function[FileInfo, File], inner: Function[List[Entry[FileInfo, File]], Route]): Route

    Streams the bytes of the file submitted using multipart with the given field name into designated files on disk.

    Streams the bytes of the file submitted using multipart with the given field name into designated files on disk. If there is an error writing to disk the request will be failed with the thrown exception, if there is no such field the request will be rejected. Stored files are cleaned up on exit but not on failure.

    Definition Classes
    FileUploadDirectives
  231. def toStrictEntity(timeout: FiniteDuration, maxBytes: Long, inner: Supplier[Route]): Route

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

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

    To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the akka.http.parsing.max-to-strict-bytes configuration setting.

    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.

    Definition Classes
    BasicDirectives
  232. def toStrictEntity(timeout: FiniteDuration, inner: Supplier[Route]): Route

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

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

    To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the akka.http.parsing.max-to-strict-bytes configuration setting.

    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.

    Definition Classes
    BasicDirectives
  233. def validate(check: BooleanSupplier, errorMsg: String, inner: Supplier[Route]): Route

    Checks the given condition before running its inner route.

    Checks the given condition before running its inner route. If the condition fails the route is rejected with a ValidationRejection.

    Definition Classes
    MiscDirectives
  234. def withExecutionContext(ec: ExecutionContextExecutor, inner: Supplier[Route]): Route

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

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

    Definition Classes
    BasicDirectives
  235. def withLog(log: LoggingAdapter, inner: Supplier[Route]): Route

    Runs its inner route with the given alternative LoggingAdapter.

    Runs its inner route with the given alternative LoggingAdapter.

    Definition Classes
    BasicDirectives
  236. def withMaterializer(mat: Materializer, inner: Supplier[Route]): Route

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

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

    Definition Classes
    BasicDirectives
  237. def withPrecompressedMediaTypeSupport(inner: Supplier[Route]): Route

    Inspects the response entity and adds a Content-Encoding: gzip response header if the entity's media-type is precompressed with gzip and no Content-Encoding header is present yet.

    Inspects the response entity and adds a Content-Encoding: gzip response header if the entity's media-type is precompressed with gzip and no Content-Encoding header is present yet.

    Definition Classes
    CodingDirectives
  238. def withRangeSupport(inner: Supplier[Route]): Route

    Answers GET requests with an Accept-Ranges: bytes header and converts HttpResponses coming back from its inner route into partial responses if the initial request contained a valid Range request header.

    Answers GET requests with an Accept-Ranges: bytes header and converts HttpResponses coming back from its inner route into partial responses if the initial request contained a valid Range request header. The requested byte-ranges may be coalesced. This directive is transparent to non-GET requests Rejects requests with unsatisfiable ranges UnsatisfiableRangeRejection. Rejects requests with too many expected ranges.

    Note: if you want to combine this directive with conditional(...) you need to put it on the *inside* of the conditional(...) directive, i.e. conditional(...) must be on a higher level in your route structure in order to function correctly.

    For more information, see: https://tools.ietf.org/html/rfc7233

    Definition Classes
    RangeDirectives
  239. def withSettings(s: RoutingSettings, inner: Supplier[Route]): Route

    Runs its inner route with the given alternative RoutingSettings.

    Runs its inner route with the given alternative RoutingSettings.

    Definition Classes
    BasicDirectives
  240. def withSizeLimit(maxBytes: Long, inner: Supplier[Route]): Route

    Fails the stream with akka.http.scaladsl.model.EntityStreamSizeException if its request entity size exceeds given limit.

    Fails the stream with akka.http.scaladsl.model.EntityStreamSizeException if its request entity size exceeds given limit. Limit given as parameter overrides limit configured with akka.http.parsing.max-content-length.

    Beware that request entity size check is executed when entity is consumed.

    Definition Classes
    MiscDirectives
  241. def withoutSizeLimit(inner: Supplier[Route]): Route

    Disables the size limit (configured by akka.http.parsing.max-content-length by default) checking on the incoming akka.http.javadsl.model.HttpRequest entity.

    Disables the size limit (configured by akka.http.parsing.max-content-length by default) checking on the incoming akka.http.javadsl.model.HttpRequest entity. Can be useful when handling arbitrarily large data uploads in specific parts of your routes.

    Definition Classes
    MiscDirectives
    Note

    Usage of withoutSizeLimit is not recommended as it turns off the too large payload protection. Therefore, we highly encourage using withSizeLimit instead, providing it with a value high enough to successfully handle the route in need of big entities.

  242. def route(alternatives: Route*): Route

    Java-specific call added so you can chain together multiple alternate routes using comma, rather than having to explicitly call route1.orElse(route2).orElse(route3).

    Java-specific call added so you can chain together multiple alternate routes using comma, rather than having to explicitly call route1.orElse(route2).orElse(route3).

    Annotations
    @Deprecated @deprecated @CorrespondsTo() @varargs()
    Deprecated

    (Since version 10.1.6) Use the RouteDirectives.concat method instead.