c

akka.http.javadsl.model

HttpRequest

abstract class HttpRequest extends HttpMessage with MessageTransformations[HttpRequest]

Represents an Http request.

Source
HttpRequest.java
Linear Supertypes
MessageTransformations[HttpRequest], HttpMessage, AnyRef, Any
Known Subclasses
HttpRequest
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpRequest
  2. MessageTransformations
  3. HttpMessage
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HttpRequest()

Abstract Value Members

  1. abstract def addCredentials(credentials: HttpCredentials): HttpRequest

    Returns a copy of this message with the given http credential header added to the list of headers.

    Returns a copy of this message with the given http credential header added to the list of headers.

    Definition Classes
    MessageTransformations
  2. abstract def addHeader(header: HttpHeader): HttpRequest

    Returns a copy of this message with the given header added to the list of headers.

    Returns a copy of this message with the given header added to the list of headers.

    Definition Classes
    MessageTransformations
  3. abstract def addHeaders(headers: Iterable[HttpHeader]): HttpRequest

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

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

    Definition Classes
    MessageTransformations
  4. abstract def discardEntityBytes(materializer: 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.javadsl.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
    HttpMessage
  5. abstract def entity(): RequestEntity

    Returns the entity of this request.

    Returns the entity of this request.

    Definition Classes
    HttpRequest → HttpMessage
  6. abstract def getHeader[T <: HttpHeader](headerClass: Class[T]): Optional[T]

    Try to find the first header of the given class and return Optional.of(header), otherwise this method returns an empty Optional.

    Try to find the first header of the given class and return Optional.of(header), otherwise this method returns an empty Optional.

    Definition Classes
    HttpMessage
  7. abstract def getHeader(headerName: String): Optional[HttpHeader]

    Try to find the first header with the given name (case-insensitive) and return Optional.of(header), otherwise this method returns an empty Optional.

    Try to find the first header with the given name (case-insensitive) and return Optional.of(header), otherwise this method returns an empty Optional.

    Definition Classes
    HttpMessage
  8. abstract def getHeaders[T <: HttpHeader](headerClass: Class[T]): Iterable[T]

    An iterable containing all headers of the given class of this message.

    An iterable containing all headers of the given class of this message.

    Definition Classes
    HttpMessage
  9. abstract def getHeaders(): Iterable[HttpHeader]

    An iterable containing the headers of this message.

    An iterable containing the headers of this message.

    Definition Classes
    HttpMessage
  10. abstract def getUri(): Uri

    Returns the Uri of this request.

  11. abstract def isRequest(): Boolean

    Is this instance a request.

    Is this instance a request.

    Definition Classes
    HttpMessage
  12. abstract def isResponse(): Boolean

    Is this instance a response.

    Is this instance a response.

    Definition Classes
    HttpMessage
  13. abstract def method(): HttpMethod

    Returns the Http method of this request.

  14. abstract def protocol(): HttpProtocol

    The protocol of this message.

    The protocol of this message.

    Definition Classes
    HttpMessage
  15. abstract def removeHeader(headerName: String): HttpRequest

    Returns a copy of this message with all headers of the given name (case-insensitively) removed.

    Returns a copy of this message with all headers of the given name (case-insensitively) removed.

    Definition Classes
    MessageTransformations
  16. abstract def toStrict(timeoutMillis: Long, maxBytes: Long, ec: Executor, materializer: Materializer): CompletionStage[_ <: HttpRequest]

    Returns a CompletionStage of Self message with strict entity that contains the same data as this entity which is only completed when the complete entity has been collected.

    Returns a CompletionStage of Self message with strict entity that contains the same data as this entity which is only completed when the complete entity has been collected. As the duration of receiving the complete entity cannot be predicted, a timeout needs to be specified to guard the process against running and keeping resources infinitely.

    Use getEntity().getDataBytes and stream processing instead if the expected data is big or is likely to take a long time.

    Definition Classes
    MessageTransformations
  17. abstract def toStrict(timeoutMillis: Long, ec: Executor, materializer: Materializer): CompletionStage[_ <: HttpRequest]

    Returns a CompletionStage of Self message with strict entity that contains the same data as this entity which is only completed when the complete entity has been collected.

    Returns a CompletionStage of Self message with strict entity that contains the same data as this entity which is only completed when the complete entity has been collected. As the duration of receiving the complete entity cannot be predicted, a timeout needs to be specified to guard the process against running and keeping resources infinitely.

    Use getEntity().getDataBytes and stream processing instead if the expected data is big or is likely to take a long time.

    Definition Classes
    MessageTransformations
  18. abstract def transformEntityDataBytes[T](transformer: Graph[FlowShape[ByteString, ByteString], T]): 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
    MessageTransformations
  19. abstract def withEntity(entity: RequestEntity): HttpRequest

    Returns a copy of this instance with a new entity.

    Returns a copy of this instance with a new entity.

    Definition Classes
    HttpRequest → MessageTransformations
  20. abstract def withEntity(type: ContentType, file: Path): HttpRequest

    Returns a copy of Self message with a new entity.

    Returns a copy of Self message with a new entity.

    Definition Classes
    MessageTransformations
  21. abstract def withEntity(type: ContentType, file: File): HttpRequest

    Returns a copy of Self message with a new entity.

    Returns a copy of Self message with a new entity.

    Definition Classes
    MessageTransformations
  22. abstract def withEntity(type: ContentType, bytes: ByteString): HttpRequest

    Returns a copy of Self message with a new entity.

    Returns a copy of Self message with a new entity.

    Definition Classes
    MessageTransformations
  23. abstract def withEntity(type: ContentType, bytes: Array[Byte]): HttpRequest

    Returns a copy of Self message with a new entity.

    Returns a copy of Self message with a new entity.

    Definition Classes
    MessageTransformations
  24. abstract def withEntity(type: NonBinary, string: String): HttpRequest

    Returns a copy of Self message with a new entity.

    Returns a copy of Self message with a new entity.

    Definition Classes
    MessageTransformations
  25. abstract def withEntity(bytes: ByteString): HttpRequest

    Returns a copy of Self message with a new entity.

    Returns a copy of Self message with a new entity.

    Definition Classes
    MessageTransformations
  26. abstract def withEntity(bytes: Array[Byte]): HttpRequest

    Returns a copy of Self message with a new entity.

    Returns a copy of Self message with a new entity.

    Definition Classes
    MessageTransformations
  27. abstract def withEntity(string: String): HttpRequest

    Returns a copy of this message with a new entity.

    Returns a copy of this message with a new entity.

    Definition Classes
    MessageTransformations
  28. abstract def withHeaders(headers: Iterable[HttpHeader]): HttpRequest

    Returns a copy of this message with new headers.

    Returns a copy of this message with new headers.

    Definition Classes
    MessageTransformations
  29. abstract def withMethod(method: HttpMethod): HttpRequest

    Returns a copy of this instance with a new method.

  30. abstract def withProtocol(protocol: HttpProtocol): HttpRequest

    Returns a copy of this message with a new protocol.

    Returns a copy of this message with a new protocol.

    Definition Classes
    MessageTransformations
  31. abstract def withUri(path: String): HttpRequest

    Returns a copy of this instance with a new Uri.

  32. abstract def withUri(relativeUri: Uri): HttpRequest

    Returns a copy of this instance with a new Uri.