org.apache.pekko.http.javadsl.server.directives

FormFieldDirectives

abstract class FormFieldDirectives extends FileUploadDirectives

Source: FormFieldDirectives.scala

Linear Supertypes

FileUploadDirectives, FileAndResourceDirectives, ExecutionDirectives, DebuggingDirectives, CookieDirectives, CodingDirectives, CacheConditionDirectives, BasicDirectives, AnyRef, Any

Type Hierarchy

Ordering

Alphabetic
By Inheritance

Inherited

FormFieldDirectives
FileUploadDirectives
FileAndResourceDirectives
ExecutionDirectives
DebuggingDirectives
CookieDirectives
CodingDirectives
CacheConditionDirectives
BasicDirectives
AnyRef
Any

Implicitly

by any2stringadd
by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new FormFieldDirectives()

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 FormFieldDirectives toany2stringadd[FormFieldDirectives] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (FormFieldDirectives, B)
Implicit
This member is added by an implicit conversion from FormFieldDirectives toArrowAssoc[FormFieldDirectives] 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 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 clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
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.
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 the withRangeSupport(...) 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 the withRangeSupport(...) 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 the withRangeSupport(...) 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 gzip or deflate compressed.
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.
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- Encoding header.
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.
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- Encoding header.
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.
Definition Classes
CodingDirectives
def ensuring(cond: (FormFieldDirectives) => Boolean, msg: => Any): FormFieldDirectives
Implicit
This member is added by an implicit conversion from FormFieldDirectives toEnsuring[FormFieldDirectives] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (FormFieldDirectives) => Boolean): FormFieldDirectives
Implicit
This member is added by an implicit conversion from FormFieldDirectives toEnsuring[FormFieldDirectives] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): FormFieldDirectives
Implicit
This member is added by an implicit conversion from FormFieldDirectives toEnsuring[FormFieldDirectives] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): FormFieldDirectives
Implicit
This member is added by an implicit conversion from FormFieldDirectives toEnsuring[FormFieldDirectives] 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 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.
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-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.
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-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.
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 Source for streaming the file contents somewhere.
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.
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 Source for streaming the file contents somewhere.
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.
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
def formField(name: String, inner: Function[String, Route]): Route
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>>.
Annotations
@CorrespondsTo()
def formFieldList[T](t: Unmarshaller[String, T], name: String, inner: Function[List[T], Route]): Route
Annotations
@CorrespondsTo()
def formFieldList(name: String, inner: Function[List[String], Route]): Route
Annotations
@CorrespondsTo()
def formFieldMap(inner: Function[Map[String, String], Route]): Route
Extracts HTTP form fields from the request as a Map<String, String>.
def formFieldMultiMap(inner: Function[Map[String, List[String]], Route]): Route
Extracts HTTP form fields from the request as a Map<String, List<String>>.
def formFieldOptional[T](t: Unmarshaller[String, T], name: String, inner: Function[Optional[T], Route]): Route
Annotations
@CorrespondsTo()
def formFieldOptional(name: String, inner: Function[Optional[String], Route]): Route
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 getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with only one directory.
Definition Classes
FileAndResourceDirectives
def getFromBrowseableDirectory(directory: String, resolver: ContentTypeResolver): Route
Same as getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with only one directory.
Definition Classes
FileAndResourceDirectives
def getFromBrowseableDirectory(directory: String, renderer: DirectoryRenderer): Route
Same as getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with only one directory.
Definition Classes
FileAndResourceDirectives
def getFromBrowseableDirectory(directory: String, renderer: DirectoryRenderer, resolver: ContentTypeResolver): Route
Same as getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with 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()
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 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 of None is extracted.
Definition Classes
CookieDirectives
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-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.
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-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.
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: 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.
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

Inherited from FileUploadDirectives

Value Members

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.
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.
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 Source for streaming the file contents somewhere.
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.
Definition Classes
FileUploadDirectives
Annotations
@ApiMayChange()
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()

Inherited from FileAndResourceDirectives

Value Members

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 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 getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with only one directory.
Definition Classes
FileAndResourceDirectives
def getFromBrowseableDirectory(directory: String, resolver: ContentTypeResolver): Route
Same as getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with only one directory.
Definition Classes
FileAndResourceDirectives
def getFromBrowseableDirectory(directory: String, renderer: DirectoryRenderer): Route
Same as getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with only one directory.
Definition Classes
FileAndResourceDirectives
def getFromBrowseableDirectory(directory: String, renderer: DirectoryRenderer, resolver: ContentTypeResolver): Route
Same as getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with 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 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()

Inherited from ExecutionDirectives

Value Members

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

Inherited from DebuggingDirectives

Value Members

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

Inherited from CookieDirectives

Value Members

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 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 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 of None is extracted.
Definition Classes
CookieDirectives
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

Inherited from CodingDirectives

Value Members

def decodeRequest(inner: Supplier[Route]): Route
Decompresses the incoming request if it is gzip or deflate compressed.
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.
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 encodeResponse(inner: Supplier[Route]): Route
Encodes the response with the encoding that is requested by the client via the Accept- Encoding header.
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.
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- Encoding header.
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.
Definition Classes
CodingDirectives
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 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.
Definition Classes
CodingDirectives

Inherited from CacheConditionDirectives

Value Members

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.
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 the withRangeSupport(...) 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 the withRangeSupport(...) 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 the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.
Definition Classes
CacheConditionDirectives

Inherited from BasicDirectives

Value Members

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 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 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.
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-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.
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-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.
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 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
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 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.
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-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.
timeout
The directive is failed if the stream isn't completed after the given timeout.
Definition Classes
BasicDirectives
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 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

Inherited from AnyRef

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
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()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
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()

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0
Definition Classes
Any
final def isInstanceOf[T0]: Boolean
Definition Classes
Any

Inherited by implicit conversion any2stringadd fromFormFieldDirectives to any2stringadd[FormFieldDirectives]

Value Members

def +(other: String): String
Implicit
This member is added by an implicit conversion from FormFieldDirectives toany2stringadd[FormFieldDirectives] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd

Inherited by implicit conversion StringFormat fromFormFieldDirectives to StringFormat[FormFieldDirectives]

Value Members

def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from FormFieldDirectives toStringFormat[FormFieldDirectives] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@deprecated @inline()
Deprecated
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

Inherited by implicit conversion Ensuring fromFormFieldDirectives to Ensuring[FormFieldDirectives]

Value Members

def ensuring(cond: (FormFieldDirectives) => Boolean, msg: => Any): FormFieldDirectives
Implicit
This member is added by an implicit conversion from FormFieldDirectives toEnsuring[FormFieldDirectives] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (FormFieldDirectives) => Boolean): FormFieldDirectives
Implicit
This member is added by an implicit conversion from FormFieldDirectives toEnsuring[FormFieldDirectives] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): FormFieldDirectives
Implicit
This member is added by an implicit conversion from FormFieldDirectives toEnsuring[FormFieldDirectives] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): FormFieldDirectives
Implicit
This member is added by an implicit conversion from FormFieldDirectives toEnsuring[FormFieldDirectives] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

Inherited by implicit conversion ArrowAssoc fromFormFieldDirectives to ArrowAssoc[FormFieldDirectives]

Value Members

def ->[B](y: B): (FormFieldDirectives, B)
Implicit
This member is added by an implicit conversion from FormFieldDirectives toArrowAssoc[FormFieldDirectives] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
def →[B](y: B): (FormFieldDirectives, B)
Implicit
This member is added by an implicit conversion from FormFieldDirectives toArrowAssoc[FormFieldDirectives] 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.

Ungrouped

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 FormFieldDirectives toany2stringadd[FormFieldDirectives] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (FormFieldDirectives, B)
Implicit
This member is added by an implicit conversion from FormFieldDirectives toArrowAssoc[FormFieldDirectives] 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 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 clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
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.
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 the withRangeSupport(...) 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 the withRangeSupport(...) 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 the withRangeSupport(...) 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 gzip or deflate compressed.
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.
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- Encoding header.
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.
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- Encoding header.
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.
Definition Classes
CodingDirectives
def ensuring(cond: (FormFieldDirectives) => Boolean, msg: => Any): FormFieldDirectives
Implicit
This member is added by an implicit conversion from FormFieldDirectives toEnsuring[FormFieldDirectives] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (FormFieldDirectives) => Boolean): FormFieldDirectives
Implicit
This member is added by an implicit conversion from FormFieldDirectives toEnsuring[FormFieldDirectives] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): FormFieldDirectives
Implicit
This member is added by an implicit conversion from FormFieldDirectives toEnsuring[FormFieldDirectives] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): FormFieldDirectives
Implicit
This member is added by an implicit conversion from FormFieldDirectives toEnsuring[FormFieldDirectives] 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 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.
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-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.
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-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.
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 Source for streaming the file contents somewhere.
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.
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 Source for streaming the file contents somewhere.
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.
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
def formField(name: String, inner: Function[String, Route]): Route
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>>.
Annotations
@CorrespondsTo()
def formFieldList[T](t: Unmarshaller[String, T], name: String, inner: Function[List[T], Route]): Route
Annotations
@CorrespondsTo()
def formFieldList(name: String, inner: Function[List[String], Route]): Route
Annotations
@CorrespondsTo()
def formFieldMap(inner: Function[Map[String, String], Route]): Route
Extracts HTTP form fields from the request as a Map<String, String>.
def formFieldMultiMap(inner: Function[Map[String, List[String]], Route]): Route
Extracts HTTP form fields from the request as a Map<String, List<String>>.
def formFieldOptional[T](t: Unmarshaller[String, T], name: String, inner: Function[Optional[T], Route]): Route
Annotations
@CorrespondsTo()
def formFieldOptional(name: String, inner: Function[Optional[String], Route]): Route
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 getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with only one directory.
Definition Classes
FileAndResourceDirectives
def getFromBrowseableDirectory(directory: String, resolver: ContentTypeResolver): Route
Same as getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with only one directory.
Definition Classes
FileAndResourceDirectives
def getFromBrowseableDirectory(directory: String, renderer: DirectoryRenderer): Route
Same as getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with only one directory.
Definition Classes
FileAndResourceDirectives
def getFromBrowseableDirectory(directory: String, renderer: DirectoryRenderer, resolver: ContentTypeResolver): Route
Same as getFromBrowseableDirectories with only one directory.
Same as getFromBrowseableDirectories with 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()
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 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 of None is extracted.
Definition Classes
CookieDirectives
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-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.
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-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.
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: 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.
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
def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from FormFieldDirectives toStringFormat[FormFieldDirectives] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@deprecated @inline()
Deprecated
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
def →[B](y: B): (FormFieldDirectives, B)
Implicit
This member is added by an implicit conversion from FormFieldDirectives toArrowAssoc[FormFieldDirectives] 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.

Packages

FormFieldDirectives

abstract class FormFieldDirectives extends FileUploadDirectives

Instance Constructors

Value Members

Deprecated Value Members

Inherited from FileUploadDirectives

Value Members

Inherited from FileAndResourceDirectives

Value Members

Inherited from ExecutionDirectives

Value Members

Inherited from DebuggingDirectives

Value Members

Inherited from CookieDirectives

Value Members

Inherited from CodingDirectives

Value Members

Inherited from CacheConditionDirectives

Value Members

Inherited from BasicDirectives

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Inherited by implicit conversion any2stringadd fromFormFieldDirectives to any2stringadd[FormFieldDirectives]

Value Members

Inherited by implicit conversion StringFormat fromFormFieldDirectives to StringFormat[FormFieldDirectives]

Value Members

Inherited by implicit conversion Ensuring fromFormFieldDirectives to Ensuring[FormFieldDirectives]

Value Members

Inherited by implicit conversion ArrowAssoc fromFormFieldDirectives to ArrowAssoc[FormFieldDirectives]

Value Members

Ungrouped

Packages

FormFieldDirectives

abstract class FormFieldDirectives extends FileUploadDirectives

Instance Constructors

Value Members

Deprecated Value Members

Inherited from FileUploadDirectives

Value Members

Inherited from FileAndResourceDirectives

Value Members

Inherited from ExecutionDirectives

Value Members

Inherited from DebuggingDirectives

Value Members

Inherited from CookieDirectives

Value Members

Inherited from CodingDirectives

Value Members

Inherited from CacheConditionDirectives

Value Members

Inherited from BasicDirectives

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Inherited by implicit conversion any2stringadd fromFormFieldDirectives to any2stringadd[FormFieldDirectives]

Value Members

Inherited by implicit conversion StringFormat fromFormFieldDirectives to StringFormat[FormFieldDirectives]

Value Members

Inherited by implicit conversion Ensuring fromFormFieldDirectives to Ensuring[FormFieldDirectives]

Value Members

Inherited by implicit conversion ArrowAssoc fromFormFieldDirectives to ArrowAssoc[FormFieldDirectives]

Value Members

Ungrouped

FormFieldDirectives