abstract class HttpRequest extends HttpMessage with MessageTransformations[HttpRequest]
- Alphabetic
- By Inheritance
- HttpRequest
- MessageTransformations
- HttpMessage
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new HttpRequest()
Abstract Value Members
-
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
-
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
-
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
-
abstract
def
discardEntityBytes(materializer: Materializer): DiscardedEntity
Discards the entities data bytes by running the
dataBytes
Source contained by theentity
of this HTTP message.Discards the entities data bytes by running the
dataBytes
Source contained by theentity
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
-
abstract
def
entity(): RequestEntity
Returns the entity of this request.
Returns the entity of this request.
- Definition Classes
- HttpRequest → HttpMessage
-
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
-
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
-
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
-
abstract
def
getHeaders(): Iterable[HttpHeader]
An iterable containing the headers of this message.
An iterable containing the headers of this message.
- Definition Classes
- HttpMessage
-
abstract
def
getUri(): Uri
Returns the Uri of this request.
-
abstract
def
isRequest(): Boolean
Is this instance a request.
Is this instance a request.
- Definition Classes
- HttpMessage
-
abstract
def
isResponse(): Boolean
Is this instance a response.
Is this instance a response.
- Definition Classes
- HttpMessage
-
abstract
def
method(): HttpMethod
Returns the Http method of this request.
-
abstract
def
protocol(): HttpProtocol
The protocol of this message.
The protocol of this message.
- Definition Classes
- HttpMessage
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
abstract
def
withMethod(method: HttpMethod): HttpRequest
Returns a copy of this instance with a new method.
-
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
-
abstract
def
withUri(path: String): HttpRequest
Returns a copy of this instance with a new Uri.
-
abstract
def
withUri(relativeUri: Uri): HttpRequest
Returns a copy of this instance with a new Uri.
Concrete 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 HttpRequest to any2stringadd[HttpRequest] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (HttpRequest, B)
- Implicit
- This member is added by an implicit conversion from HttpRequest to ArrowAssoc[HttpRequest] 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
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
ensuring(cond: (HttpRequest) ⇒ Boolean, msg: ⇒ Any): HttpRequest
- Implicit
- This member is added by an implicit conversion from HttpRequest to Ensuring[HttpRequest] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (HttpRequest) ⇒ Boolean): HttpRequest
- Implicit
- This member is added by an implicit conversion from HttpRequest to Ensuring[HttpRequest] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): HttpRequest
- Implicit
- This member is added by an implicit conversion from HttpRequest to Ensuring[HttpRequest] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): HttpRequest
- Implicit
- This member is added by an implicit conversion from HttpRequest to Ensuring[HttpRequest] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from HttpRequest to StringFormat[HttpRequest] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
→[B](y: B): (HttpRequest, B)
- Implicit
- This member is added by an implicit conversion from HttpRequest to ArrowAssoc[HttpRequest] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc