c

akka.http.javadsl.server.directives

FileAndResourceDirectives

abstract class FileAndResourceDirectives extends ExecutionDirectives

Directives that load files and resources.

For the directives in this class, the "default classloader" is defined as the classloader that has loaded the akka.actor.ActorSystem class.

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

Instance Constructors

  1. new FileAndResourceDirectives()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from FileAndResourceDirectives toany2stringadd[FileAndResourceDirectives] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (FileAndResourceDirectives, B)
    Implicit
    This member is added by an implicit conversion from FileAndResourceDirectives toArrowAssoc[FileAndResourceDirectives] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def 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
  8. 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
  9. 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
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  11. 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
  12. 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
  13. 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
  14. 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
  15. 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
  16. 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
  17. 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
  18. 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
  19. def defaultContentTypeResolver: ContentTypeResolver

    Default ContentTypeResolver.

  20. def defaultDirectoryRenderer: DirectoryRenderer

    Default DirectoryRenderer to be used with directory listing directives.

  21. 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
  22. 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
  23. 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
  24. 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
  25. 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
  26. 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
  27. 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
  28. def ensuring(cond: (FileAndResourceDirectives) => Boolean, msg: => Any): FileAndResourceDirectives
    Implicit
    This member is added by an implicit conversion from FileAndResourceDirectives toEnsuring[FileAndResourceDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. def ensuring(cond: (FileAndResourceDirectives) => Boolean): FileAndResourceDirectives
    Implicit
    This member is added by an implicit conversion from FileAndResourceDirectives toEnsuring[FileAndResourceDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  30. def ensuring(cond: Boolean, msg: => Any): FileAndResourceDirectives
    Implicit
    This member is added by an implicit conversion from FileAndResourceDirectives toEnsuring[FileAndResourceDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  31. def ensuring(cond: Boolean): FileAndResourceDirectives
    Implicit
    This member is added by an implicit conversion from FileAndResourceDirectives toEnsuring[FileAndResourceDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  32. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  34. 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
  35. 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
  36. 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
  37. def extractEntity(inner: Function[RequestEntity, Route]): Route

    Extracts the current http request entity.

    Extracts the current http request entity.

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

    Extracts the ExecutionContextExecutor from the RequestContext.

    Extracts the ExecutionContextExecutor from the RequestContext.

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

    Extracts the LoggingAdapter

    Extracts the LoggingAdapter

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

    Extracts the Materializer from the RequestContext.

    Extracts the Materializer from the RequestContext.

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

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

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

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

    Extracts the current HttpRequest instance.

    Extracts the current HttpRequest instance.

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

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

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

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

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

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

    Definition Classes
    BasicDirectives
  46. 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
  47. 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
  48. 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
  49. 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
  50. def extractUri(inner: Function[Uri, Route]): RouteAdapter

    Extracts the complete request URI.

    Extracts the complete request URI.

    Definition Classes
    BasicDirectives
  51. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  52. 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.

    Annotations
    @varargs()
  53. 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.

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

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

  56. def getFromBrowseableDirectory(directory: String): Route

    Same as getFromBrowseableDirectories with only one directory.

  57. def getFromBrowseableDirectory(directory: String, resolver: ContentTypeResolver): Route

    Same as getFromBrowseableDirectories with only one directory.

  58. def getFromBrowseableDirectory(directory: String, renderer: DirectoryRenderer): Route

    Same as getFromBrowseableDirectories with only one directory.

  59. def getFromBrowseableDirectory(directory: String, renderer: DirectoryRenderer, resolver: ContentTypeResolver): Route

    Same as getFromBrowseableDirectories with only one directory.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  75. 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
  76. 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
  77. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  78. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  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].

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

    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 akka.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 akka.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. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  104. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  105. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  106. 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
  107. 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
  108. 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
  109. def recoverRejections(f: Function[Iterable[Rejection], RouteResult], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  110. def recoverRejectionsWith(f: Function[Iterable[Rejection], CompletionStage[RouteResult]], inner: Supplier[Route]): Route
    Definition Classes
    BasicDirectives
  111. 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
  112. 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
  113. 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
  114. 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
  115. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  116. 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
  117. 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
  118. def toString(): String
    Definition Classes
    AnyRef → Any
  119. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  120. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  121. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  122. 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
  123. 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
  124. 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
  125. 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
  126. 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

Deprecated Value Members

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

    (Since version 9)

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

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

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

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

Inherited from ExecutionDirectives

Inherited from DebuggingDirectives

Inherited from CookieDirectives

Inherited from CodingDirectives

Inherited from CacheConditionDirectives

Inherited from BasicDirectives

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromFileAndResourceDirectives to any2stringadd[FileAndResourceDirectives]

Inherited by implicit conversion StringFormat fromFileAndResourceDirectives to StringFormat[FileAndResourceDirectives]

Inherited by implicit conversion Ensuring fromFileAndResourceDirectives to Ensuring[FileAndResourceDirectives]

Inherited by implicit conversion ArrowAssoc fromFileAndResourceDirectives to ArrowAssoc[FileAndResourceDirectives]

Ungrouped