abstract class AttributeDirectives extends HeaderDirectives

Source
AttributeDirectives.scala
Linear Supertypes
HeaderDirectives, FutureDirectives, FormFieldDirectives, FileUploadDirectives, FileAndResourceDirectives, ExecutionDirectives, DebuggingDirectives, CookieDirectives, CodingDirectives, CacheConditionDirectives, BasicDirectives, AnyRef, Any
Known Subclasses
AllDirectives, Directives, FramedEntityStreamingDirectives, FramedEntityStreamingDirectives, HostDirectives, MarshallingDirectives, MethodDirectives, MiscDirectives, ParameterDirectives, PathDirectives, RangeDirectives, RespondWithDirectives, RouteDirectives, SchemeDirectives, SecurityDirectives, TimeoutDirectives, WebSocketDirectives, JUnitRouteTest, JUnitRouteTestBase, RouteTest, HttpApp
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. AttributeDirectives
  2. HeaderDirectives
  3. FutureDirectives
  4. FormFieldDirectives
  5. FileUploadDirectives
  6. FileAndResourceDirectives
  7. ExecutionDirectives
  8. DebuggingDirectives
  9. CookieDirectives
  10. CodingDirectives
  11. CacheConditionDirectives
  12. BasicDirectives
  13. AnyRef
  14. 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 pekko.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 pekko.http.javadsl.server.MissingAttributeRejection.

  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 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
  6. 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
  7. 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
  8. 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
  9. 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 pekko.http.javadsl.server.MissingCookieRejection.

    Definition Classes
    CookieDirectives
  10. 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
  11. 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
  12. 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
  13. def defaultContentTypeResolver: ContentTypeResolver

    Default ContentTypeResolver.

    Default ContentTypeResolver.

    Definition Classes
    FileAndResourceDirectives
  14. def defaultDirectoryRenderer: DirectoryRenderer

    Default DirectoryRenderer to be used with directory listing directives.

    Default DirectoryRenderer to be used with directory listing directives.

    Definition Classes
    FileAndResourceDirectives
  15. 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
  16. 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
  17. 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
  18. 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
  19. 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
  20. 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
  21. 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
  22. 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
  23. def extractActorSystem(inner: Function[ActorSystem, Route]): Route

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

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

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

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

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

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

    Extracts the current http request entity.

    Extracts the current http request entity.

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

    Extracts the ExecutionContextExecutor from the RequestContext.

    Extracts the ExecutionContextExecutor from the RequestContext.

    Definition Classes
    BasicDirectives
  27. def extractLog(inner: Function[LoggingAdapter, Route]): Route

    Extracts the LoggingAdapter

    Extracts the LoggingAdapter

    Definition Classes
    BasicDirectives
  28. 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
  29. def extractMaterializer(inner: Function[Materializer, Route]): Route

    Extracts the Materializer from the RequestContext.

    Extracts the Materializer from the RequestContext.

    Definition Classes
    BasicDirectives
  30. def extractParserSettings(inner: Function[ParserSettings, Route]): RouteAdapter

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

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

    Definition Classes
    BasicDirectives
  31. def extractRequest(inner: Function[HttpRequest, Route]): RouteAdapter

    Extracts the current HttpRequest instance.

    Extracts the current HttpRequest instance.

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

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

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

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

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

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

    Definition Classes
    BasicDirectives
  34. def extractSettings(inner: Function[RoutingSettings, Route]): RouteAdapter

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

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

    Definition Classes
    BasicDirectives
  35. 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 pekko.http.parsing.max-to-strict-bytes configuration setting.

    Converts the HttpEntity from the pekko.http.javadsl.server.RequestContext into an pekko.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
  36. 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 pekko.http.parsing.max-to-strict-bytes configuration setting.

    Converts the HttpEntity from the pekko.http.javadsl.server.RequestContext into an pekko.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
  37. 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
  38. def extractUri(inner: Function[Uri, Route]): RouteAdapter

    Extracts the complete request URI.

    Extracts the complete request URI.

    Definition Classes
    BasicDirectives
  39. 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
  40. 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
    Annotations
    @ApiMayChange()
  41. def formField[T](t: Unmarshaller[String, T], name: String, inner: Function[T, Route]): Route
    Definition Classes
    FormFieldDirectives
  42. def formField(name: String, inner: Function[String, Route]): Route
    Definition Classes
    FormFieldDirectives
  43. 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()
  44. def formFieldList[T](t: Unmarshaller[String, T], name: String, inner: Function[List[T], Route]): Route
    Definition Classes
    FormFieldDirectives
    Annotations
    @CorrespondsTo()
  45. def formFieldList(name: String, inner: Function[List[String], Route]): Route
    Definition Classes
    FormFieldDirectives
    Annotations
    @CorrespondsTo()
  46. 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
  47. 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
  48. def formFieldOptional[T](t: Unmarshaller[String, T], name: String, inner: Function[Optional[T], Route]): Route
    Definition Classes
    FormFieldDirectives
    Annotations
    @CorrespondsTo()
  49. def formFieldOptional(name: String, inner: Function[Optional[String], Route]): Route
    Definition Classes
    FormFieldDirectives
    Annotations
    @CorrespondsTo()
  50. 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()
  51. 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
  52. 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
  53. 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
  54. def getFromBrowseableDirectory(directory: String): Route

    Same as getFromBrowseableDirectories with only one directory.

    Same as getFromBrowseableDirectories with only one directory.

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

    Same as getFromBrowseableDirectories with only one directory.

    Same as getFromBrowseableDirectories with only one directory.

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

    Same as getFromBrowseableDirectories with only one directory.

    Same as getFromBrowseableDirectories with only one directory.

    Definition Classes
    FileAndResourceDirectives
  57. 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
  58. 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
  59. 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
  60. 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
  61. 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
  62. 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
  63. 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
  64. 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
  65. 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
  66. 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
  67. 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
  68. 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
  69. 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
  70. 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
  71. 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
  72. 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
  73. def handleExceptions(handler: ExceptionHandler, inner: Supplier[Route]): RouteAdapter

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

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

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

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

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

    Definition Classes
    ExecutionDirectives
  75. 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 pekko.http.javadsl.server.MalformedHeaderRejection.

    Definition Classes
    HeaderDirectives
  76. 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 pekko.http.javadsl.server.MissingHeaderRejection.

    Definition Classes
    HeaderDirectives
  77. 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 pekko.http.javadsl.server.MissingHeaderRejection.

    Definition Classes
    HeaderDirectives
  78. 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
  79. 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()
  80. 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()
  81. 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
  82. 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 pekko.event.Logging

    Definition Classes
    DebuggingDirectives
  83. 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
  84. 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
  85. 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()
  86. 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
  87. 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 pekko.event.Logging

    Definition Classes
    DebuggingDirectives
  88. 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
  89. def mapInnerRoute(f: Function[Route, Route], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  90. def mapRejections(f: Function[List[Rejection], List[Rejection]], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  91. def mapRequest(f: Function[HttpRequest, HttpRequest], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  92. def mapRequestContext(f: Function[RequestContext, RequestContext], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  93. def mapResponse(f: Function[HttpResponse, HttpResponse], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  94. def mapResponseEntity(f: Function[ResponseEntity, ResponseEntity], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  95. def mapResponseHeaders(f: Function[List[HttpHeader], List[HttpHeader]], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  96. def mapRouteResult(f: Function[RouteResult, RouteResult], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  97. def mapRouteResultFuture(f: Function[CompletionStage[RouteResult], CompletionStage[RouteResult]], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  98. def mapRouteResultPF(f: PartialFunction[RouteResult, RouteResult], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  99. def mapRouteResultWith(f: Function[RouteResult, CompletionStage[RouteResult]], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  100. def mapRouteResultWithPF(f: PartialFunction[RouteResult, CompletionStage[RouteResult]], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  101. 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
  102. 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
  103. def optionalAttribute[T](key: AttributeKey[T], inner: Function[Optional[T], Route]): RouteAdapter

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

  104. 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
  105. 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 pekko.http.javadsl.server.MalformedHeaderRejection.

    Definition Classes
    HeaderDirectives
  106. 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
  107. 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
  108. 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 pekko.http.javadsl.server.MalformedHeaderRejection.

    Definition Classes
    HeaderDirectives
  109. 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
  110. 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
  111. def recoverRejections(f: Function[Iterable[Rejection], RouteResult], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  112. def recoverRejectionsWith(f: Function[Iterable[Rejection], CompletionStage[RouteResult]], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  113. 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
  114. 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
  115. 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
  116. 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
  117. 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
    Annotations
    @ApiMayChange()
  118. 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
    Annotations
    @ApiMayChange()
  119. 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 pekko.http.parsing.max-to-strict-bytes configuration setting.

    Extracts the pekko.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
  120. 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 pekko.http.parsing.max-to-strict-bytes configuration setting.

    Extracts the pekko.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
  121. 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
  122. 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
  123. def withMaterializer(mat: Materializer, inner: Supplier[Route]): Route

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

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

    Definition Classes
    BasicDirectives
  124. 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
  125. 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