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

PathDirectives

org.apache.pekko.http.javadsl.server.directives.PathDirectives
abstract class PathDirectives extends ParameterDirectives

Only path prefixes are matched by these methods, since any kind of chaining path extractions in Java would just look cumbersome without operator overloads; hence, no PathMatcher for Java.

Just nest path() directives with the required types, ending in pathEnd() if you want to fail further paths.

Attributes

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

Members list

Grouped members

future

def completeOrRecoverWith[T](f: Supplier[CompletionStage[T]], marshaller: Marshaller[T, RequestEntity], inner: Function[Throwable, Route]): Route

"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
def onComplete[T](cs: CompletionStage[T], inner: Function[Try[T], Route]): RouteAdapter

"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
def onComplete[T](f: Supplier[CompletionStage[T]], inner: Function[Try[T], Route]): RouteAdapter

"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
def onCompleteWithBreaker[T](breaker: CircuitBreaker, f: Supplier[CompletionStage[T]], inner: Function[Try[T], Route]): RouteAdapter

"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
def onSuccess[T](cs: CompletionStage[T], inner: Function[T, Route]): RouteAdapter

"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
def onSuccess[T](f: Supplier[CompletionStage[T]], inner: Function[T, Route]): RouteAdapter

"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

def checkSameOrigin(allowed: HttpOriginRange, inner: Supplier[Route]): 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.

Checks that request comes from the same origin. Extracts the Origin header value and verifies that allowed range contains the obtained value. In the case of absent of the Origin header rejects with MissingHeaderRejection. If the origin value is not in the allowed range rejects with an InvalidOriginRejection and StatusCodes.FORBIDDEN status.

Attributes

Inherited from:
HeaderDirectives
Source
HeaderDirectives.scala

Value members

Concrete methods

def ignoreTrailingSlash(inner: Supplier[Route]): Route

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

Source
PathDirectives.scala
def path(segment: String, inner: Supplier[Route]): Route

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

Source
PathDirectives.scala
def path(inner: Function[String, Route]): Route

Attributes

Source
PathDirectives.scala
def path(p: PathMatcher0, inner: Supplier[Route]): Route

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

Source
PathDirectives.scala
def path[T](p: PathMatcher1[T], inner: Function[T, Route]): Route

Attributes

Source
PathDirectives.scala
def path[T1, T2](p: PathMatcher2[T1, T2], inner: BiFunction[T1, T2, Route]): Route

Attributes

Source
PathDirectives.scala
def path[T](t: Unmarshaller[String, T], inner: Function[T, Route]): Route

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

Source
PathDirectives.scala
def pathEnd(inner: Supplier[Route]): Route

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

Source
PathDirectives.scala
def pathEndOrSingleSlash(inner: Supplier[Route]): Route

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

Source
PathDirectives.scala
def pathPrefix(segment: String, inner: Supplier[Route]): Route

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

Source
PathDirectives.scala
def pathPrefix(inner: Function[String, Route]): Route

Attributes

Source
PathDirectives.scala
def pathPrefix(p: PathMatcher0, inner: Supplier[Route]): Route

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

Source
PathDirectives.scala
def pathPrefix[T](p: PathMatcher1[T], inner: Function[T, Route]): Route

Attributes

Source
PathDirectives.scala
def pathPrefix[T1, T2](p: PathMatcher2[T1, T2], inner: BiFunction[T1, T2, Route]): Route

Attributes

Source
PathDirectives.scala
def pathPrefix[T](t: Unmarshaller[String, T], inner: Function[T, Route]): Route

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

Source
PathDirectives.scala
def pathPrefixTest(segment: String, inner: Supplier[Route]): Route

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

Source
PathDirectives.scala
def pathPrefixTest(pm: PathMatcher0, inner: Supplier[Route]): Route

Attributes

Source
PathDirectives.scala
def pathPrefixTest[T1](pm: PathMatcher1[T1], inner: Function[T1, Route]): Route

Attributes

Source
PathDirectives.scala
def pathPrefixTest[T1, T2](pm: PathMatcher2[T1, T2], inner: BiFunction[T1, T2, Route]): Route

Attributes

Source
PathDirectives.scala
def pathSingleSlash(inner: Supplier[Route]): Route

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

Source
PathDirectives.scala
def pathSuffix(segment: String, inner: Supplier[Route]): Route

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

Source
PathDirectives.scala
def pathSuffix(pm: PathMatcher0, inner: Supplier[Route]): Route

Attributes

Source
PathDirectives.scala
def pathSuffix[T1](pm: PathMatcher1[T1], inner: Function[T1, Route]): Route

Attributes

Source
PathDirectives.scala
def pathSuffix[T1, T2](pm: PathMatcher2[T1, T2], inner: BiFunction[T1, T2, Route]): Route

Attributes

Source
PathDirectives.scala
def pathSuffixTest(segment: String, inner: Supplier[Route]): Route

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

Source
PathDirectives.scala
def pathSuffixTest(pm: PathMatcher0, inner: Supplier[Route]): Route

Attributes

Source
PathDirectives.scala
def pathSuffixTest[T1](pm: PathMatcher1[T1], inner: Function[T1, Route]): Route

Attributes

Source
PathDirectives.scala
def pathSuffixTest[T1, T2](pm: PathMatcher2[T1, T2], inner: BiFunction[T1, T2, Route]): Route

Attributes

Source
PathDirectives.scala
def rawPathPrefix(segment: String, inner: Supplier[Route]): Route

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

Source
PathDirectives.scala
def rawPathPrefix(pm: PathMatcher0, inner: Supplier[Route]): Route

Attributes

Source
PathDirectives.scala
def rawPathPrefix[T1](pm: PathMatcher1[T1], inner: Function[T1, Route]): Route

Attributes

Source
PathDirectives.scala
def rawPathPrefix[T1, T2](pm: PathMatcher2[T1, T2], inner: BiFunction[T1, T2, Route]): Route

Attributes

Source
PathDirectives.scala
def rawPathPrefixTest(segment: String, inner: Supplier[Route]): Route

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

Source
PathDirectives.scala
def rawPathPrefixTest[T1](pm: PathMatcher1[T1], inner: Function[T1, Route]): Route

Attributes

Source
PathDirectives.scala
def rawPathPrefixTest[T1, T2](pm: PathMatcher2[T1, T2], inner: BiFunction[T1, T2, Route]): Route

Attributes

Source
PathDirectives.scala
def redirectToNoTrailingSlashIfPresent(redirectionType: StatusCode, inner: Supplier[Route]): Route

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

Source
PathDirectives.scala
def redirectToTrailingSlashIfMissing(redirectionType: StatusCode, inner: Supplier[Route]): Route

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

Source
PathDirectives.scala

Inherited methods

def attribute[T](key: AttributeKey[T], inner: Function[T, Route]): RouteAdapter

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
def cancelRejection(rejection: Rejection, inner: Supplier[Route]): Route

Adds a TransformationRejection cancelling all rejections equal to the given one to the list of rejections potentially coming back from the inner route.

Adds a TransformationRejection cancelling all rejections equal to the given one to the list of rejections potentially coming back from the inner route.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def cancelRejections(filter: Predicate[Rejection], inner: Supplier[Route]): Route

Adds a TransformationRejection cancelling all rejections for which the given filter function returns true to the list of rejections potentially coming back from the inner route.

Adds a TransformationRejection cancelling all rejections for which the given filter function returns true to the list of rejections potentially coming back from the inner route.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def cancelRejections(classes: Iterable[Class[_]], inner: Supplier[Route]): Route

Adds a TransformationRejection cancelling all rejections of one of the given classes to the list of rejections potentially coming back from the inner route.

Adds a TransformationRejection cancelling all rejections of one of the given classes to the list of rejections potentially coming back from the inner route.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def completeWith[T](marshaller: Marshaller[T, _ <: HttpResponse], inner: Consumer[Consumer[T]]): Route

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
def conditional(eTag: Optional[EntityTag], lastModified: Optional[DateTime], inner: Supplier[Route]): Route

Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the outside of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

Attributes

Inherited from:
CacheConditionDirectives
Source
CacheConditionDirectives.scala
def conditional(eTag: EntityTag, lastModified: DateTime, inner: Supplier[Route]): Route

Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the outside of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

Attributes

Inherited from:
CacheConditionDirectives
Source
CacheConditionDirectives.scala
def conditional(lastModified: DateTime, inner: Supplier[Route]): Route

Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the outside of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

Attributes

Inherited from:
CacheConditionDirectives
Source
CacheConditionDirectives.scala
def conditional(eTag: EntityTag, inner: Supplier[Route]): Route

Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the outside of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

Attributes

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

Decompresses the incoming request if it is gzip or deflate compressed. Uncompressed requests are passed through untouched. If the request encoded with another encoding the request is rejected with an UnsupportedRequestEncodingRejection.

Decompresses the incoming request if it is gzip or deflate compressed. Uncompressed requests are passed through untouched. If the request encoded with another encoding the request is rejected with an UnsupportedRequestEncodingRejection.

Attributes

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

Decodes the incoming request if it is encoded with one of the given encoders. If the request encoding doesn't match one of the given encoders the request is rejected with an UnsupportedRequestEncodingRejection. If no decoders are given the default encoders (Gzip, Deflate, NoCoding) are used.

Decodes the incoming request if it is encoded with one of the given encoders. If the request encoding doesn't match one of the given encoders the request is rejected with an UnsupportedRequestEncodingRejection. If no decoders are given the default encoders (Gzip, Deflate, NoCoding) are used.

Attributes

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

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

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

Attributes

Inherited from:
CodingDirectives
Source
CodingDirectives.scala
def defaultContentTypeResolver: ContentTypeResolver

Default ContentTypeResolver.

Default ContentTypeResolver.

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def defaultDirectoryRenderer: DirectoryRenderer

Default DirectoryRenderer to be used with directory listing directives.

Default DirectoryRenderer to be used with directory listing directives.

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def delete(inner: Supplier[Route]): Route

Attributes

Inherited from:
MethodDirectives
Source
MethodDirectives.scala
def deleteCookie(name: String, domain: String, path: String, inner: Supplier[Route]): Route

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

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

Value parameters

domain

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

name

Name of the cookie to match

path

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

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
def deleteCookie(name: String, domain: String, inner: Supplier[Route]): Route

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

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

Value parameters

domain

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

name

Name of the cookie to match

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
def deleteCookie(name: String, inner: Supplier[Route]): Route

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

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

Value parameters

name

Name of the cookie to match

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
def deleteCookie(cookies: Iterable[HttpCookie], inner: Supplier[Route]): Route

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

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

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
def deleteCookie(cookie: HttpCookie, inner: Supplier[Route]): Route

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

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

Attributes

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

Encodes the response with the encoding that is requested by the client via the Accept- Encoding header. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.

Encodes the response with the encoding that is requested by the client via the Accept- Encoding header. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.

If the Accept-Encoding header is missing or empty or specifies an encoding other than identity, gzip or deflate then no encoding is used.

Attributes

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

Encodes the response with the encoding that is requested by the client via the Accept- Encoding header. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.

Encodes the response with the encoding that is requested by the client via the Accept- Encoding header. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.

If the Accept-Encoding header is missing then the response is encoded using the first encoder.

If the Accept-Encoding header is empty and NoCoding is part of the encoders then no response encoding is used. Otherwise the request is rejected.

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

Attributes

Inherited from:
CodingDirectives
Source
CodingDirectives.scala
def entity[T](unmarshaller: Unmarshaller[_ >: HttpEntity, T], inner: Function[T, Route]): Route

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
def extract[T](extract: Function[RequestContext, T], inner: Function[T, Route]): Route

Extracts a single value using the given function.

Extracts a single value using the given function.

Attributes

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

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

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

Attributes

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

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
def extractDataBytes(inner: Function[Source[ByteString, Any], Route]): RouteAdapter

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

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

Attributes

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

Extracts the current http request entity.

Extracts the current http request entity.

Attributes

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

Extracts the ExecutionContextExecutor from the RequestContext.

Extracts the ExecutionContextExecutor from the RequestContext.

Attributes

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

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
def extractLog(inner: Function[LoggingAdapter, Route]): Route

Extracts the LoggingAdapter

Extracts the LoggingAdapter

Attributes

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

Extracts the already matched path from the RequestContext.

Extracts the already matched path from the RequestContext.

Attributes

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

Extracts the Materializer from the RequestContext.

Extracts the Materializer from the RequestContext.

Attributes

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

Extracts the current HttpRequest instance.

Extracts the current HttpRequest instance.

Attributes

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

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

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

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def extractStrictEntity(timeout: FiniteDuration, maxBytes: Long, inner: Function[Strict, Route]): Route

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

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

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

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

Value parameters

timeout

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

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def extractStrictEntity(timeout: FiniteDuration, inner: Function[Strict, Route]): Route

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

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

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

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

Value parameters

timeout

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

Attributes

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

Extracts the yet unmatched path from the RequestContext.

Extracts the yet unmatched path from the RequestContext.

Attributes

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

Extracts the complete request URI.

Extracts the complete request URI.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def fileUpload(fieldName: String, inner: BiFunction[FileInfo, Source[ByteString, Any], Route]): Route

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
def fileUploadAll(fieldName: String, inner: Function[List[Entry[FileInfo, Source[ByteString, Any]]], Route]): Route

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
def formField[T](t: Unmarshaller[String, T], name: String, inner: Function[T, Route]): Route

Attributes

Inherited from:
FormFieldDirectives
Source
FormFieldDirectives.scala
def formField(name: String, inner: Function[String, Route]): Route

Attributes

Inherited from:
FormFieldDirectives
Source
FormFieldDirectives.scala
def formFieldList(inner: Function[List[Entry[String, String]], Route]): Route

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
def formFieldList[T](t: Unmarshaller[String, T], name: String, inner: Function[List[T], Route]): Route

Attributes

Inherited from:
FormFieldDirectives
Source
FormFieldDirectives.scala
def formFieldList(name: String, inner: Function[List[String], Route]): Route

Attributes

Inherited from:
FormFieldDirectives
Source
FormFieldDirectives.scala
def formFieldMap(inner: Function[Map[String, String], Route]): Route

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
def formFieldMultiMap(inner: Function[Map[String, List[String]], Route]): Route

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
def formFieldOptional[T](t: Unmarshaller[String, T], name: String, inner: Function[Optional[T], Route]): Route

Attributes

Inherited from:
FormFieldDirectives
Source
FormFieldDirectives.scala
def formFieldOptional(name: String, inner: Function[Optional[String], Route]): Route

Attributes

Inherited from:
FormFieldDirectives
Source
FormFieldDirectives.scala
def get(inner: Supplier[Route]): Route

Attributes

Inherited from:
MethodDirectives
Source
MethodDirectives.scala
def getFromBrowseableDirectories(directories: String*): Route

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

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

Attributes

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

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

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

Attributes

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

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

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

Attributes

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

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

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

Attributes

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

Same as getFromBrowseableDirectories with only one directory.

Same as getFromBrowseableDirectories with only one directory.

Attributes

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

Same as getFromBrowseableDirectories with only one directory.

Same as getFromBrowseableDirectories with only one directory.

Attributes

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

Same as getFromBrowseableDirectories with only one directory.

Same as getFromBrowseableDirectories with only one directory.

Attributes

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

Same as getFromBrowseableDirectories with only one directory.

Same as getFromBrowseableDirectories with only one directory.

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def getFromDirectory(directoryPath: String, resolver: ContentTypeResolver): Route

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

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

Attributes

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

Completes GET requests with the content of a file underneath the given directory, using the default content-type resolver. If the file cannot be read the Route rejects the request.

Completes GET requests with the content of a file underneath the given directory, using the default content-type resolver. If the file cannot be read the Route rejects the request.

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def getFromFile(file: String, resolver: ContentTypeResolver): Route

Completes GET requests with the content of the given file, resolving the content type using the given resolver. If the file cannot be found or read the request is rejected.

Completes GET requests with the content of the given file, resolving the content type using the given resolver. If the file cannot be found or read the request is rejected.

Attributes

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

Completes GET requests with the content of the given file, resolving the content type using the default resolver. If the file cannot be found or read the request is rejected.

Completes GET requests with the content of the given file, resolving the content type using the default resolver. If the file cannot be found or read the request is rejected.

Attributes

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

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

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

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def getFromFile(file: File, resolver: ContentTypeResolver): Route

Completes GET requests with the content of the given file, resolving the content type using the given resolver. If the file cannot be found or read the request is rejected.

Completes GET requests with the content of the given file, resolving the content type using the given resolver. If the file cannot be found or read the request is rejected.

Attributes

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

Completes GET requests with the content of the given file, resolving the content type using the default resolver. If the file cannot be found or read the request is rejected.

Completes GET requests with the content of the given file, resolving the content type using the default resolver. If the file cannot be found or read the request is rejected.

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def getFromResource(path: String, contentType: ContentType, classLoader: ClassLoader): Route

Completes GET requests with the content of the given resource loaded from the given ClassLoader, with the given content type. If the resource cannot be found or read the Route rejects the request.

Completes GET requests with the content of the given resource loaded from the given ClassLoader, with the given content type. If the resource cannot be found or read the Route rejects the request.

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def getFromResource(path: String, contentType: ContentType): Route

Completes GET requests with the content of the given resource loaded from the default ClassLoader, with the given content type. If the resource cannot be found or read the Route rejects the request.

Completes GET requests with the content of the given resource loaded from the default ClassLoader, with the given content type. If the resource cannot be found or read the Route rejects the request.

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def getFromResource(path: String, resolver: ContentTypeResolver): Route

Completes GET requests with the content of the given resource loaded from the default ClassLoader, using the given content type resolver. If the resource cannot be found or read the Route rejects the request.

Completes GET requests with the content of the given resource loaded from the default ClassLoader, using the given content type resolver. If the resource cannot be found or read the Route rejects the request.

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def getFromResource(path: String): Route

Completes GET requests with the content of the given resource loaded from the default ClassLoader, using the default content type resolver. If the resource cannot be found or read the Route rejects the request.

Completes GET requests with the content of the given resource loaded from the default ClassLoader, using the default content type resolver. If the resource cannot be found or read the Route rejects the request.

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def getFromResourceDirectory(directoryName: String, resolver: ContentTypeResolver, classLoader: ClassLoader): Route

Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the given ClassLoader, resolving content type using the given content type resolver.

Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the given ClassLoader, resolving content type using the given content type resolver.

If the requested resource is itself a directory or cannot be found or read the Route rejects the request.

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def getFromResourceDirectory(directoryName: String, resolver: ContentTypeResolver): Route

Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the default ClassLoader, resolving content type using the given content type resolver.

Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the default ClassLoader, resolving content type using the given content type resolver.

If the requested resource is itself a directory or cannot be found or read the Route rejects the request.

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def getFromResourceDirectory(directoryName: String, classLoader: ClassLoader): Route

Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the given ClassLoader, resolving content type using the default content type resolver.

Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the given ClassLoader, resolving content type using the default content type resolver.

If the requested resource is itself a directory or cannot be found or read the Route rejects the request.

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def getFromResourceDirectory(directoryName: String): Route

Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the default ClassLoader, resolving content type using the default content type resolver.

Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory", using the default ClassLoader, resolving content type using the default content type resolver.

If the requested resource is itself a directory or cannot be found or read the Route rejects the request.

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def handleExceptions(handler: ExceptionHandler, inner: Supplier[Route]): RouteAdapter

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

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

Attributes

Inherited from:
ExecutionDirectives
Source
ExecutionDirectives.scala
def handleRejections(handler: RejectionHandler, inner: Supplier[Route]): RouteAdapter

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

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

Attributes

Inherited from:
ExecutionDirectives
Source
ExecutionDirectives.scala
def handleWith[T, R](unmarshaller: Unmarshaller[_ >: HttpEntity, T], marshaller: Marshaller[R, _ <: HttpResponse], inner: Function[T, R]): Route

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
def head(inner: Supplier[Route]): Route

Attributes

Inherited from:
MethodDirectives
Source
MethodDirectives.scala
def headerValue[T](f: Function[HttpHeader, Optional[T]], inner: Function[T, Route]): RouteAdapter

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
def headerValueByName(headerName: String, inner: Function[String, Route]): RouteAdapter

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
def headerValueByType[T <: HttpHeader](t: Class[T], inner: Function[T, Route]): RouteAdapter

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
def headerValuePF[T](pf: PartialFunction[HttpHeader, T], inner: Function[T, Route]): RouteAdapter

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
def host(regex: Pattern, inner: Function[String, Route]): Route

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
def host(predicate: Predicate[String], inner: Supplier[Route]): Route

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
def host(hostName: String, inner: Supplier[Route]): Route

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
def host(hostNames: Iterable[String], inner: Supplier[Route]): Route

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
def listDirectoryContents(directoryRenderer: DirectoryRenderer, directories: String*): Route

Completes GET requests with a unified listing of the contents of all given directories. The actual rendering of the directory contents is performed by the in-scope Marshaller[DirectoryListing].

Completes GET requests with a unified listing of the contents of all given directories. The actual rendering of the directory contents is performed by the in-scope Marshaller[DirectoryListing].

Attributes

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

Completes GET requests with a unified listing of the contents of all given directories. The actual rendering of the directory contents is performed by the in-scope Marshaller[DirectoryListing].

Completes GET requests with a unified listing of the contents of all given directories. The actual rendering of the directory contents is performed by the in-scope Marshaller[DirectoryListing].

Attributes

Inherited from:
FileAndResourceDirectives
Source
FileAndResourceDirectives.scala
def logRequest(show: Function[HttpRequest, LogEntry], inner: Supplier[Route]): Route

Produces a log entry for every incoming request.

Produces a log entry for every incoming request.

Attributes

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

Produces a log entry for every incoming request.

Produces a log entry for every incoming request.

Value parameters

level

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

Attributes

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

Produces a log entry for every incoming request.

Produces a log entry for every incoming request.

Attributes

Inherited from:
DebuggingDirectives
Source
DebuggingDirectives.scala
def logRequestResult(showSuccess: BiFunction[HttpRequest, HttpResponse, LogEntry], showRejection: BiFunction[HttpRequest, List[Rejection], LogEntry], inner: Supplier[Route]): RouteAdapter

Produces a log entry for every request/response combination.

Produces a log entry for every request/response combination.

Value parameters

showRejection

Function invoked when the route yielded a rejection

showSuccess

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

Attributes

Inherited from:
DebuggingDirectives
Source
DebuggingDirectives.scala
def logRequestResultOptional(showSuccess: BiFunction[HttpRequest, HttpResponse, Optional[LogEntry]], showRejection: BiFunction[HttpRequest, List[Rejection], Optional[LogEntry]], inner: Supplier[Route]): RouteAdapter

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

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

Value parameters

showRejection

Function invoked when the route yielded a rejection

showSuccess

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

Attributes

Inherited from:
DebuggingDirectives
Source
DebuggingDirectives.scala
def logResult(showSuccess: Function[HttpResponse, LogEntry], showRejection: Function[List[Rejection], LogEntry], inner: Supplier[Route]): RouteAdapter

Produces a log entry for every route result.

Produces a log entry for every route result.

Value parameters

showRejection

Function invoked when the route yielded a rejection

showSuccess

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

Attributes

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

Produces a log entry for every route result.

Produces a log entry for every route result.

Value parameters

level

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

Attributes

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

Produces a log entry for every route result.

Produces a log entry for every route result.

Attributes

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

Attributes

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

Attributes

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

Attributes

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

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

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

Attributes

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

Transforms the unmatchedPath of the RequestContext using the given function.

Transforms the unmatchedPath of the RequestContext using the given function.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def method(method: HttpMethod, inner: Supplier[Route]): Route

Attributes

Inherited from:
MethodDirectives
Source
MethodDirectives.scala
def optionalAttribute[T](key: AttributeKey[T], inner: Function[Optional[T], Route]): RouteAdapter

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
def optionalCookie(name: String, inner: Function[Optional[HttpCookiePair], Route]): Route

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

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

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
def optionalHeaderValue[T](f: Function[HttpHeader, Optional[T]], inner: Function[Optional[T], Route]): RouteAdapter

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
def optionalHeaderValueByName(headerName: String, inner: Function[Optional[String], Route]): RouteAdapter

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
def optionalHeaderValueByType[T <: HttpHeader](t: Class[T], inner: Function[Optional[T], Route]): RouteAdapter

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
def optionalHeaderValuePF[T](pf: PartialFunction[HttpHeader, T], inner: Function[Optional[T], Route]): RouteAdapter

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
def options(inner: Supplier[Route]): Route

Attributes

Inherited from:
MethodDirectives
Source
MethodDirectives.scala
def overrideMethodWithParameter(paramName: String, inner: Supplier[Route]): Route

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
def parameter[T](t: Unmarshaller[String, T], name: String, inner: Function[T, Route]): Route

Attributes

Inherited from:
ParameterDirectives
Source
ParameterDirectives.scala
def parameter(name: String, inner: Function[String, Route]): Route

Attributes

Inherited from:
ParameterDirectives
Source
ParameterDirectives.scala
def parameterList[T](t: Unmarshaller[String, T], name: String, inner: Function[List[T], Route]): Route

Attributes

Inherited from:
ParameterDirectives
Source
ParameterDirectives.scala
def parameterList(name: String, inner: Function[List[String], Route]): Route

Attributes

Inherited from:
ParameterDirectives
Source
ParameterDirectives.scala
def parameterMap(inner: Function[Map[String, String], Route]): Route

Attributes

Inherited from:
ParameterDirectives
Source
ParameterDirectives.scala
def parameterOptional[T](t: Unmarshaller[String, T], name: String, inner: Function[Optional[T], Route]): Route

Attributes

Inherited from:
ParameterDirectives
Source
ParameterDirectives.scala
def parameterOptional(name: String, inner: Function[Optional[String], Route]): Route

Attributes

Inherited from:
ParameterDirectives
Source
ParameterDirectives.scala
def parameterOrDefault[T](t: Unmarshaller[String, T], defaultValue: T, name: String, inner: Function[T, Route]): Route

Attributes

Inherited from:
ParameterDirectives
Source
ParameterDirectives.scala
def parameterRequiredValue[T](t: Unmarshaller[String, T], requiredValue: T, name: String, inner: Supplier[Route]): Route

Attributes

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

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

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

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def patch(inner: Supplier[Route]): Route

Attributes

Inherited from:
MethodDirectives
Source
MethodDirectives.scala
def post(inner: Supplier[Route]): Route

Attributes

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

Injects the given value into a directive.

Injects the given value into a directive.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def put(inner: Supplier[Route]): Route

Attributes

Inherited from:
MethodDirectives
Source
MethodDirectives.scala
def rejectEmptyResponse(inner: Supplier[Route]): Route

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
def request[T](unmarshaller: Unmarshaller[_ >: HttpRequest, T], inner: Function[T, Route]): Route

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
def requestEncodedWith(encoding: HttpEncoding, inner: Supplier[Route]): Route

Rejects the request with an UnsupportedRequestEncodingRejection if its encoding doesn't match the given one.

Rejects the request with an UnsupportedRequestEncodingRejection if its encoding doesn't match the given one.

Attributes

Inherited from:
CodingDirectives
Source
CodingDirectives.scala
def requestEntityEmpty(inner: Supplier[Route]): Route

Rejects if the request entity is non-empty.

Rejects if the request entity is non-empty.

Attributes

Inherited from:
MiscDirectives
Source
MiscDirectives.scala
def requestEntityPresent(inner: Supplier[Route]): Route

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
def responseEncodingAccepted(encoding: HttpEncoding, inner: Supplier[Route]): Route

Rejects the request with an UnacceptedResponseEncodingRejection if the given response encoding is not accepted by the client.

Rejects the request with an UnacceptedResponseEncodingRejection if the given response encoding is not accepted by the client.

Attributes

Inherited from:
CodingDirectives
Source
CodingDirectives.scala
def selectPreferredLanguage(languages: Iterable[Language], inner: Function[Language, Route]): Route

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
def setCookie(cookies: Iterable[HttpCookie], inner: Supplier[Route]): Route

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

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

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
def setCookie(cookie: HttpCookie, inner: Supplier[Route]): Route

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

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

Attributes

Inherited from:
CookieDirectives
Source
CookieDirectives.scala
def storeUploadedFile(fieldName: String, destFn: Function[FileInfo, File], inner: BiFunction[FileInfo, File, Route]): Route

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
def storeUploadedFiles(fieldName: String, destFn: Function[FileInfo, File], inner: Function[List[Entry[FileInfo, File]], Route]): Route

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
def toStrictEntity(timeout: FiniteDuration, maxBytes: Long, inner: Supplier[Route]): Route

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

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

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

Extracts the pekko.http.javadsl.server.RequestContext itself with the strict HTTP entity, or fails the route if unable to drain the entire request body within the timeout.

Value parameters

timeout

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

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def toStrictEntity(timeout: FiniteDuration, inner: Supplier[Route]): Route

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

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

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

Extracts the pekko.http.javadsl.server.RequestContext itself with the strict HTTP entity, or fails the route if unable to drain the entire request body within the timeout.

Value parameters

timeout

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

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def validate(check: BooleanSupplier, errorMsg: String, inner: Supplier[Route]): Route

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
def withExecutionContext(ec: ExecutionContextExecutor, inner: Supplier[Route]): Route

Runs its inner route with the given alternative scala.concurrent.ExecutionContextExecutor.

Runs its inner route with the given alternative scala.concurrent.ExecutionContextExecutor.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def withLog(log: LoggingAdapter, inner: Supplier[Route]): Route

Runs its inner route with the given alternative LoggingAdapter.

Runs its inner route with the given alternative LoggingAdapter.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def withMaterializer(mat: Materializer, inner: Supplier[Route]): Route

Runs its inner route with the given alternative pekko.stream.Materializer.

Runs its inner route with the given alternative pekko.stream.Materializer.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def withPrecompressedMediaTypeSupport(inner: Supplier[Route]): Route

Inspects the response entity and adds a Content-Encoding: gzip response header if the entity's media-type is precompressed with gzip and no Content-Encoding header is present yet.

Inspects the response entity and adds a Content-Encoding: gzip response header if the entity's media-type is precompressed with gzip and no Content-Encoding header is present yet.

Attributes

Inherited from:
CodingDirectives
Source
CodingDirectives.scala
def withSettings(s: RoutingSettings, inner: Supplier[Route]): Route

Runs its inner route with the given alternative RoutingSettings.

Runs its inner route with the given alternative RoutingSettings.

Attributes

Inherited from:
BasicDirectives
Source
BasicDirectives.scala
def withSizeLimit(maxBytes: Long, inner: Supplier[Route]): Route

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
def withoutSizeLimit(inner: Supplier[Route]): Route

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 withoutSizeLimit is not recommended as it turns off the too large payload protection. Therefore, we highly encourage using withSizeLimit instead, providing it with a value high enough to successfully handle the route in need of big entities.

Inherited from:
MiscDirectives
Source
MiscDirectives.scala
Generated with