JUnitRouteTestBase
A RouteTest that uses JUnit assertions. ActorSystem and Materializer are provided as an org.junit.rules.ExternalResource and their lifetime is automatically managed.
Attributes
- Source
- JUnitRouteTest.scala
- Graph
-
- Supertypes
-
class RouteTesttrait WSTestRequestBuildingclass AllDirectivesclass TimeoutDirectivesclass WebSocketDirectivesclass SecurityDirectivesclass SchemeDirectivesclass RouteDirectivesclass RespondWithDirectivesclass RangeDirectivesclass PathDirectivesclass ParameterDirectivesclass MiscDirectivesclass MethodDirectivesclass MarshallingDirectivesclass HostDirectivesclass AttributeDirectivesclass HeaderDirectivesclass FutureDirectivesclass FormFieldDirectivesclass FileUploadDirectivesclass ExecutionDirectivesclass DebuggingDirectivesclass CookieDirectivesclass CodingDirectivesclass CacheConditionDirectivesclass BasicDirectivesclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class JUnitRouteTest
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
Abstract methods
Attributes
- Source
- JUnitRouteTest.scala
Concrete methods
Attributes
- Source
- JUnitRouteTest.scala
Inherited methods
Attributes
- Inherited from:
- WSTestRequestBuilding
- Source
- WSTestRequestBuilding.scala
Attributes
- Inherited from:
- WSTestRequestBuilding
- Source
- WSTestRequestBuilding.scala
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
Wraps the inner route with Http Basic authentication support using a given Authenticator[T]. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Wraps the inner route with Http Basic authentication support using a given Authenticator[T]. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Authentication is required in this variant, i.e. the request is rejected if [authenticator] returns Optional.empty.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Authentication is required in this variant, i.e. the request is rejected if [authenticator] returns Optional.empty.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Authentication is optional in this variant.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Wraps the inner route with Http Basic authentication support using a given Authenticator[T]. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Wraps the inner route with Http Basic authentication support using a given Authenticator[T]. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Authentication is optional in this variant.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Authentication is required in this variant, i.e. the request is rejected if [authenticator] returns Optional.empty.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Authentication is required in this variant, i.e. the request is rejected if [authenticator] returns Optional.empty.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Authentication is required in this variant, i.e. the request is rejected if [authenticator] returns Optional.empty.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Authentication is required in this variant, i.e. the request is rejected if [authenticator] returns Optional.empty.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Authentication is optional in this variant.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
Authentication is optional in this variant.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Lifts an authenticator function into a directive. Same as authenticateOrRejectWithChallenge but only applies the authenticator function with a certain type of credentials.
Lifts an authenticator function into a directive. Same as authenticateOrRejectWithChallenge but only applies the authenticator function with a certain type of credentials.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Lifts an authenticator function into a directive. The authenticator function gets passed in credentials from the pekko.http.javadsl.model.headers.Authorization header of the request. If the function returns Right(user) the user object is provided to the inner route. If the function returns Left(challenge) the request is rejected with an pekko.http.javadsl.server.AuthenticationFailedRejection that contains this challenge to be added to the response.
Lifts an authenticator function into a directive. The authenticator function gets passed in credentials from the pekko.http.javadsl.model.headers.Authorization header of the request. If the function returns Right(user) the user object is provided to the inner route. If the function returns Left(challenge) the request is rejected with an pekko.http.javadsl.server.AuthenticationFailedRejection that contains this challenge to be added to the response.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Applies the given authorization check to the request. If the check fails the route is rejected with an pekko.http.javadsl.server.AuthorizationFailedRejection.
Applies the given authorization check to the request. If the check fails the route is rejected with an pekko.http.javadsl.server.AuthorizationFailedRejection.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Applies the given authorization check to the request. If the check fails the route is rejected with an pekko.http.javadsl.server.AuthorizationFailedRejection.
Applies the given authorization check to the request. If the check fails the route is rejected with an pekko.http.javadsl.server.AuthorizationFailedRejection.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Asynchronous version of authorize. If the CompletionStage fails or is completed with false authorization fails and the route is rejected with an pekko.http.javadsl.server.AuthorizationFailedRejection.
Asynchronous version of authorize. If the CompletionStage fails or is completed with false authorization fails and the route is rejected with an pekko.http.javadsl.server.AuthorizationFailedRejection.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Applies the given authorization check to the request. If the check fails the route is rejected with an pekko.http.javadsl.server.AuthorizationFailedRejection.
Applies the given authorization check to the request. If the check fails the route is rejected with an pekko.http.javadsl.server.AuthorizationFailedRejection.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Attributes
- Inherited from:
- RouteTest
- Source
- RouteTest.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
Completes the request as HTTP 200 OK with the given value as response entity.
Completes the request as HTTP 200 OK with the given value as response entity.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request as HTTP 200 OK with the given value as response entity.
Completes the request as HTTP 200 OK with the given value as response entity.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request as HTTP 200 OK, adding the given headers and response entity.
Completes the request as HTTP 200 OK, adding the given headers and response entity.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request as HTTP 200 OK, adding the given headers and response entity.
Completes the request as HTTP 200 OK, adding the given headers and response entity.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request as HTTP 200 OK, adding the given headers, and marshalling the given value as response entity.
Completes the request as HTTP 200 OK, adding the given headers, and marshalling the given value as response entity.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request using the given status code and the given body as UTF-8.
Completes the request using the given status code and the given body as UTF-8.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request using the given status code and response entity.
Completes the request using the given status code and response entity.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request using the given status code and response entity.
Completes the request using the given status code and response entity.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request using the given status code, marshalling the given value as response entity.
Completes the request using the given status code, marshalling the given value as response entity.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request using the given status code, headers, and response entity.
Completes the request using the given status code, headers, and response entity.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request using the given status code, headers, and response entity.
Completes the request using the given status code, headers, and response entity.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request using the given status code and headers, marshalling the given value as response entity.
Completes the request using the given status code and headers, marshalling the given value as response entity.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request by marshalling the given value into an http response.
Completes the request by marshalling the given value into an http response.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request using the given status code.
Completes the request using the given status code.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request using the given http response.
Completes the request using the given http response.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request using an HTTP 200 OK status code and the given body as UTF-8 entity.
Completes the request using an HTTP 200 OK status code and the given body as UTF-8 entity.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request as HTTP 200 OK, marshalling the given value as response entity.
Completes the request as HTTP 200 OK, marshalling the given value as response entity.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request with an OK status code by marshalling the given value into an http response.
Completes the request with an OK status code by marshalling the given value into an http response.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request by marshalling the given future value into an http response.
Completes the request by marshalling the given future value into an http response.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request by marshalling the given value into an http response.
Completes the request by marshalling the given value into an http response.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request by marshalling the given future value into an http response.
Completes the request by marshalling the given future value into an http response.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request by marshalling the given future value into an http response.
Completes the request by marshalling the given future value into an http response.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Attributes
- Inherited from:
- FramedEntityStreamingDirectives
- Source
- FramedEntityStreamingDirectives.scala
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
- Inherited from:
- MarshallingDirectives
- Source
- MarshallingDirectives.scala
Completes the request by marshalling the given value into an http response.
Completes the request by marshalling the given value into an http response.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request by marshalling the given future value into an http response.
Completes the request by marshalling the given future value into an http response.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request by marshalling the given value into an http response.
Completes the request by marshalling the given value into an http response.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request by marshalling the given future value into an http response.
Completes the request by marshalling the given future value into an http response.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request using the given future status code.
Completes the request using the given future status code.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request using the given future status code.
Completes the request using the given future status code.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Attributes
- Inherited from:
- FramedEntityStreamingDirectives
- Source
- FramedEntityStreamingDirectives.scala
Used to chain multiple alternate routes using comma, rather than having to explicitly call route1.orElse(route2).orElse(route3).
Used to chain multiple alternate routes using comma, rather than having to explicitly call route1.orElse(route2).orElse(route3).
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.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
Attributes
- Inherited from:
- RouteTest
- Source
- RouteTest.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
Attributes
- Inherited from:
- RouteTest
- Source
- RouteTest.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
Attributes
- Inherited from:
- RouteTest
- Source
- RouteTest.scala
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.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
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
- Inherited from:
- MarshallingDirectives
- Source
- MarshallingDirectives.scala
Attributes
- Inherited from:
- FramedEntityStreamingDirectives
- Source
- FramedEntityStreamingDirectives.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 client's IP from either the X-Forwarded-For, Remote-Address, X-Real-IP header or pekko.http.javadsl.model.AttributeKeys.remoteAddress attribute (in that order of priority).
Extracts the client's IP from either the X-Forwarded-For, Remote-Address, X-Real-IP header or pekko.http.javadsl.model.AttributeKeys.remoteAddress attribute (in that order of priority).
Attributes
- Inherited from:
- MiscDirectives
- Source
- MiscDirectives.scala
Extracts the potentially present HttpCredentials provided with the request's pekko.http.javadsl.model.headers.Authorization header.
Extracts the potentially present HttpCredentials provided with the request's pekko.http.javadsl.model.headers.Authorization header.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.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
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.scala
Extract the list of WebSocket subprotocols as offered by the client in the Sec-WebSocket-Protocol header if this is a WebSocket request. Rejects with an ExpectedWebSocketRequestRejection, otherwise.
Extract the list of WebSocket subprotocols as offered by the client in the Sec-WebSocket-Protocol header if this is a WebSocket request. Rejects with an ExpectedWebSocketRequestRejection, otherwise.
Attributes
- Inherited from:
- WebSocketDirectives
- Source
- WebSocketDirectives.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
Attributes
- Inherited from:
- TimeoutDirectives
- Source
- TimeoutDirectives.scala
Extracts the Uri scheme from the request.
Extracts the Uri scheme from the request.
Attributes
- Inherited from:
- SchemeDirectives
- Source
- SchemeDirectives.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
Extract the UpgradeToWebSocket attribute if this is a WebSocket request. Rejects with an ExpectedWebSocketRequestRejection, otherwise.
Extract the UpgradeToWebSocket attribute if this is a WebSocket request. Rejects with an ExpectedWebSocketRequestRejection, otherwise.
Attributes
- Inherited from:
- WebSocketDirectives
- Source
- WebSocketDirectives.scala
Bubbles the given error up the response chain, where it is dealt with by the closest handleExceptions directive and its ExceptionHandler.
Bubbles the given error up the response chain, where it is dealt with by the closest handleExceptions directive and its ExceptionHandler.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.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
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.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
Handle the request using a function.
Handle the request using a function.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.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
Handle the request using a function.
Handle the request using a function.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Handles WebSocket requests with the given handler and rejects other requests with an ExpectedWebSocketRequestRejection.
Handles WebSocket requests with the given handler and rejects other requests with an ExpectedWebSocketRequestRejection.
Attributes
- Inherited from:
- WebSocketDirectives
- Source
- WebSocketDirectives.scala
Handles WebSocket requests with the given handler and rejects other requests with an ExpectedWebSocketRequestRejection.
Handles WebSocket requests with the given handler and rejects other requests with an ExpectedWebSocketRequestRejection.
If the subprotocol parameter is None any WebSocket request is accepted. If the subprotocol parameter is Some(protocol) a WebSocket request is only accepted if the list of subprotocols supported by the client (as announced in the WebSocket request) contains protocol. If the client did not offer the protocol in question the request is rejected with an UnsupportedWebSocketSubprotocolRejection rejection.
To support several subprotocols you may chain several handleWebSocketMessagesForOptionalProtocol routes.
Attributes
- Inherited from:
- WebSocketDirectives
- Source
- WebSocketDirectives.scala
Handles WebSocket requests with the given handler if the given subprotocol is offered in the request and rejects other requests with an ExpectedWebSocketRequestRejection or an UnsupportedWebSocketSubprotocolRejection.
Handles WebSocket requests with the given handler if the given subprotocol is offered in the request and rejects other requests with an ExpectedWebSocketRequestRejection or an UnsupportedWebSocketSubprotocolRejection.
Attributes
- Inherited from:
- WebSocketDirectives
- Source
- WebSocketDirectives.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
- Inherited from:
- MarshallingDirectives
- Source
- MarshallingDirectives.scala
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.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
Tries to match the inner route and if it fails with an empty rejection, it tries it again adding (or removing) the trailing slash on the given path.
Tries to match the inner route and if it fails with an empty rejection, it tries it again adding (or removing) the trailing slash on the given path.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.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
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.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
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.scala
Changes the HTTP method of the request to the value of the specified query string parameter. If the query string parameter is not specified this directive has no effect. If the query string is specified as something that is not a HTTP method, then this directive completes the request with a 501 Not Implemented response.
Changes the HTTP method of the request to the value of the specified query string parameter. If the query string parameter is not specified this directive has no effect. If the query string is specified as something that is not a HTTP method, then this directive completes the request with a 501 Not Implemented response.
This directive is useful for:
- Use in combination with JSONP (JSONP only supports GET)
- Supporting older browsers that lack support for certain HTTP methods. E.g. IE8 does not support PATCH
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.scala
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.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
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.scala
Consumes a leading slash and extracts the next path segment, unmarshalling it and passing the result to the inner function, expecting the full path to have been consumed then.
Consumes a leading slash and extracts the next path segment, unmarshalling it and passing the result to the inner function, expecting the full path to have been consumed then.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Applies the given PathMatcher0 to the remaining unmatched path after consuming a leading slash. The matcher has to match the remaining path completely. If matched the value extracted by the PathMatcher0 is extracted on the directive level.
Applies the given PathMatcher0 to the remaining unmatched path after consuming a leading slash. The matcher has to match the remaining path completely. If matched the value extracted by the PathMatcher0 is extracted on the directive level.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Matches a prefix to the remaining unmatched path after consuming a leading slash. The matcher has to match the remaining path completely. If matched the value matching the prefix is extracted on the directive level.
Matches a prefix to the remaining unmatched path after consuming a leading slash. The matcher has to match the remaining path completely. If matched the value matching the prefix is extracted on the directive level.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Rejects the request if the unmatchedPath of the pekko.http.javadsl.server.RequestContext is non-empty, or said differently: only passes on the request to its inner route if the request path has been matched completely.
Rejects the request if the unmatchedPath of the pekko.http.javadsl.server.RequestContext is non-empty, or said differently: only passes on the request to its inner route if the request path has been matched completely.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Only passes on the request to its inner route if the request path has been matched completely or only consists of exactly one remaining slash.
Only passes on the request to its inner route if the request path has been matched completely or only consists of exactly one remaining slash.
Note that trailing slash and non-trailing slash URLs are '''not''' the same, although they often serve the same content. It is recommended to serve only one URL version and make the other redirect to it using redirectToTrailingSlashIfMissing or redirectToNoTrailingSlashIfPresent directive.
For example:
def route = {
// redirect '/users/' to '/users', '/users/:userId/' to '/users/:userId'
redirectToNoTrailingSlashIfPresent(Found) {
pathPrefix("users") {
concat(
pathEnd {
// user list ...
},
path(UUID) { userId =>
// user profile ...
}
)
}
}
}
For further information, refer to: http://googlewebmastercentral.blogspot.de/2010/04/to-slash-or-not-to-slash.html
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Consumes a leading slash and extracts the next path segment, unmarshalling it and passing the result to the inner function.
Consumes a leading slash and extracts the next path segment, unmarshalling it and passing the result to the inner function.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Applies the given PathMatcher0 to the remaining unmatched path after consuming a leading slash. The matcher has to match a prefix of the remaining path. If matched the value extracted by the PathMatcher is extracted on the directive level.
Applies the given PathMatcher0 to the remaining unmatched path after consuming a leading slash. The matcher has to match a prefix of the remaining path. If matched the value extracted by the PathMatcher is extracted on the directive level.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Matches a prefix to the remaining unmatched path after consuming a leading slash. The matcher has to match a prefix of the remaining path. If matched the value matching the prefix is extracted on the directive level.
Matches a prefix to the remaining unmatched path after consuming a leading slash. The matcher has to match a prefix of the remaining path. If matched the value matching the prefix is extracted on the directive level.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Checks whether the unmatchedPath of the pekko.http.javadsl.server.RequestContext has a prefix matched by the given PathMatcher. In analogy to the pathPrefix directive a leading slash is implied.
Checks whether the unmatchedPath of the pekko.http.javadsl.server.RequestContext has a prefix matched by the given PathMatcher. In analogy to the pathPrefix directive a leading slash is implied.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Only passes on the request to its inner route if the request path consists of exactly one remaining slash.
Only passes on the request to its inner route if the request path consists of exactly one remaining slash.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Applies the given pekko.http.scaladsl.server.PathMatcher to a suffix of the remaining unmatchedPath of the pekko.http.javadsl.server.RequestContext. If matched the value extracted by the pekko.http.javadsl.server.PathMatcher0 is extracted and the matched parts of the path are consumed. Note that, for efficiency reasons, the given pekko.http.javadsl.server.PathMatcher0 must match the desired suffix in reversed-segment order, i.e. pathSuffix("baz" / "bar") would match /foo/bar/baz!
Applies the given pekko.http.scaladsl.server.PathMatcher to a suffix of the remaining unmatchedPath of the pekko.http.javadsl.server.RequestContext. If matched the value extracted by the pekko.http.javadsl.server.PathMatcher0 is extracted and the matched parts of the path are consumed. Note that, for efficiency reasons, the given pekko.http.javadsl.server.PathMatcher0 must match the desired suffix in reversed-segment order, i.e. pathSuffix("baz" / "bar") would match /foo/bar/baz!
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Checks whether the unmatchedPath of the pekko.http.javadsl.server.RequestContext has a suffix matched by the given PathMatcher. However, as opposed to the pathSuffix directive the matched path is not actually "consumed". Note that, for efficiency reasons, the given PathMatcher must match the desired suffix in reversed-segment order, i.e. pathSuffixTest("baz" / "bar") would match /foo/bar/baz!
Checks whether the unmatchedPath of the pekko.http.javadsl.server.RequestContext has a suffix matched by the given PathMatcher. However, as opposed to the pathSuffix directive the matched path is not actually "consumed". Note that, for efficiency reasons, the given PathMatcher must match the desired suffix in reversed-segment order, i.e. pathSuffixTest("baz" / "bar") would match /foo/bar/baz!
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.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:
- MethodDirectives
- Source
- MethodDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Applies the given matcher directly to a prefix of the unmatched path of the pekko.http.javadsl.server.RequestContext (i.e. without implicitly consuming a leading slash). The matcher has to match a prefix of the remaining path. If matched the value extracted by the PathMatcher is extracted on the directive level.
Applies the given matcher directly to a prefix of the unmatched path of the pekko.http.javadsl.server.RequestContext (i.e. without implicitly consuming a leading slash). The matcher has to match a prefix of the remaining path. If matched the value extracted by the PathMatcher is extracted on the directive level.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Checks whether the unmatchedPath of the pekko.http.javadsl.server.RequestContext has a prefix matched by the given PathMatcher. However, as opposed to the pathPrefix directive the matched path is not actually "consumed".
Checks whether the unmatchedPath of the pekko.http.javadsl.server.RequestContext has a prefix matched by the given PathMatcher. However, as opposed to the pathPrefix directive the matched path is not actually "consumed".
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Completes the request with redirection response of the given type to the given URI.
Completes the request with redirection response of the given type to the given URI.
Value parameters
- redirectionType
-
A status code from StatusCodes, which must be a redirection type.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
If the request path ends with a slash, redirect to the same uri without trailing slash in the path.
If the request path ends with a slash, redirect to the same uri without trailing slash in the path.
'''Caveat''': pathSingleSlash directive will not match inside of this directive.
Value parameters
- redirectionType
-
A status code from StatusCodes, which must be a redirection type.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
If the request path doesn't end with a slash, redirect to the same uri with trailing slash in the path.
If the request path doesn't end with a slash, redirect to the same uri with trailing slash in the path.
'''Caveat''': path without trailing slash and pathEnd directives will not match inside of this directive.
Value parameters
- redirectionType
-
A status code from StatusCodes, which must be a redirection type.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Rejects the request with an empty rejection (usually used for "no directive matched").
Rejects the request with an empty rejection (usually used for "no directive matched").
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Rejects the request with the given rejections, or with an empty set of rejections if no rejections are given.
Rejects the request with the given rejections, or with an empty set of rejections if no rejections are given.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Converts responses with an empty entity into (empty) rejections. This way you can, for example, have the marshalling of a ''None'' option be treated as if the request could not be matched.
Converts responses with an empty entity into (empty) rejections. This way you can, for example, have the marshalling of a ''None'' option be treated as if the request could not be matched.
Attributes
- Inherited from:
- MiscDirectives
- Source
- MiscDirectives.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
- Inherited from:
- MarshallingDirectives
- Source
- MarshallingDirectives.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 if the request entity is non-empty.
Rejects if the request entity is non-empty.
Attributes
- Inherited from:
- MiscDirectives
- Source
- MiscDirectives.scala
Rejects with a RequestEntityExpectedRejection if the request entity is empty. Non-empty requests are passed on unchanged to the inner route.
Rejects with a RequestEntityExpectedRejection if the request entity is empty. Non-empty requests are passed on unchanged to the inner route.
Attributes
- Inherited from:
- MiscDirectives
- Source
- MiscDirectives.scala
Adds the given response header to all HTTP responses of its inner Route, if the response from the inner Route doesn't already contain a header with the same name.
Adds the given response header to all HTTP responses of its inner Route, if the response from the inner Route doesn't already contain a header with the same name.
Attributes
- Inherited from:
- RespondWithDirectives
- Source
- RespondWithDirectives.scala
Adds the given response headers to all HTTP responses of its inner Route, if a header already exists it is not added again.
Adds the given response headers to all HTTP responses of its inner Route, if a header already exists it is not added again.
Attributes
- Inherited from:
- RespondWithDirectives
- Source
- RespondWithDirectives.scala
Unconditionally adds the given response header to all HTTP responses of its inner Route.
Unconditionally adds the given response header to all HTTP responses of its inner Route.
Attributes
- Inherited from:
- RespondWithDirectives
- Source
- RespondWithDirectives.scala
Unconditionally adds the given response headers to all HTTP responses of its inner Route.
Unconditionally adds the given response headers to all HTTP responses of its inner Route.
Attributes
- Inherited from:
- RespondWithDirectives
- Source
- RespondWithDirectives.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
Attributes
- Inherited from:
- RouteTest
- Source
- RouteTest.scala
Attributes
- Inherited from:
- RouteTest
- Source
- RouteTest.scala
Attributes
- Inherited from:
- RouteTest
- Source
- RouteTest.scala
Attributes
- Inherited from:
- RouteTest
- Source
- RouteTest.scala
Attributes
- Inherited from:
- RouteTest
- Source
- RouteTest.scala
Rejects all requests whose Uri scheme does not match the given one.
Rejects all requests whose Uri scheme does not match the given one.
Attributes
- Inherited from:
- SchemeDirectives
- Source
- SchemeDirectives.scala
Inspects the request's Accept-Language header and determines, which of the given language alternatives is preferred by the client. (See http://tools.ietf.org/html/rfc7231#section-5.3.5 for more details on the negotiation logic.) If there are several best language alternatives that the client has equal preference for (even if this preference is zero!) the order of the arguments is used as a tie breaker (First one wins).
Inspects the request's Accept-Language header and determines, which of the given language alternatives is preferred by the client. (See http://tools.ietf.org/html/rfc7231#section-5.3.5 for more details on the negotiation logic.) If there are several best language alternatives that the client has equal preference for (even if this preference is zero!) the order of the arguments is used as a tie breaker (First one wins).
If [languages] is empty, the route is rejected.
Attributes
- Inherited from:
- MiscDirectives
- Source
- MiscDirectives.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
Wraps a list of route alternatives with testing support.
Wraps a list of route alternatives with testing support.
Attributes
- Inherited from:
- RouteTest
- Source
- RouteTest.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
Checks the given condition before running its inner route. If the condition fails the route is rejected with a ValidationRejection.
Checks the given condition before running its inner route. If the condition fails the route is rejected with a ValidationRejection.
Attributes
- Inherited from:
- MiscDirectives
- Source
- MiscDirectives.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
Answers GET requests with an Accept-Ranges: bytes header and converts HttpResponses coming back from its inner route into partial responses if the initial request contained a valid Range request header. The requested byte-ranges may be coalesced. This directive is transparent to non-GET requests Rejects requests with unsatisfiable ranges UnsatisfiableRangeRejection. Rejects requests with too many expected ranges.
Answers GET requests with an Accept-Ranges: bytes header and converts HttpResponses coming back from its inner route into partial responses if the initial request contained a valid Range request header. The requested byte-ranges may be coalesced. This directive is transparent to non-GET requests Rejects requests with unsatisfiable ranges UnsatisfiableRangeRejection. Rejects requests with too many expected ranges.
Note: if you want to combine this directive with conditional(...) you need to put it on the inside of the conditional(...) directive, i.e. conditional(...) must be on a higher level in your route structure in order to function correctly.
For more information, see: https://tools.ietf.org/html/rfc7233
Attributes
- Inherited from:
- RangeDirectives
- Source
- RangeDirectives.scala
Tries to set a new request timeout and handler (if provided) at the same time.
Tries to set a new request timeout and handler (if provided) at the same time.
Due to the inherent raciness it is not guaranteed that the update will be applied before the previously set timeout has expired!
Attributes
- Inherited from:
- TimeoutDirectives
- Source
- TimeoutDirectives.scala
Tries to set a new request timeout and handler (if provided) at the same time.
Tries to set a new request timeout and handler (if provided) at the same time.
Due to the inherent raciness it is not guaranteed that the update will be applied before the previously set timeout has expired!
Attributes
- Inherited from:
- TimeoutDirectives
- Source
- TimeoutDirectives.scala
Tries to set a new request timeout handler, which produces the timeout response for a given request. Note that the handler must produce the response synchronously and shouldn't block!
Tries to set a new request timeout handler, which produces the timeout response for a given request. Note that the handler must produce the response synchronously and shouldn't block!
Due to the inherent raciness it is not guaranteed that the update will be applied before the previously set timeout has expired!
Attributes
- Inherited from:
- TimeoutDirectives
- Source
- TimeoutDirectives.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
Fails the stream with pekko.http.scaladsl.model.EntityStreamSizeException if its request entity size exceeds given limit. Limit given as parameter overrides limit configured with pekko.http.parsing.max-content-length.
Fails the stream with pekko.http.scaladsl.model.EntityStreamSizeException if its request entity size exceeds given limit. Limit given as parameter overrides limit configured with pekko.http.parsing.max-content-length.
Beware that request entity size check is executed when entity is consumed.
Attributes
- Inherited from:
- MiscDirectives
- Source
- MiscDirectives.scala
Attributes
- Inherited from:
- TimeoutDirectives
- Source
- TimeoutDirectives.scala
Disables the size limit (configured by pekko.http.parsing.max-content-length by default) checking on the incoming pekko.http.javadsl.model.HttpRequest entity. Can be useful when handling arbitrarily large data uploads in specific parts of your routes.
Disables the size limit (configured by pekko.http.parsing.max-content-length by default) checking on the incoming pekko.http.javadsl.model.HttpRequest entity. Can be useful when handling arbitrarily large data uploads in specific parts of your routes.
Attributes
- Note
-
Usage of
withoutSizeLimitis not recommended as it turns off the too large payload protection. Therefore, we highly encourage usingwithSizeLimitinstead, providing it with a value high enough to successfully handle the route in need of big entities. - Inherited from:
- MiscDirectives
- Source
- MiscDirectives.scala
Deprecated and Inherited methods
Extract the UpgradeToWebSocket header if existent. Rejects with an ExpectedWebSocketRequestRejection, otherwise.
Extract the UpgradeToWebSocket header if existent. Rejects with an ExpectedWebSocketRequestRejection, otherwise.
Attributes
- Deprecated
-
[Since version Akka HTTP 10.2.0]use
webSocketUpgradeinstead since Akka HTTP 10.2.0 - Inherited from:
- WebSocketDirectives
- Source
- WebSocketDirectives.scala
Java-specific call added so you can chain together multiple alternate routes using comma, rather than having to explicitly call route1.orElse(route2).orElse(route3).
Java-specific call added so you can chain together multiple alternate routes using comma, rather than having to explicitly call route1.orElse(route2).orElse(route3).
Attributes
- Deprecated
-
Use the
RouteDirectives.concatmethod instead. - Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Implicits
Inherited implicits
Attributes
- Inherited from:
- RouteTest
- Source
- RouteTest.scala