Override to implement the routes that will be served by this http server.

A PathMatcher that matches and extracts a Double value. The matched string representation is the pure decimal, optionally signed form of a double value, i.e. without exponent.

A PathMatcher that matches and extracts a java.util.UUID instance.

A PathMatcher that always matches, doesn't consume anything and extracts nothing. Serves mainly as a neutral element in PathMatcher composition.

A PathMatcher that matches between min and max (both inclusively) path segments (separated by slashes) as a List[String]. If there are more than count segments present the remaining ones will be left unmatched. If the path has a trailing slash this slash will *not* be matched.

A PathMatcher that matches the given number of path segments (separated by slashes) as a List[String]. If there are more than count segments present the remaining ones will be left unmatched. If the path has a trailing slash this slash will *not* be matched.

A PathMatcher that matches up to 128 remaining segments as a List[String]. This can also be no segments resulting in the empty list. If the path has a trailing slash this slash will *not* be matched.

Creates a PathMatcher that consumes (a prefix of) the first path segment if the path begins with a segment (a prefix of) which matches the given regex. Extracts either the complete match (if the regex doesn't contain a capture group) or the capture group (if the regex contains exactly one). If the regex contains more than one capture group the method throws an IllegalArgumentException.

Creates a PathMatcher that consumes (a prefix of) the first path segment (if the path begins with a segment).

Creates a PathMatcher that consumes (a prefix of) the first path segment (if the path begins with a segment) and extracts a given value.

Creates a PathMatcher from the given Map of path segments (prefixes) to extracted values. If the unmatched path starts with a segment having one of the maps keys as a prefix the matcher consumes this path segment (prefix) and extracts the corresponding map value. For keys sharing a common prefix the longest matching prefix is selected.

Returns the in-scope FromRequestUnmarshaller for the given type.

Extracts entity as akka.stream.scaladsl.Source of elements of type T. This is achieved by applying the implicitly provided (in the following order):

- 1st: chunk-up the incoming ByteStrings by applying the Content-Type-aware framing - 2nd: apply the Unmarshaller (from ByteString to T) for each of the respective "chunks" (e.g. for each JSON element contained within an array).

The request will be rejected with an akka.http.scaladsl.server.UnsupportedRequestContentTypeRejection if its ContentType is not supported by the used framing or unmarshaller.

Cancelling extracted akka.stream.scaladsl.Source closes the connection abruptly (same as cancelling the entity.dataBytes).

See also MiscDirectives.withoutSizeLimit as you may want to allow streaming infinite streams of data in this route. By default the uploaded data is limited by the akka.http.parsing.max-content-length.

Extracts entity as akka.stream.scaladsl.Source of elements of type T. This is achieved by applying the implicitly provided (in the following order):

- 1st: chunk-up the incoming ByteStrings by applying the Content-Type-aware framing - 2nd: apply the Unmarshaller (from ByteString to T) for each of the respective "chunks" (e.g. for each JSON element contained within an array).

The request will be rejected with an akka.http.scaladsl.server.UnsupportedRequestContentTypeRejection if its ContentType is not supported by the used framing or unmarshaller.

Cancelling extracted akka.stream.scaladsl.Source closes the connection abruptly (same as cancelling the entity.dataBytes).

See also MiscDirectives.withoutSizeLimit as you may want to allow streaming infinite streams of data in this route. By default the uploaded data is limited by the akka.http.parsing.max-content-length.

Extracts a request attribute value for the given key.

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

A directive that 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.

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.

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.

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. The authenticator function gets passed in credentials from the 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 AuthenticationFailedRejection that contains this challenge to be added to the response.

Applies the given authorization check to the request. If the check fails the route is rejected with an AuthorizationFailedRejection.

Applies the given authorization check to the request. If the check fails the route is rejected with an AuthorizationFailedRejection.

Asynchronous version of authorize. If the Future fails or is completed with false authorization fails and the route is rejected with an AuthorizationFailedRejection.

Asynchronous version of authorize. If the Future fails or is completed with false authorization fails and the route is rejected with an AuthorizationFailedRejection.

It tries to retrieve the ServerBinding if the server has been successfully started. It fails otherwise. You can use this method to attempt to retrieve the ServerBinding at any point in time to, for example, stop the server due to unexpected circumstances.

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 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 of one of the given classes to the list of rejections potentially coming back from the inner route.

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.

Completes the request using the given arguments.

Completes the request using the given arguments.

Completes the request using the given arguments.

"Unwraps" a Future[T] and runs the inner route when the future has failed with the future's failure exception as an extraction of type Throwable. If the future succeeds the request is completed using the values marshaller (This directive therefore requires a marshaller for the futures type to be implicitly available.)

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.

Tries the supplied routes in sequence, returning the result of the first route that doesn't reject the request. This is an alternative to direct usage of the infix ~ operator. The ~ can be prone to programmer error, because if it is omitted, the program will still be syntactically correct, but will not actually attempt to match multiple routes, as intended.

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.

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.

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.

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.

Extracts the HttpCookiePair with the given name. If the cookie is not present the request is rejected with a respective MissingCookieRejection.

Wraps its inner route with support for the CORS mechanism, enabling cross origin requests using the given cors settings.

Wraps its inner route with support for the CORS mechanism, enabling cross origin requests using the default cors configuration from the actor system.

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.

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 using the given Decoder. If the request encoding doesn't match the request is rejected with an UnsupportedRequestEncodingRejection.

Rejects all non-DELETE requests.

Adds a Set-Cookie response header expiring the cookie with the given properties.

Adds a Set-Cookie response header expiring the given cookies.

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.

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.

Unmarshalls the requests entity to the given type passes it to its inner Route. If there is a problem with unmarshalling the request is rejected with the Rejection produced by the unmarshaller.

Extracts a single value using the given function.

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

Extract the client certificate, or reject the request with a TlsClientUnverifiedRejection.

Using this directives requires tls-session info parsing to be enabled: akka.http.server.parsing.tls-session-info-header = on

The javax.net.ssl.SSLEngine for the server needs to be set up with setWantClientAuth(true) or setNeedClientAuth(true) or else every request will be failed.

Extracts the client's IP from either the X-Forwarded-For, Remote-Address, X-Real-IP header or akka.http.scaladsl.model.AttributeKeys.remoteAddress attribute (in that order of priority).

Extracts the potentially present HttpCredentials provided with the request's Authorization header.

Extracts the entities dataBytes akka.stream.scaladsl.Source from the akka.http.scaladsl.server.RequestContext.

Extracts the scala.concurrent.ExecutionContextExecutor from the akka.http.scaladsl.server.RequestContext.

Extracts the hostname part of the Host request header value.

Extracts the akka.event.LoggingAdapter from the akka.http.scaladsl.server.RequestContext.

Extracts the already matched path from the RequestContext.

Extracts the akka.stream.Materializer from the akka.http.scaladsl.server.RequestContext.

Extracts the request method.

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.

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

Extracts the current HttpRequest instance.

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

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

Return the currently set request timeout.

Note that this may be changed in inner directives.

Extracts the Uri scheme from the request.

Extracts the RoutingSettings from the akka.http.scaladsl.server.RequestContext.

Extract the current SSLSession.

Note: Using this directives requires tls-session info parsing to be enabled: akka.http.server.parsing.tls-session-info-header = on

WARNING: This will read the entire request entity into memory and effectively disable streaming.

To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the akka.http.parsing.max-to-strict-bytes configuration setting.

Converts the HttpEntity from the akka.http.scaladsl.server.RequestContext into an akka.http.scaladsl.model.HttpEntity.Strict and extracts it, or fails the route if unable to drain the entire request body within the timeout.

WARNING: This will read the entire request entity into memory and effectively disable streaming.

To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the akka.http.parsing.max-to-strict-bytes configuration setting.

Converts the HttpEntity from the akka.http.scaladsl.server.RequestContext into an akka.http.scaladsl.model.HttpEntity.Strict and extracts it, or fails the route if unable to drain the entire request body within the timeout.

Extracts the yet unmatched path from the RequestContext.

Extracts the complete request URI.

Extract the WebSocketUpgrade attribute if this is a WebSocket request. Rejects with an ExpectedWebSocketRequestRejection, otherwise.

Bubbles the given error up the response chain, where it is dealt with by the closest handleExceptions directive and its ExceptionHandler.

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

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts HTTP form fields from the request as a Map[String, String].

Extracts HTTP form fields from the request as a Map[String, List[String]].

Extracts HTTP form fields from the request as a Seq[(String, String)].

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Rejects all non-GET requests.

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

Same as getFromBrowseableDirectories with only one directory.

Completes GET requests with the content of a file underneath the given directory. If the file cannot be read the Route rejects the request.

Completes GET requests with the content of the given file. If the file cannot be found or read the request is rejected.

Completes GET requests with the content of the given file. If the file cannot be found or read the request is rejected.

Completes GET requests with the content of the given file. If the file cannot be found or read the request is rejected.

Completes GET requests with the content of the given resource. If the resource is a directory or cannot be found or read the Route rejects the request.

Completes GET requests with the content of the given class-path resource. If the resource cannot be found or read the Route rejects the request.

Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory". If the requested resource is itself a directory or cannot be found or read the Route rejects the request.

Handle the request using an asynchronous partial function.

This directive can be used to include external components request processing components defined as PartialFunction (like those provided by akka-grpc) into a routing tree defined as routes.

Handle the request using an asynchronous partial function.

This directive can be used to include external components request processing components defined as PartialFunction (like those provided by akka-grpc) into a routing tree defined as routes.

When the partial function is not defined for a request, the request is rejected with an empty list of rejections which is equivalent to a "Not Found" rejection.

Handle the request using a function.

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

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

Handle the request using a synchronous partial function.

This directive can be used to include external components request processing components defined as PartialFunction (like those provided by akka-grpc) into a routing tree defined as routes.

Handle the request using a synchronous partial function.

This directive can be used to include external components request processing components defined as PartialFunction (like those provided by akka-grpc) into a routing tree defined as routes.

When the partial function is not defined for a request, the request is rejected with an empty list of rejections which is equivalent to a "Not Found" rejection.

Handle the request using a function.

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.

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.

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.

Rejects all non-HEAD requests.

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 akka.http.scaladsl.server.MalformedHeaderRejection.

Extracts the value of the HTTP request header with the given name. If no header with a matching name is found the request is rejected with a akka.http.scaladsl.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 akka.http.scaladsl.server.MissingHeaderRejection.

Custom headers will only be matched by this directive if they extend ModeledCustomHeader and provide a companion extending ModeledCustomHeaderCompanion.

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.

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 for whose host name the given predicate function returns false.

Rejects all requests with a host name different from the given ones.

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.

Returns the in-scope Marshaller for the given type.

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

Produces a log entry for every incoming request.

Produces a log entry for every incoming request and RouteResult.

Produces a log entry for every RouteResult.

Runs the inner route with settings mapped by the given function.

Transforms the unmatchedPath of the RequestContext using the given function.

Rejects all requests whose HTTP method does not match the given one.

A PathMatcher that never matches anything.

"Unwraps" a Future[T] and runs the inner route after future completion with the future's value as an extraction of type Try[T].

"Unwraps" a Future[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 CircuitBreakerOpenRejection.

"Unwraps" a Future[T] and runs the inner route after future completion with the future's value as an extraction of type T. If the future fails its failure Throwable is bubbled up to the nearest ExceptionHandler. If type T is already a Tuple it is directly expanded into the respective number of extractions.

Extracts an optional request attribute for the given key.

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

Extracts an optional HTTP header value using the given function. If the given function throws an exception the request is rejected with a akka.http.scaladsl.server.MalformedHeaderRejection.

Extracts the value of the optional HTTP request header with the given name.

Extract the header value of the optional HTTP request header with the given type.

Custom headers will only be matched by this directive if they extend ModeledCustomHeader and provide a companion extending ModeledCustomHeaderCompanion.

Extracts an optional HTTP header value using the given partial function. If the given function throws an exception the request is rejected with a akka.http.scaladsl.server.MalformedHeaderRejection.