public interface MiscDirectives
Modifier and Type | Method and Description |
---|---|
Directive<scala.Tuple1<RemoteAddress>> |
extractClientIP()
Extracts the client's IP from either the X-Forwarded-For, Remote-Address, X-Real-IP header
or
pekko.http.scaladsl.model.AttributeKeys.remoteAddress attribute
(in that order of priority). |
Directive<scala.runtime.BoxedUnit> |
rejectEmptyResponse()
Converts responses with an empty entity into (empty) rejections.
|
Directive<scala.runtime.BoxedUnit> |
requestEntityEmpty()
Rejects if the request entity is non-empty.
|
Directive<scala.runtime.BoxedUnit> |
requestEntityPresent()
Rejects with a
RequestEntityExpectedRejection if the request entity is empty. |
Directive<scala.Tuple1<Language>> |
selectPreferredLanguage(Language first,
scala.collection.immutable.Seq<Language> more)
Inspects the request's
Accept-Language header and determines,
which of the given language alternatives is preferred by the client. |
Directive<scala.runtime.BoxedUnit> |
validate(scala.Function0<java.lang.Object> check,
java.lang.String errorMsg)
Checks the given condition before running its inner route.
|
Directive<scala.runtime.BoxedUnit> |
withoutSizeLimit()
Disables the size limit (configured by
pekko.http.parsing.max-content-length by default) checking on the incoming
HttpRequest entity. |
Directive<scala.runtime.BoxedUnit> |
withSizeLimit(long maxBytes)
Fails the stream with
pekko.http.scaladsl.model.EntityStreamSizeException if its request entity size exceeds
given limit. |
Directive<scala.runtime.BoxedUnit> validate(scala.Function0<java.lang.Object> check, java.lang.String errorMsg)
ValidationRejection
.
check
- (undocumented)errorMsg
- (undocumented)Directive<scala.Tuple1<RemoteAddress>> extractClientIP()
pekko.http.scaladsl.model.AttributeKeys.remoteAddress
attribute
(in that order of priority).
Directive<scala.runtime.BoxedUnit> requestEntityEmpty()
Directive<scala.runtime.BoxedUnit> requestEntityPresent()
RequestEntityExpectedRejection
if the request entity is empty.
Non-empty requests are passed on unchanged to the inner route.
Directive<scala.runtime.BoxedUnit> rejectEmptyResponse()
Directive<scala.Tuple1<Language>> selectPreferredLanguage(Language first, scala.collection.immutable.Seq<Language> more)
Accept-Language
header and determines,
which of the given language alternatives is preferred by the client.
(See http://tools.ietf.org/html/rfc7231#section-5.3.5 for more details on the
negotiation logic.)
If there are several best language alternatives that the client
has equal preference for (even if this preference is zero!)
the order of the arguments is used as a tie breaker (First one wins).
first
- (undocumented)more
- (undocumented)Directive<scala.runtime.BoxedUnit> withSizeLimit(long maxBytes)
pekko.http.scaladsl.model.EntityStreamSizeException
if its request entity size exceeds
given limit. Limit given as parameter overrides limit configured with pekko.http.parsing.max-content-length
.
Beware that request entity size check is executed when entity is consumed.
maxBytes
- (undocumented)Directive<scala.runtime.BoxedUnit> withoutSizeLimit()
pekko.http.parsing.max-content-length
by default) checking on the incoming
HttpRequest
entity.
Can be useful when handling arbitrarily large data uploads in specific parts of your routes.