final class HttpRequest extends javadsl.model.HttpRequest with HttpMessage

The immutable model HTTP request model.

Source
HttpMessage.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpRequest
  2. HttpMessage
  3. HttpRequest
  4. MessageTransformations
  5. HttpMessage
  6. AnyRef
  7. Any
Implicitly
  1. by HttpMessageScalaDSLSugar
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HttpRequest(method: HttpMethod, uri: Uri, headers: Seq[HttpHeader], entity: RequestEntity, protocol: HttpProtocol)

Type Members

  1. type Self = HttpRequest
    Definition Classes
    HttpRequestHttpMessage

Value Members

  1. def _1: HttpMethod
  2. def _2: Uri
  3. def _3: Seq[HttpHeader]
  4. def _4: RequestEntity
  5. def _5: HttpProtocol
  6. def addCredentials(credentials: HttpCredentials): Self
    Definition Classes
    HttpMessage
  7. def addHeader(header: javadsl.model.HttpHeader): Self
    Definition Classes
    HttpMessage
  8. def addHeaders(headers: Iterable[javadsl.model.HttpHeader]): Self

    Java API

    Java API

    Definition Classes
    HttpMessage
  9. def canBeRetried: Boolean

    Determines whether this request can be safely retried, which is the case only of the request method is idempotent.

  10. def connectionCloseExpected: Boolean

    Returns true if this message is an:

    Returns true if this message is an:

    • HttpRequest and the client does not want to reuse the connection after the response for this request has been received
    • HttpResponse and the server will close the connection after this response
    Definition Classes
    HttpMessage
  11. def cookies: Seq[HttpCookiePair]

    All cookies provided by the client in one or more Cookie headers.

  12. def copy(method: HttpMethod = method, uri: Uri = uri, headers: Seq[HttpHeader] = headers, entity: RequestEntity = entity, protocol: HttpProtocol = protocol): HttpRequest
  13. def discardEntityBytes(mat: Materializer): DiscardedEntity

    Discards the entities data bytes by running the dataBytes Source contained in this HttpMessage.

    Discards the entities data bytes by running the dataBytes Source contained in this HttpMessage.

    Note: It is crucial that entities are either discarded, or consumed by running the underlying akka.stream.scaladsl.Source as otherwise the lack of consuming of the data will trigger back-pressure to the underlying TCP connection (as designed), however possibly leading to an idle-timeout that will close the connection, instead of just having ignored the data.

    Warning: It is not allowed to discard and/or consume the entity.dataBytes more than once as the stream is directly attached to the "live" incoming data source from the underlying TCP connection. Allowing it to be consumable twice would require buffering the incoming data, thus defeating the purpose of its streaming nature. If the dataBytes source is materialized a second time, it will fail with an "stream can cannot be materialized more than once" exception.

    When called on Strict entities or sources whose values can be buffered in memory, the above warnings can be ignored. Repeated materialization is not necessary in this case, avoiding the mentioned exceptions due to the data being held in memory.

    In future versions, more automatic ways to warn or resolve these situations may be introduced, see issue #18716.

    Definition Classes
    HttpMessageHttpMessage
  14. def effectiveUri(securedConnection: Boolean, defaultHostHeader: Host = Host.empty): Uri

    Resolve this request's URI according to the logic defined at http://tools.ietf.org/html/rfc7230#section-5.5

    Resolve this request's URI according to the logic defined at http://tools.ietf.org/html/rfc7230#section-5.5

    Throws an IllegalUriException if the URI is relative and the headers don't include a valid akka.http.scaladsl.model.headers.Host header or if URI authority and akka.http.scaladsl.model.headers.Host header don't match.

  15. def encoding: HttpEncoding

    The content encoding as specified by the Content-Encoding header.

    The content encoding as specified by the Content-Encoding header. If no Content-Encoding header is present the default value 'identity' is returned.

    Definition Classes
    HttpMessage
  16. val entity: RequestEntity

    The entity of this message.

    The entity of this message.

    Definition Classes
    HttpRequestHttpMessageHttpRequestHttpMessage
  17. def equals(obj: Any): Boolean
    Definition Classes
    HttpRequest → AnyRef → Any
  18. def getHeader(headerName: String): Optional[javadsl.model.HttpHeader]

    Java API

    Java API

    Definition Classes
    HttpMessageHttpMessage
  19. def getHeader[T <: javadsl.model.HttpHeader](headerClass: Class[T]): Optional[T]

    Java API

    Java API

    Definition Classes
    HttpMessageHttpMessage
  20. def getHeaders[T <: javadsl.model.HttpHeader](headerClass: Class[T]): Iterable[T]

    Java API

    Java API

    Definition Classes
    HttpMessageHttpMessage
  21. def getHeaders(): Iterable[javadsl.model.HttpHeader]

    Java API

    Java API

    Definition Classes
    HttpMessageHttpMessage
  22. def getUri(): javadsl.model.Uri

    Java API

    Java API

    Definition Classes
    HttpRequestHttpRequest
  23. def hashCode(): Int
    Definition Classes
    HttpRequest → AnyRef → Any
  24. def header[T >: Null <: javadsl.model.HttpHeader](implicit arg0: ClassTag[T]): Option[T]

    Returns the first header of the given type if there is one

    Returns the first header of the given type if there is one

    Definition Classes
    HttpMessage
  25. def headers[T <: javadsl.model.HttpHeader](implicit arg0: ClassTag[T]): Seq[T]

    Returns all the headers of the given type *

    Returns all the headers of the given type *

    Definition Classes
    HttpMessage
  26. val headers: Seq[HttpHeader]
    Definition Classes
    HttpRequestHttpMessage
  27. val httpMessage: HttpMessage
    Implicit
    This member is added by an implicit conversion from HttpRequest to HttpMessageScalaDSLSugar performed by method HttpMessageScalaDSLSugar in akka.http.scaladsl.model.HttpMessage.
    Definition Classes
    HttpMessageScalaDSLSugar
  28. def isRequest(): Boolean

    Is this instance a request.

    Is this instance a request.

    Definition Classes
    HttpRequestHttpMessageHttpMessage
  29. def isResponse(): Boolean

    Is this instance a response.

    Is this instance a response.

    Definition Classes
    HttpRequestHttpMessageHttpMessage
  30. def mapEntity(f: (RequestEntity) ⇒ RequestEntity): HttpRequest
  31. def mapHeaders(f: (Seq[HttpHeader]) ⇒ Seq[HttpHeader]): Self

    Returns a copy of this message with the list of headers transformed by the given function

    Returns a copy of this message with the list of headers transformed by the given function

    Definition Classes
    HttpMessage
  32. val method: HttpMethod

    Returns the Http method of this request.

    Returns the Http method of this request.

    Definition Classes
    HttpRequestHttpRequest
  33. val protocol: HttpProtocol

    The protocol of this message.

    The protocol of this message.

    Definition Classes
    HttpRequestHttpMessageHttpMessage
  34. def removeHeader(headerName: String): Self

    Removes the header with the given name (case-insensitive)

    Removes the header with the given name (case-insensitive)

    Definition Classes
    HttpMessage
  35. def self: HttpRequest
    Definition Classes
    HttpRequestHttpMessage
  36. def toStrict(timeoutMillis: Long, maxBytes: Long, ec: Executor, materializer: Materializer): CompletionStage[Self]

    Java API

    Java API

    Definition Classes
    HttpMessage
  37. def toStrict(timeoutMillis: Long, ec: Executor, materializer: Materializer): CompletionStage[Self]

    Java API

    Java API

    Definition Classes
    HttpMessage
  38. def toStrict(timeout: FiniteDuration, maxBytes: Long)(implicit ec: ExecutionContext, fm: Materializer): Future[Self]

    Returns a shareable and serializable copy of this message with a strict entity.

    Returns a shareable and serializable copy of this message with a strict entity.

    Definition Classes
    HttpMessage
  39. def toStrict(timeout: FiniteDuration)(implicit ec: ExecutionContext, fm: Materializer): Future[Self]

    Returns a shareable and serializable copy of this message with a strict entity.

    Returns a shareable and serializable copy of this message with a strict entity.

    Definition Classes
    HttpMessage
  40. def toString(): String
    Definition Classes
    HttpRequest → AnyRef → Any
  41. def transformEntityDataBytes[M](transformer: Graph[FlowShape[ByteString, ByteString], M]): HttpRequest

    Returns a copy of Self message after applying the given transformation

    Returns a copy of Self message after applying the given transformation

    Definition Classes
    HttpRequestHttpMessage → MessageTransformations
  42. val uri: Uri
  43. def withDefaultHeaders(defaultHeaders: HttpHeader*): Self
    Definition Classes
    HttpMessage
  44. def withDefaultHeaders(defaultHeaders: Seq[HttpHeader]): Self

    Returns a new message that contains all of the given default headers which didn't already exist (by case-insensitive header name) in this message.

    Returns a new message that contains all of the given default headers which didn't already exist (by case-insensitive header name) in this message.

    Definition Classes
    HttpMessage
  45. def withEffectiveUri(securedConnection: Boolean, defaultHostHeader: Host = Host.empty): HttpRequest

    Returns a copy of this request with the URI resolved according to the logic defined at http://tools.ietf.org/html/rfc7230#section-5.5

  46. def withEntity(entity: MessageEntity): HttpRequest

    Returns a copy of this message with the entity set to the given one.

    Returns a copy of this message with the entity set to the given one.

    Definition Classes
    HttpRequestHttpMessage
  47. def withEntity(entity: javadsl.model.RequestEntity): HttpRequest

    Returns a copy of this instance with a new entity.

    Returns a copy of this instance with a new entity.

    Definition Classes
    HttpRequestHttpRequest → MessageTransformations
  48. def withEntity(contentType: javadsl.model.ContentType, file: Path): Self
    Definition Classes
    HttpMessage
  49. def withEntity(contentType: javadsl.model.ContentType, file: File): Self
    Definition Classes
    HttpMessage
  50. def withEntity(contentType: javadsl.model.ContentType, bytes: ByteString): Self
    Definition Classes
    HttpMessage
  51. def withEntity(contentType: javadsl.model.ContentType, bytes: Array[Byte]): Self
    Definition Classes
    HttpMessage
  52. def withEntity(contentType: NonBinary, string: String): Self
    Definition Classes
    HttpMessage
  53. def withEntity(bytes: ByteString): Self
    Definition Classes
    HttpMessage
  54. def withEntity(bytes: Array[Byte]): Self
    Definition Classes
    HttpMessage
  55. def withEntity(string: String): Self
    Definition Classes
    HttpMessage
  56. def withHeaders(headers: Seq[HttpHeader]): HttpRequest

    Returns a copy of this message with the list of headers set to the given ones.

    Returns a copy of this message with the list of headers set to the given ones.

    Definition Classes
    HttpRequestHttpMessage
  57. def withHeaders(headers: HttpHeader*): Self
    Definition Classes
    HttpMessage
  58. def withHeaders(headers: Iterable[javadsl.model.HttpHeader]): Self

    Java API

    Java API

    Definition Classes
    HttpMessage
  59. def withHeadersAndEntity(headers: Seq[HttpHeader], entity: RequestEntity): HttpRequest

    Returns a copy of this message with the entity and headers set to the given ones.

    Returns a copy of this message with the entity and headers set to the given ones.

    Definition Classes
    HttpRequestHttpMessage
  60. def withMethod(method: javadsl.model.HttpMethod): HttpRequest

    Returns a copy of this instance with a new method.

    Returns a copy of this instance with a new method.

    Definition Classes
    HttpRequestHttpRequest
  61. def withProtocol(protocol: javadsl.model.HttpProtocol): HttpRequest

    Returns a copy of this message with a new protocol.

    Returns a copy of this message with a new protocol.

    Definition Classes
    HttpRequest → MessageTransformations
  62. def withUri(uri: javadsl.model.Uri): HttpRequest

    Java API

    Java API

    Definition Classes
    HttpRequestHttpRequest
  63. def withUri(uri: Uri): HttpRequest
  64. def withUri(path: String): HttpRequest

    Returns a copy of this instance with a new Uri.

    Returns a copy of this instance with a new Uri.

    Definition Classes
    HttpRequestHttpRequest

Shadowed Implicit Value Members

  1. def discardEntityBytes()(implicit mat: Materializer): DiscardedEntity

    Discards the entities data bytes by running the dataBytes Source contained by the entity of this HTTP message.

    Discards the entities data bytes by running the dataBytes Source contained by the entity of this HTTP message.

    Note: It is crucial that entities are either discarded, or consumed by running the underlying akka.stream.scaladsl.Source as otherwise the lack of consuming of the data will trigger back-pressure to the underlying TCP connection (as designed), however possibly leading to an idle-timeout that will close the connection, instead of just having ignored the data.

    Warning: It is not allowed to discard and/or consume the entity.dataBytes more than once as the stream is directly attached to the "live" incoming data source from the underlying TCP connection. Allowing it to be consumable twice would require buffering the incoming data, thus defeating the purpose of its streaming nature. If the dataBytes source is materialized a second time, it will fail with an "stream can cannot be materialized more than once" exception.

    When called on Strict entities or sources whose values can be buffered in memory, the above warnings can be ignored. Repeated materialization is not necessary in this case, avoiding the mentioned exceptions due to the data being held in memory.

    In future versions, more automatic ways to warn or resolve these situations may be introduced, see issue #18716.

    Implicit
    This member is added by an implicit conversion from HttpRequest to HttpMessageScalaDSLSugar performed by method HttpMessageScalaDSLSugar in akka.http.scaladsl.model.HttpMessage.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (httpRequest: HttpMessageScalaDSLSugar).discardEntityBytes()(mat)
    Definition Classes
    HttpMessageScalaDSLSugar