abstract class AttributeDirectives extends HeaderDirectives
- Grouped
- Alphabetic
- By Inheritance
- AttributeDirectives
- HeaderDirectives
- FutureDirectives
- FormFieldDirectives
- FileUploadDirectives
- FileAndResourceDirectives
- ExecutionDirectives
- DebuggingDirectives
- CookieDirectives
- CodingDirectives
- CacheConditionDirectives
- BasicDirectives
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new AttributeDirectives()
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from AttributeDirectives toany2stringadd[AttributeDirectives] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (AttributeDirectives, B)
- Implicit
- This member is added by an implicit conversion from AttributeDirectives toArrowAssoc[AttributeDirectives] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def attribute[T](key: AttributeKey[T], inner: Function[T, Route]): RouteAdapter
Extracts the value of the request attribute with the given key.
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.
- 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.
- Definition Classes
- BasicDirectives
- 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.
- Definition Classes
- BasicDirectives
- 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.
- Definition Classes
- BasicDirectives
- def checkSameOrigin(allowed: HttpOriginRange, inner: Supplier[Route]): Route
Checks that request comes from the same origin.
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.
- Definition Classes
- HeaderDirectives
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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 typeThrowable."Unwraps" a
CompletionStage<T>and runs the inner route when the stage has failed with the stage's failure exception as an extraction of typeThrowable. 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.)- Definition Classes
- FutureDirectives
- 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 thewithRangeSupport(...)directive, i.e.withRangeSupport(...)must be on a deeper level in your route structure in order to function correctly.- Definition Classes
- CacheConditionDirectives
- 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 thewithRangeSupport(...)directive, i.e.withRangeSupport(...)must be on a deeper level in your route structure in order to function correctly.- Definition Classes
- CacheConditionDirectives
- 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 thewithRangeSupport(...)directive, i.e.withRangeSupport(...)must be on a deeper level in your route structure in order to function correctly.- Definition Classes
- CacheConditionDirectives
- 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 thewithRangeSupport(...)directive, i.e.withRangeSupport(...)must be on a deeper level in your route structure in order to function correctly.- Definition Classes
- CacheConditionDirectives
- def cookie(name: String, inner: Function[HttpCookiePair, Route]): Route
Extracts the HttpCookiePair with the given name.
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.
- Definition Classes
- CookieDirectives
- def decodeRequest(inner: Supplier[Route]): Route
Decompresses the incoming request if it is
gzipordeflatecompressed.Decompresses the incoming request if it is
gzipordeflatecompressed. Uncompressed requests are passed through untouched. If the request encoded with another encoding the request is rejected with anUnsupportedRequestEncodingRejection.- Definition Classes
- CodingDirectives
- def decodeRequestWith(coders: Iterable[Coder], inner: Supplier[Route]): Route
Decodes the incoming request if it is encoded with one of the given encoders.
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.- Definition Classes
- CodingDirectives
- def decodeRequestWith(coder: Coder, inner: Supplier[Route]): Route
Decodes the incoming request using the given Decoder.
Decodes the incoming request using the given Decoder. If the request encoding doesn't match the request is rejected with an
UnsupportedRequestEncodingRejection.- Definition Classes
- CodingDirectives
- def defaultContentTypeResolver: ContentTypeResolver
Default ContentTypeResolver.
Default ContentTypeResolver.
- Definition Classes
- FileAndResourceDirectives
- def defaultDirectoryRenderer: DirectoryRenderer
Default DirectoryRenderer to be used with directory listing directives.
Default DirectoryRenderer to be used with directory listing directives.
- Definition Classes
- FileAndResourceDirectives
- 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.
- name
Name of the cookie to match
- domain
Domain of the cookie to match, or empty string to match any domain
- path
Path of the cookie to match, or empty string to match any path
- Definition Classes
- CookieDirectives
- 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.
- name
Name of the cookie to match
- domain
Domain of the cookie to match, or empty string to match any domain
- Definition Classes
- CookieDirectives
- 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.
- name
Name of the cookie to match
- Definition Classes
- CookieDirectives
- 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.
- Definition Classes
- CookieDirectives
- 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.
- Definition Classes
- CookieDirectives
- def encodeResponse(inner: Supplier[Route]): Route
Encodes the response with the encoding that is requested by the client via the
Accept- Encodingheader.Encodes the response with the encoding that is requested by the client via the
Accept- Encodingheader. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.If the
Accept-Encodingheader is missing or empty or specifies an encoding other than identity, gzip or deflate then no encoding is used.- Definition Classes
- CodingDirectives
- def encodeResponseWith(coders: Iterable[Coder], inner: Supplier[Route]): Route
Encodes the response with the encoding that is requested by the client via the
Accept- Encodingheader.Encodes the response with the encoding that is requested by the client via the
Accept- Encodingheader. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.If the
Accept-Encodingheader is missing then the response is encoded using thefirstencoder.If the
Accept-Encodingheader is empty andNoCodingis part of the encoders then no response encoding is used. Otherwise the request is rejected.If [encoders] is empty, no encoding is performed.
- Definition Classes
- CodingDirectives
- def ensuring(cond: (AttributeDirectives) => Boolean, msg: => Any): AttributeDirectives
- Implicit
- This member is added by an implicit conversion from AttributeDirectives toEnsuring[AttributeDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (AttributeDirectives) => Boolean): AttributeDirectives
- Implicit
- This member is added by an implicit conversion from AttributeDirectives toEnsuring[AttributeDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): AttributeDirectives
- Implicit
- This member is added by an implicit conversion from AttributeDirectives toEnsuring[AttributeDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): AttributeDirectives
- Implicit
- This member is added by an implicit conversion from AttributeDirectives toEnsuring[AttributeDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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.
- Definition Classes
- BasicDirectives
- def extractActorSystem(inner: Function[ActorSystem, Route]): Route
Extracts the pekko.actor.ActorSystem if the available Materializer is an pekko.stream.ActorMaterializer.
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.
- Definition Classes
- BasicDirectives
- def extractDataBytes(inner: Function[Source[ByteString, Any], Route]): RouteAdapter
Extracts the entities
dataBytespekko.stream.javadsl.Source from the pekko.http.javadsl.server.RequestContext.Extracts the entities
dataBytespekko.stream.javadsl.Source from the pekko.http.javadsl.server.RequestContext.- Definition Classes
- BasicDirectives
- def extractEntity(inner: Function[RequestEntity, Route]): Route
Extracts the current http request entity.
Extracts the current http request entity.
- Definition Classes
- BasicDirectives
- Annotations
- @CorrespondsTo()
- def extractExecutionContext(inner: Function[ExecutionContextExecutor, Route]): Route
Extracts the ExecutionContextExecutor from the RequestContext.
Extracts the ExecutionContextExecutor from the RequestContext.
- Definition Classes
- BasicDirectives
- def extractLog(inner: Function[LoggingAdapter, Route]): Route
Extracts the LoggingAdapter
Extracts the LoggingAdapter
- Definition Classes
- BasicDirectives
- def extractMatchedPath(inner: Function[String, Route]): RouteAdapter
Extracts the already matched path from the RequestContext.
Extracts the already matched path from the RequestContext.
- Definition Classes
- BasicDirectives
- def extractMaterializer(inner: Function[Materializer, Route]): Route
Extracts the Materializer from the RequestContext.
Extracts the Materializer from the RequestContext.
- Definition Classes
- BasicDirectives
- def extractParserSettings(inner: Function[ParserSettings, Route]): RouteAdapter
Extracts the pekko.http.javadsl.settings.ParserSettings from the pekko.http.javadsl.server.RequestContext.
Extracts the pekko.http.javadsl.settings.ParserSettings from the pekko.http.javadsl.server.RequestContext.
- Definition Classes
- BasicDirectives
- def extractRequest(inner: Function[HttpRequest, Route]): RouteAdapter
Extracts the current HttpRequest instance.
Extracts the current HttpRequest instance.
- Definition Classes
- BasicDirectives
- def extractRequestContext(inner: Function[RequestContext, Route]): RouteAdapter
Extracts the pekko.http.javadsl.server.RequestContext itself.
Extracts the pekko.http.javadsl.server.RequestContext itself.
- Definition Classes
- BasicDirectives
- def extractRequestEntity(inner: Function[RequestEntity, Route]): Route
Extracts the pekko.http.javadsl.model.RequestEntity from the pekko.http.javadsl.server.RequestContext.
Extracts the pekko.http.javadsl.model.RequestEntity from the pekko.http.javadsl.server.RequestContext.
- Definition Classes
- BasicDirectives
- 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.
- Definition Classes
- BasicDirectives
- 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-bytesconfiguration 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.
- timeout
The directive is failed if the stream isn't completed after the given timeout.
- Definition Classes
- BasicDirectives
- 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-bytesconfiguration 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.
- timeout
The directive is failed if the stream isn't completed after the given timeout.
- Definition Classes
- BasicDirectives
- def extractUnmatchedPath(inner: Function[String, Route]): RouteAdapter
Extracts the yet unmatched path from the RequestContext.
Extracts the yet unmatched path from the RequestContext.
- Definition Classes
- BasicDirectives
- def extractUri(inner: Function[Uri, Route]): RouteAdapter
Extracts the complete request URI.
Extracts the complete request URI.
- Definition Classes
- BasicDirectives
- 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
Sourcefor streaming the file contents somewhere.Collects each body part that is a multipart file as a tuple containing metadata and a
Sourcefor 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.- Definition Classes
- FileUploadDirectives
- 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
Sourcefor streaming the file contents somewhere.Collects each body part that is a multipart file as a tuple containing metadata and a
Sourcefor 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.- Definition Classes
- FileUploadDirectives
- Annotations
- @ApiMayChange()
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formField[T](t: Unmarshaller[String, T], name: String, inner: Function[T, Route]): Route
- Definition Classes
- FormFieldDirectives
- def formField(name: String, inner: Function[String, Route]): Route
- Definition Classes
- FormFieldDirectives
- 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>>- Definition Classes
- FormFieldDirectives
- Annotations
- @CorrespondsTo()
- def formFieldList[T](t: Unmarshaller[String, T], name: String, inner: Function[List[T], Route]): Route
- Definition Classes
- FormFieldDirectives
- Annotations
- @CorrespondsTo()
- def formFieldList(name: String, inner: Function[List[String], Route]): Route
- Definition Classes
- FormFieldDirectives
- Annotations
- @CorrespondsTo()
- 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>- Definition Classes
- FormFieldDirectives
- 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>>- Definition Classes
- FormFieldDirectives
- def formFieldOptional[T](t: Unmarshaller[String, T], name: String, inner: Function[Optional[T], Route]): Route
- Definition Classes
- FormFieldDirectives
- Annotations
- @CorrespondsTo()
- def formFieldOptional(name: String, inner: Function[Optional[String], Route]): Route
- Definition Classes
- FormFieldDirectives
- Annotations
- @CorrespondsTo()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getFromBrowseableDirectories(directories: String*): Route
Serves the content of the given directories as a file system browser, i.e.
Serves the content of the given directories as a file system browser, i.e. files are sent and directories served as browseable listings.
- Definition Classes
- FileAndResourceDirectives
- Annotations
- @varargs()
- def getFromBrowseableDirectories(directories: Iterable[String], resolver: ContentTypeResolver): Route
Serves the content of the given directories as a file system browser, i.e.
Serves the content of the given directories as a file system browser, i.e. files are sent and directories served as browseable listings.
- Definition Classes
- FileAndResourceDirectives
- def getFromBrowseableDirectories(directories: Iterable[String], renderer: DirectoryRenderer): Route
Serves the content of the given directories as a file system browser, i.e.
Serves the content of the given directories as a file system browser, i.e. files are sent and directories served as browseable listings.
- Definition Classes
- FileAndResourceDirectives
- def getFromBrowseableDirectories(directories: Iterable[String], renderer: DirectoryRenderer, resolver: ContentTypeResolver): Route
Serves the content of the given directories as a file system browser, i.e.
Serves the content of the given directories as a file system browser, i.e. files are sent and directories served as browseable listings.
- Definition Classes
- FileAndResourceDirectives
- def getFromBrowseableDirectory(directory: String): Route
Same as
getFromBrowseableDirectorieswith only one directory.Same as
getFromBrowseableDirectorieswith only one directory.- Definition Classes
- FileAndResourceDirectives
- def getFromBrowseableDirectory(directory: String, resolver: ContentTypeResolver): Route
Same as
getFromBrowseableDirectorieswith only one directory.Same as
getFromBrowseableDirectorieswith only one directory.- Definition Classes
- FileAndResourceDirectives
- def getFromBrowseableDirectory(directory: String, renderer: DirectoryRenderer): Route
Same as
getFromBrowseableDirectorieswith only one directory.Same as
getFromBrowseableDirectorieswith only one directory.- Definition Classes
- FileAndResourceDirectives
- def getFromBrowseableDirectory(directory: String, renderer: DirectoryRenderer, resolver: ContentTypeResolver): Route
Same as
getFromBrowseableDirectorieswith only one directory.Same as
getFromBrowseableDirectorieswith only one directory.- Definition Classes
- FileAndResourceDirectives
- 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.
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.
- Definition Classes
- FileAndResourceDirectives
- def getFromDirectory(directoryPath: String): Route
Completes GET requests with the content of a file underneath the given directory, using the default content-type resolver.
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.
- Definition Classes
- FileAndResourceDirectives
- 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.
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.
- Definition Classes
- FileAndResourceDirectives
- def getFromFile(file: String): Route
Completes GET requests with the content of the given file, resolving the content type using the default resolver.
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.
- Definition Classes
- FileAndResourceDirectives
- def getFromFile(file: File, contentType: ContentType): Route
Completes GET requests with the content of the given file, using the content type.
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.
- Definition Classes
- FileAndResourceDirectives
- 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.
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.
- Definition Classes
- FileAndResourceDirectives
- def getFromFile(file: File): Route
Completes GET requests with the content of the given file, resolving the content type using the default resolver.
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.
- Definition Classes
- FileAndResourceDirectives
- 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.
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.
- Definition Classes
- FileAndResourceDirectives
- 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.
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.
- Definition Classes
- FileAndResourceDirectives
- 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.
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.
- Definition Classes
- FileAndResourceDirectives
- 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.
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.
- Definition Classes
- FileAndResourceDirectives
- 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.
- Definition Classes
- FileAndResourceDirectives
- 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.
- Definition Classes
- FileAndResourceDirectives
- 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.
- Definition Classes
- FileAndResourceDirectives
- 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.
- Definition Classes
- FileAndResourceDirectives
- 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.
- Definition Classes
- ExecutionDirectives
- 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.
- Definition Classes
- ExecutionDirectives
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def headerValue[T](f: Function[HttpHeader, Optional[T]], inner: Function[T, Route]): RouteAdapter
Extracts an HTTP header value using the given function.
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.
- Definition Classes
- HeaderDirectives
- def headerValueByName(headerName: String, inner: Function[String, Route]): RouteAdapter
Extracts the value of the first HTTP request header with the given name.
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.
- Definition Classes
- HeaderDirectives
- def headerValueByType[T <: HttpHeader](t: Class[T], inner: Function[T, Route]): RouteAdapter
Extracts the first HTTP request header of the given type.
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.
- Definition Classes
- HeaderDirectives
- def headerValuePF[T](pf: PartialFunction[HttpHeader, T], inner: Function[T, Route]): RouteAdapter
Extracts an HTTP header value using the given partial function.
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.
- Definition Classes
- HeaderDirectives
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def listDirectoryContents(directoryRenderer: DirectoryRenderer, directories: String*): Route
Completes GET requests with a unified listing of the contents of all given directories.
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].- Definition Classes
- FileAndResourceDirectives
- Annotations
- @varargs()
- def listDirectoryContents(directories: String*): Route
Completes GET requests with a unified listing of the contents of all given directories.
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].- Definition Classes
- FileAndResourceDirectives
- Annotations
- @varargs()
- 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.
- Definition Classes
- DebuggingDirectives
- 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.
- level
One of the log levels defined in pekko.event.Logging
- Definition Classes
- DebuggingDirectives
- def logRequest(marker: String, inner: Supplier[Route]): Route
Produces a log entry for every incoming request.
Produces a log entry for every incoming request.
- Definition Classes
- DebuggingDirectives
- 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.
- showSuccess
Function invoked when the route result was successful and yielded an HTTP response
- showRejection
Function invoked when the route yielded a rejection
- Definition Classes
- DebuggingDirectives
- 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.
- showSuccess
Function invoked when the route result was successful and yielded an HTTP response
- showRejection
Function invoked when the route yielded a rejection
- Definition Classes
- DebuggingDirectives
- Annotations
- @CorrespondsTo()
- 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.
- showSuccess
Function invoked when the route result was successful and yielded an HTTP response
- showRejection
Function invoked when the route yielded a rejection
- Definition Classes
- DebuggingDirectives
- 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.
- level
One of the log levels defined in pekko.event.Logging
- Definition Classes
- DebuggingDirectives
- def logResult(marker: String, inner: Supplier[Route]): Route
Produces a log entry for every route result.
Produces a log entry for every route result.
- Definition Classes
- DebuggingDirectives
- def mapInnerRoute(f: Function[Route, Route], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
- def mapRejections(f: Function[List[Rejection], List[Rejection]], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
- def mapRequest(f: Function[HttpRequest, HttpRequest], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
- def mapRequestContext(f: Function[RequestContext, RequestContext], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
- def mapResponse(f: Function[HttpResponse, HttpResponse], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
- def mapResponseEntity(f: Function[ResponseEntity, ResponseEntity], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
- def mapResponseHeaders(f: Function[List[HttpHeader], List[HttpHeader]], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
- def mapRouteResult(f: Function[RouteResult, RouteResult], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
- def mapRouteResultFuture(f: Function[CompletionStage[RouteResult], CompletionStage[RouteResult]], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
- def mapRouteResultPF(f: PartialFunction[RouteResult, RouteResult], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
- def mapRouteResultWith(f: Function[RouteResult, CompletionStage[RouteResult]], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
- def mapRouteResultWithPF(f: PartialFunction[RouteResult, CompletionStage[RouteResult]], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
- 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.
- Definition Classes
- BasicDirectives
- 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.
- Definition Classes
- BasicDirectives
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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 typeTry<T>."Unwraps" a
CompletionStage<T>and runs the inner route after future completion with the future's value as an extraction of typeTry<T>.- Definition Classes
- FutureDirectives
- 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 typeTry<T>."Unwraps" a
CompletionStage<T>and runs the inner route after future completion with the future's value as an extraction of typeTry<T>.- Definition Classes
- FutureDirectives
- 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 typeTif the suppliedCircuitBreakeris closed."Unwraps" a
CompletionStage[T]and runs the inner route after future completion with the future's value as an extraction of typeTif the suppliedCircuitBreakeris closed.If the supplied CircuitBreaker is open the request is rejected with a pekko.http.javadsl.server.CircuitBreakerOpenRejection.
- Definition Classes
- FutureDirectives
- 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 typeT."Unwraps" a
CompletionStage<T>and runs the inner route after stage completion with the stage's value as an extraction of typeT. If the stage fails its failure Throwable is bubbled up to the nearest ExceptionHandler.- Definition Classes
- FutureDirectives
- 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 typeT."Unwraps" a
CompletionStage<T>and runs the inner route after stage completion with the stage's value as an extraction of typeT. If the stage fails its failure Throwable is bubbled up to the nearest ExceptionHandler.- Definition Classes
- FutureDirectives
- def optionalAttribute[T](key: AttributeKey[T], inner: Function[Optional[T], Route]): RouteAdapter
Extracts the value of the optional request attribute with the given key.
- def optionalCookie(name: String, inner: Function[Optional[HttpCookiePair], Route]): Route
Extracts the HttpCookiePair with the given name as an
Option[HttpCookiePair].Extracts the HttpCookiePair with the given name as an
Option[HttpCookiePair]. If the cookie is not present a value ofNoneis extracted.- Definition Classes
- CookieDirectives
- def optionalHeaderValue[T](f: Function[HttpHeader, Optional[T]], inner: Function[Optional[T], Route]): RouteAdapter
Extracts an optional HTTP header value using the given function.
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.
- Definition Classes
- HeaderDirectives
- 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.
- Definition Classes
- HeaderDirectives
- 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.
- Definition Classes
- HeaderDirectives
- def optionalHeaderValuePF[T](pf: PartialFunction[HttpHeader, T], inner: Function[Optional[T], Route]): RouteAdapter
Extracts an optional HTTP header value using the given partial function.
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.
- Definition Classes
- HeaderDirectives
- def pass(inner: Supplier[Route]): Route
Always passes the request on to its inner route (i.e.
Always passes the request on to its inner route (i.e. does nothing with the request or the response).
- Definition Classes
- BasicDirectives
- def provide[T](t: T, inner: Function[T, Route]): Route
Injects the given value into a directive.
Injects the given value into a directive.
- Definition Classes
- BasicDirectives
- def recoverRejections(f: Function[Iterable[Rejection], RouteResult], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
- def recoverRejectionsWith(f: Function[Iterable[Rejection], CompletionStage[RouteResult]], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
- 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.
- Definition Classes
- CodingDirectives
- 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.
- Definition Classes
- CodingDirectives
- 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.
- Definition Classes
- CookieDirectives
- 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.
- Definition Classes
- CookieDirectives
- 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.
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.
- Definition Classes
- FileUploadDirectives
- Annotations
- @ApiMayChange()
- 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.
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.
- Definition Classes
- FileUploadDirectives
- Annotations
- @ApiMayChange()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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-bytesconfiguration 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.
- timeout
The directive is failed if the stream isn't completed after the given timeout.
- Definition Classes
- BasicDirectives
- 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-bytesconfiguration 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.
- timeout
The directive is failed if the stream isn't completed after the given timeout.
- Definition Classes
- BasicDirectives
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- 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.
- Definition Classes
- BasicDirectives
- 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.
- Definition Classes
- BasicDirectives
- 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.
- Definition Classes
- BasicDirectives
- def withPrecompressedMediaTypeSupport(inner: Supplier[Route]): Route
Inspects the response entity and adds a
Content-Encoding: gzipresponse header if the entity's media-type is precompressed with gzip and noContent-Encodingheader is present yet.Inspects the response entity and adds a
Content-Encoding: gzipresponse header if the entity's media-type is precompressed with gzip and noContent-Encodingheader is present yet.- Definition Classes
- CodingDirectives
- 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.
- Definition Classes
- BasicDirectives
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from AttributeDirectives toStringFormat[AttributeDirectives] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (AttributeDirectives, B)
- Implicit
- This member is added by an implicit conversion from AttributeDirectives toArrowAssoc[AttributeDirectives] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.