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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

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

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

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.

Completes the request as HTTP 200 OK, adding the given headers, and marshalling the given value as response entity.

Completes the request using the given status code and the given body as UTF-8.

Completes the request using the given status code and response entity.

Completes the request using the given status code and response entity.

Completes the request using the given status code, marshalling the given value as response entity.

Completes the request using the given status code, headers, and response entity.

Completes the request using the given status code, headers, and response entity.

Completes the request using the given status code and headers, marshalling the given value as response entity.

Completes the request by marshalling the given value into an http response.

Completes the request using the given status code.

Completes the request using the given http response.

Completes the request using an HTTP 200 OK status code and the given body as UTF-8 entity.

Completes the request as HTTP 200 OK, marshalling the given value as response entity.

Completes the request with an OK status code by marshalling the given value into an http response.

Completes the request by marshalling the given future value into an http response.

Completes the request by marshalling the given value into an http response.

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.

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

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.

Completes the request by marshalling the given value into an http response.

Completes the request by marshalling the given future value into an http response.

Completes the request by marshalling the given value into an http response.

Completes the request by marshalling the given future value into an http response.

Completes the request using the given future status code.

Completes the request using the given future status code.

Used to chain multiple alternate routes using comma, rather than having to explicitly call route1.orElse(route2).orElse(route3).

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 pekko.http.javadsl.server.MissingCookieRejection.

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.

Default ContentTypeResolver.

Default DirectoryRenderer to be used with directory listing directives.

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.

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

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

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

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.

If [encoders] is empty, no encoding is performed.

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.

Extracts a single value using the given function.

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 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 potentially present HttpCredentials provided with the request's pekko.http.javadsl.model.headers.Authorization header.

Extracts the entities dataBytes pekko.stream.javadsl.Source from the pekko.http.javadsl.server.RequestContext.

Extracts the current http request entity.

Extracts the ExecutionContextExecutor from the RequestContext.

Extracts the hostname part of the Host request header value.

Extracts the LoggingAdapter

Extracts the already matched path from the RequestContext.

Extracts the Materializer from the RequestContext.

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 pekko.http.javadsl.settings.ParserSettings from the pekko.http.javadsl.server.RequestContext.

Extracts the current HttpRequest instance.

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

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

Extracts the Uri scheme from the request.

Extracts the RoutingSettings from the pekko.http.javadsl.server.RequestContext.

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.

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.

Extracts the yet unmatched path from the RequestContext.

Extracts the complete request URI.

Extract the UpgradeToWebSocket 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 HTTP form fields from the request as a Map.Entry<String, String>>.

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

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.

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.

Same as getFromBrowseableDirectories with only one directory.

Same as getFromBrowseableDirectories with only one directory.

Same as getFromBrowseableDirectories with only one directory.

Same as getFromBrowseableDirectories with only one directory.

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 default content-type resolver. If the file cannot be read the Route rejects the request.

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

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

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 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, 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 default content type resolver. 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", 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.

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.

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.

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.

Handle the request using a function.

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

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

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.

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

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.

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

Produces a log entry for every incoming request.

Produces a log entry for every incoming request.

Produces a log entry for every incoming request.

Produces a log entry for every request/response combination.

Optionally produces a log entry for every request/response combination.

Produces a log entry for every route result.

Produces a log entry for every route result.

Produces a log entry for every route result.

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

Transforms the unmatchedPath of the RequestContext using the given function.

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

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

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

Extracts the value of the optional request attribute with 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 pekko.http.javadsl.server.MalformedHeaderRejection.

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

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.

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.

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

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

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.

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.

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.

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.

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

Consumes a leading slash and extracts the next path segment, unmarshalling it and passing the result to the inner function.

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.

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.

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.

Only passes on the request to its inner route if the request path consists of exactly one remaining slash.