MarshallingDirectives
Attributes
- Source
- MarshallingDirectives.scala
- Graph
-
- Supertypes
-
class HostDirectivesclass AttributeDirectivesclass HeaderDirectivesclass FutureDirectivesclass FormFieldDirectivesclass FileUploadDirectivesclass ExecutionDirectivesclass DebuggingDirectivesclass CookieDirectivesclass CodingDirectivesclass CacheConditionDirectivesclass BasicDirectivesclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class MethodDirectivesclass MiscDirectivesclass ParameterDirectivesclass PathDirectivesclass RangeDirectivesclass RespondWithDirectivesclass RouteDirectivesclass SchemeDirectivesclass SecurityDirectivesclass WebSocketDirectivesclass TimeoutDirectivesclass AllDirectivesobject DirectivesShow all
Members list
Grouped members
future
"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.)
"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.)
Attributes
- Inherited from:
- FutureDirectives
- Source
- FutureDirectives.scala
"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>.
Attributes
- Inherited from:
- FutureDirectives
- Source
- FutureDirectives.scala
"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>.
Attributes
- Inherited from:
- FutureDirectives
- Source
- FutureDirectives.scala
"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.
Attributes
- Inherited from:
- FutureDirectives
- Source
- FutureDirectives.scala
"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.
"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.
Attributes
- Inherited from:
- FutureDirectives
- Source
- FutureDirectives.scala
"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.
"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.
Attributes
- Inherited from:
- FutureDirectives
- Source
- FutureDirectives.scala
header
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.
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.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
Value members
Concrete methods
Uses the marshaller for the given type to produce a completion function that is passed to its inner function. You can use it do decouple marshaller resolution from request completion.
Uses the marshaller for the given type to produce a completion function that is passed to its inner function. You can use it do decouple marshaller resolution from request completion.
Attributes
- Source
- MarshallingDirectives.scala
Unmarshalls the requests entity using the given unmarshaller, and passes the result to [inner]. If there is a problem with unmarshalling the request is rejected with the pekko.http.javadsl.server.Rejection produced by the unmarshaller.
Unmarshalls the requests entity using the given unmarshaller, and passes the result to [inner]. If there is a problem with unmarshalling the request is rejected with the pekko.http.javadsl.server.Rejection produced by the unmarshaller.
Attributes
- Source
- MarshallingDirectives.scala
Completes the request using the given function. The input to the function is produced with the in-scope entity unmarshaller and the result value of the function is marshalled with the in-scope marshaller.
Completes the request using the given function. The input to the function is produced with the in-scope entity unmarshaller and the result value of the function is marshalled with the in-scope marshaller.
Attributes
- Source
- MarshallingDirectives.scala
Unmarshalls the request using the given unmarshaller, and passes the result to [inner]. If there is a problem with unmarshalling the request is rejected with the pekko.http.javadsl.server.Rejection produced by the unmarshaller.
Unmarshalls the request using the given unmarshaller, and passes the result to [inner]. If there is a problem with unmarshalling the request is rejected with the pekko.http.javadsl.server.Rejection produced by the unmarshaller.
Attributes
- Source
- MarshallingDirectives.scala
Inherited methods
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.
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.
Attributes
- Inherited from:
- AttributeDirectives
- Source
- AttributeDirectives.scala
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
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
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
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
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
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
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
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.
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.
Attributes
- Inherited from:
- CookieDirectives
- Source
- CookieDirectives.scala
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
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
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
Default ContentTypeResolver.
Default ContentTypeResolver.
Attributes
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
Default DirectoryRenderer to be used with directory listing directives.
Default DirectoryRenderer to be used with directory listing directives.
Attributes
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
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
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
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
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
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
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
Extracts a single value using the given function.
Extracts a single value using the given function.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
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
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
Extracts the current http request entity.
Extracts the current http request entity.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Extracts the ExecutionContextExecutor from the RequestContext.
Extracts the ExecutionContextExecutor from the RequestContext.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Extracts the hostname part of the Host request header value.
Extracts the hostname part of the Host request header value.
Attributes
- Inherited from:
- HostDirectives
- Source
- HostDirectives.scala
Extracts the LoggingAdapter
Extracts the already matched path from the RequestContext.
Extracts the already matched path from the RequestContext.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Extracts the Materializer from the RequestContext.
Extracts the Materializer from the RequestContext.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
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.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Extracts the current HttpRequest instance.
Extracts the current HttpRequest instance.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Extracts the pekko.http.javadsl.server.RequestContext itself.
Extracts the pekko.http.javadsl.server.RequestContext itself.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
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.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
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
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
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
Extracts the yet unmatched path from the RequestContext.
Extracts the yet unmatched path from the RequestContext.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Extracts the complete request URI.
Extracts the complete request URI.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
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.
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.
Attributes
- Inherited from:
- FileUploadDirectives
- Source
- FileUploadDirectives.scala
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.
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.
Attributes
- Inherited from:
- FileUploadDirectives
- Source
- FileUploadDirectives.scala
Attributes
- Inherited from:
- FormFieldDirectives
- Source
- FormFieldDirectives.scala
Attributes
- Inherited from:
- FormFieldDirectives
- Source
- FormFieldDirectives.scala
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>>.
Attributes
- Inherited from:
- FormFieldDirectives
- Source
- FormFieldDirectives.scala
Attributes
- Inherited from:
- FormFieldDirectives
- Source
- FormFieldDirectives.scala
Attributes
- Inherited from:
- FormFieldDirectives
- Source
- FormFieldDirectives.scala
Extracts HTTP form fields from the request as a Map<String, String>.
Extracts HTTP form fields from the request as a Map<String, String>.
Attributes
- Inherited from:
- FormFieldDirectives
- Source
- FormFieldDirectives.scala
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>>.
Attributes
- Inherited from:
- FormFieldDirectives
- Source
- FormFieldDirectives.scala
Attributes
- Inherited from:
- FormFieldDirectives
- Source
- FormFieldDirectives.scala
Attributes
- Inherited from:
- FormFieldDirectives
- Source
- FormFieldDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
Same as getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with only one directory.
Attributes
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
Same as getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with only one directory.
Attributes
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
Same as getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with only one directory.
Attributes
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
Same as getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with only one directory.
Attributes
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
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
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.
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.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
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.
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.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
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.
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.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
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.
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.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
Rejects all requests with a host name that doesn't have a prefix matching the given regular expression. For all matching requests the prefix string matching the regex is extracted and passed to the inner route. If the regex contains a capturing group only the string matched by this group is extracted. If the regex contains more than one capturing group an IllegalArgumentException is thrown.
Rejects all requests with a host name that doesn't have a prefix matching the given regular expression. For all matching requests the prefix string matching the regex is extracted and passed to the inner route. If the regex contains a capturing group only the string matched by this group is extracted. If the regex contains more than one capturing group an IllegalArgumentException is thrown.
Attributes
- Inherited from:
- HostDirectives
- Source
- HostDirectives.scala
Rejects all requests for whose host name the given predicate function returns false.
Rejects all requests for whose host name the given predicate function returns false.
Attributes
- Inherited from:
- HostDirectives
- Source
- HostDirectives.scala
Rejects all requests with a host name different from the given one.
Rejects all requests with a host name different from the given one.
Attributes
- Inherited from:
- HostDirectives
- Source
- HostDirectives.scala
Rejects all requests with a host name different from the given ones.
Rejects all requests with a host name different from the given ones.
Attributes
- Inherited from:
- HostDirectives
- Source
- HostDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
Produces a log entry for every incoming request.
Produces a log entry for every incoming request.
Attributes
- Inherited from:
- DebuggingDirectives
- Source
- DebuggingDirectives.scala
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
Produces a log entry for every incoming request.
Produces a log entry for every incoming request.
Attributes
- Inherited from:
- DebuggingDirectives
- Source
- DebuggingDirectives.scala
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
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
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
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
Produces a log entry for every route result.
Produces a log entry for every route result.
Attributes
- Inherited from:
- DebuggingDirectives
- Source
- DebuggingDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
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
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
Extracts the value of the optional request attribute with the given key.
Extracts the value of the optional request attribute with the given key.
Attributes
- Inherited from:
- AttributeDirectives
- Source
- AttributeDirectives.scala
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
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.
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.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
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.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
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.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
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.
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.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
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
Injects the given value into a directive.
Injects the given value into a directive.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
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
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
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
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
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.
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.
Attributes
- Inherited from:
- FileUploadDirectives
- Source
- FileUploadDirectives.scala
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.
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.
Attributes
- Inherited from:
- FileUploadDirectives
- Source
- FileUploadDirectives.scala
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
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
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
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
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
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
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