Apache Pekko HTTP
1.1.0
API
Generated with
Apache Pekko HTTP/org.apache.pekko.http/org.apache.pekko.http.javadsl/org.apache.pekko.http.javadsl.server/org.apache.pekko.http.javadsl.server.directives/FileAndResourceDirectives

FileAndResourceDirectives

org.apache.pekko.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 pekko.actor.ActorSystem class.

Attributes

Source
FileAndResourceDirectives.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Show all
Known subtypes
object Directives
Show all

Members list

Value members

Concrete methods

def defaultContentTypeResolver: ContentTypeResolver

Default ContentTypeResolver.

Default ContentTypeResolver.

Attributes

Source
FileAndResourceDirectives.scala
def defaultDirectoryRenderer: DirectoryRenderer

Default DirectoryRenderer to be used with directory listing directives.

Default DirectoryRenderer to be used with directory listing directives.

Attributes

Source
FileAndResourceDirectives.scala
def getFromBrowseableDirectories(directories: Iterable[String], renderer: DirectoryRenderer, resolver: ContentTypeResolver): Route

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

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

Attributes

Source
FileAndResourceDirectives.scala
def getFromBrowseableDirectories(directories: Iterable[String], renderer: DirectoryRenderer): Route

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

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

Attributes

Source
FileAndResourceDirectives.scala
def getFromBrowseableDirectories(directories: Iterable[String], resolver: ContentTypeResolver): Route

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

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

Attributes

Source
FileAndResourceDirectives.scala
def getFromBrowseableDirectories(directories: String*): Route

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

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

Attributes

Source
FileAndResourceDirectives.scala
def getFromBrowseableDirectory(directory: String, renderer: DirectoryRenderer, resolver: ContentTypeResolver): Route

Same as getFromBrowseableDirectories with only one directory.

Same as getFromBrowseableDirectories with only one directory.

Attributes

Source
FileAndResourceDirectives.scala
def getFromBrowseableDirectory(directory: String, renderer: DirectoryRenderer): Route

Same as getFromBrowseableDirectories with only one directory.

Same as getFromBrowseableDirectories with only one directory.

Attributes

Source
FileAndResourceDirectives.scala
def getFromBrowseableDirectory(directory: String, resolver: ContentTypeResolver): Route

Same as getFromBrowseableDirectories with only one directory.

Same as getFromBrowseableDirectories with only one directory.

Attributes

Source
FileAndResourceDirectives.scala
def getFromBrowseableDirectory(directory: String): Route

Same as getFromBrowseableDirectories with only one directory.

Same as getFromBrowseableDirectories with only one directory.

Attributes

Source
FileAndResourceDirectives.scala
def getFromDirectory(directoryPath: String): Route

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.

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.

Attributes

Source
FileAndResourceDirectives.scala
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. If the file cannot be read the Route rejects the request.

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.

Attributes

Source
FileAndResourceDirectives.scala
def getFromFile(file: File): Route

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.

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.

Attributes

Source
FileAndResourceDirectives.scala
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. If the file cannot be found or read the request is rejected.

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.

Attributes

Source
FileAndResourceDirectives.scala
def getFromFile(file: File, contentType: ContentType): Route

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.

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.

Attributes

Source
FileAndResourceDirectives.scala
def getFromFile(file: String): Route

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.

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.

Attributes

Source
FileAndResourceDirectives.scala
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. If the file cannot be found or read the request is rejected.

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.

Attributes

Source
FileAndResourceDirectives.scala
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. If the resource cannot be found or read the Route rejects the request.

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.

Attributes

Source
FileAndResourceDirectives.scala
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. If the resource cannot be found or read the Route rejects the request.

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.

Attributes

Source
FileAndResourceDirectives.scala
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. If the resource cannot be found or read the Route rejects the request.

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.

Attributes

Source
FileAndResourceDirectives.scala
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. If the resource cannot be found or read the Route rejects the request.

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.

Attributes

Source
FileAndResourceDirectives.scala
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.

Attributes

Source
FileAndResourceDirectives.scala
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.

Attributes

Source
FileAndResourceDirectives.scala
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.

Attributes

Source
FileAndResourceDirectives.scala
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.

Attributes

Source
FileAndResourceDirectives.scala
def listDirectoryContents(directories: String*): Route

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

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

Attributes

Source
FileAndResourceDirectives.scala
def listDirectoryContents(directoryRenderer: DirectoryRenderer, directories: String*): Route

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

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

Attributes

Source
FileAndResourceDirectives.scala

Inherited methods

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.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Attributes

Inherited from:
CacheConditionDirectives
Source
CacheConditionDirectives.scala
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.

Attributes

Inherited from:
CacheConditionDirectives
Source
CacheConditionDirectives.scala
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.

Attributes

Inherited from:
CacheConditionDirectives
Source
CacheConditionDirectives.scala
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.

Attributes

Inherited from:
CacheConditionDirectives
Source
CacheConditionDirectives.scala
def decodeRequest(inner: Supplier[Route]): Route

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.

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.

Attributes

Inherited from:
CodingDirectives
Source
CodingDirectives.scala
def decodeRequestWith(coders: Iterable[Coder], inner: Supplier[Route]): Route

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.

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.

Attributes

Inherited from:
CodingDirectives
Source
CodingDirectives.scala
def decodeRequestWith(coder: Coder, inner: Supplier[Route]): Route

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

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

Attributes

Inherited from:
CodingDirectives
Source
CodingDirectives.scala
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.

Value parameters

domain

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

name

Name of the cookie to match

path

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

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
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.

Value parameters

domain

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

name

Name of the cookie to match

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
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.

Value parameters

name

Name of the cookie to match

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
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.

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
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.

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
def encodeResponse(inner: Supplier[Route]): Route

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.

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.

Attributes

Inherited from:
CodingDirectives
Source
CodingDirectives.scala
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. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.

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.

Attributes

Inherited from:
CodingDirectives
Source
CodingDirectives.scala
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.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def extractActorSystem(inner: Function[ActorSystem, Route]): Route

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.

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.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def extractEntity(inner: Function[RequestEntity, Route]): Route

Extracts the current http request entity.

Extracts the current http request entity.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def extractExecutionContext(inner: Function[ExecutionContextExecutor, Route]): Route

Extracts the ExecutionContextExecutor from the RequestContext.

Extracts the ExecutionContextExecutor from the RequestContext.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def extractLog(inner: Function[LoggingAdapter, Route]): Route

Extracts the LoggingAdapter

Extracts the LoggingAdapter

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def extractMatchedPath(inner: Function[String, Route]): RouteAdapter

Extracts the already matched path from the RequestContext.

Extracts the already matched path from the RequestContext.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def extractMaterializer(inner: Function[Materializer, Route]): Route

Extracts the Materializer from the RequestContext.

Extracts the Materializer from the RequestContext.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def extractRequest(inner: Function[HttpRequest, Route]): RouteAdapter

Extracts the current HttpRequest instance.

Extracts the current HttpRequest instance.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Value parameters

timeout

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

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Value parameters

timeout

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

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def extractUnmatchedPath(inner: Function[String, Route]): RouteAdapter

Extracts the yet unmatched path from the RequestContext.

Extracts the yet unmatched path from the RequestContext.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def extractUri(inner: Function[Uri, Route]): RouteAdapter

Extracts the complete request URI.

Extracts the complete request URI.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Attributes

Inherited from:
ExecutionDirectives
Source
ExecutionDirectives.scala
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.

Attributes

Inherited from:
ExecutionDirectives
Source
ExecutionDirectives.scala
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.

Attributes

Inherited from:
DebuggingDirectives
Source
DebuggingDirectives.scala
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.

Value parameters

level

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

Attributes

Inherited from:
DebuggingDirectives
Source
DebuggingDirectives.scala
def logRequest(marker: String, inner: Supplier[Route]): Route

Produces a log entry for every incoming request.

Produces a log entry for every incoming request.

Attributes

Inherited from:
DebuggingDirectives
Source
DebuggingDirectives.scala
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.

Value parameters

showRejection

Function invoked when the route yielded a rejection

showSuccess

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

Attributes

Inherited from:
DebuggingDirectives
Source
DebuggingDirectives.scala
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.

Value parameters

showRejection

Function invoked when the route yielded a rejection

showSuccess

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

Attributes

Inherited from:
DebuggingDirectives
Source
DebuggingDirectives.scala
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.

Value parameters

showRejection

Function invoked when the route yielded a rejection

showSuccess

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

Attributes

Inherited from:
DebuggingDirectives
Source
DebuggingDirectives.scala
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.

Value parameters

level

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

Attributes

Inherited from:
DebuggingDirectives
Source
DebuggingDirectives.scala
def logResult(marker: String, inner: Supplier[Route]): Route

Produces a log entry for every route result.

Produces a log entry for every route result.

Attributes

Inherited from:
DebuggingDirectives
Source
DebuggingDirectives.scala
def mapInnerRoute(f: Function[Route, Route], inner: Supplier[Route]): Route

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def mapRejections(f: Function[List[Rejection], List[Rejection]], inner: Supplier[Route]): Route

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def mapRequest(f: Function[HttpRequest, HttpRequest], inner: Supplier[Route]): Route

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def optionalCookie(name: String, inner: Function[Optional[HttpCookiePair], Route]): Route

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

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

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
def pass(inner: Supplier[Route]): Route

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

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

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def provide[T](t: T, inner: Function[T, Route]): Route

Injects the given value into a directive.

Injects the given value into a directive.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Attributes

Inherited from:
CodingDirectives
Source
CodingDirectives.scala
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.

Attributes

Inherited from:
CodingDirectives
Source
CodingDirectives.scala
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.

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
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.

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
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.

Value parameters

timeout

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

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Value parameters

timeout

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

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
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.

Attributes

Inherited from:
CodingDirectives
Source
CodingDirectives.scala
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.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
Generated with