HttpClient

Instance Constructors

new HttpClient()

Abstract Value Members

abstract def close(): Unit

Definition Classes
HttpClient → Closeable → AutoCloseable
abstract def defaultCharset: Charset
abstract def defaultHeaders: Headers
abstract def defaultMaxLength: Long
abstract def defaultResponseTimeout: Duration
abstract def execute(r: Request, timeout: Duration): Future[AsyncResponse]

Execute a Request returning the AsyncResponse
implicit abstract def executionContext: ExecutionContext

If you make use of this then you cannot perform any blocking operations on it (especially any Await.result or Await.ready operations) otherwise you will risk a deadlock.

Concrete 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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def execute(r: Request): Future[AsyncResponse]

Execute a Request returning the AsyncResponse using the defaultResponseTimeout
final def getAsync(url: String, headers: Headers, timeout: Duration): Future[AsyncResponse]

Perform a GET request returning an AsyncResponse for reading arbitrarily long response bodies
final def getAsync(url: String, timeout: Duration): Future[AsyncResponse]

Perform a GET request returning an AsyncResponse for reading arbitrarily long response bodies
final def getAsync(url: String, headers: Headers): Future[AsyncResponse]

Perform a GET request returning an AsyncResponse for reading arbitrarily long response bodies
final def getAsync(url: String): Future[AsyncResponse]

Perform a GET request returning an AsyncResponse for reading arbitrarily long response bodies
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def getFull(url: String, headers: Headers, maxLength: Long, timeout: Duration): Future[FullResponse]

Perform a GET request returning the FullResponse
final def getFull(url: String, maxLength: Long, timeout: Duration): Future[FullResponse]

Perform a GET request returning the FullResponse
final def getFull(url: String, headers: Headers, timeout: Duration): Future[FullResponse]

Perform a GET request returning the FullResponse
final def getFull(url: String, headers: Headers, maxLength: Long): Future[FullResponse]

Perform a GET request returning the FullResponse
final def getFull(url: String, timeout: Duration): Future[FullResponse]

Perform a GET request returning the FullResponse
final def getFull(url: String, maxLength: Long): Future[FullResponse]

Perform a GET request returning the FullResponse
final def getFull(url: String, headers: Headers): Future[FullResponse]

Perform a GET request returning the FullResponse
final def getFull(url: String): Future[FullResponse]

Perform a GET request returning the FullResponse
final def getFullString(url: String, headers: Headers, maxLength: Long, timeout: Duration, defaultCharset: Charset): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String, maxLength: Long, timeout: Duration, defaultCharset: Charset): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String, headers: Headers, timeout: Duration, defaultCharset: Charset): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String, headers: Headers, maxLength: Long, defaultCharset: Charset): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String, headers: Headers, maxLength: Long, timeout: Duration): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String, timeout: Duration, defaultCharset: Charset): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String, maxLength: Long, defaultCharset: Charset): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String, maxLength: Long, timeout: Duration): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String, headers: Headers, defaultCharset: Charset): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String, headers: Headers, timeout: Duration): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String, headers: Headers, maxLength: Long): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String, defaultCharset: Charset): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String, timeout: Duration): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String, maxLength: Long): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String, headers: Headers): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
final def getFullString(url: String): Future[FullStringResponse]

Perform a GET request returning the FullStringResponse
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def head(url: String, headers: Headers, timeout: Duration): Future[FullResponse]

Perform a HEAD request.
Perform a HEAD request. Always returns a FullResponse because the body will be empty
final def head(url: String, timeout: Duration): Future[FullResponse]

Perform a HEAD request.
Perform a HEAD request. Always returns a FullResponse because the body will be empty
final def head(url: String, headers: Headers): Future[FullResponse]

Perform a HEAD request.
Perform a HEAD request. Always returns a FullResponse because the body will be empty
final def head(url: String): Future[FullResponse]

Perform a HEAD request.
Perform a HEAD request. Always returns a FullResponse because the body will be empty
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def logException(request: Request, requestBody: Option[String], ex: Throwable): Unit

A logging hook that can be used to log the Request and an Exception with no Response.
A logging hook that can be used to log the Request and an Exception with no Response.
This will be called asynchronously (but before the resulting Future is completed). This does not log direct calls to the execute() method.
def logSuccess(request: Request, requestBody: Option[String], response: Response): Unit

A logging hook that can be used to log the Request and a successful Response.
A logging hook that can be used to log the Request and a successful Response.
This will be called asynchronously (but before the resulting Future is completed). This does not log direct calls to the execute() method.
def loggingHooksEnabled: Boolean

Override this and set to true to enable the logSuccess and logException methods
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def postAsync(url: String, body: LinkedHttpContent, headers: Headers, timeout: Duration): Future[AsyncResponse]

Perform a POST request returning an AsyncResponse for reading arbitrarily long response bodies
final def postAsync(url: String, body: File, headers: Headers, timeout: Duration): Future[AsyncResponse]

Perform a POST request returning an AsyncResponse for reading arbitrarily long response bodies
final def postAsync(url: String, body: File, timeout: Duration): Future[AsyncResponse]

Perform a POST request returning an AsyncResponse for reading arbitrarily long response bodies
final def postAsync(url: String, body: File, headers: Headers): Future[AsyncResponse]

Perform a POST request returning an AsyncResponse for reading arbitrarily long response bodies
final def postAsync(url: String, body: LinkedHttpContent): Future[AsyncResponse]

Perform a POST request returning an AsyncResponse for reading arbitrarily long response bodies
final def postAsync(url: String, body: File): Future[AsyncResponse]

Perform a POST request returning an AsyncResponse for reading arbitrarily long response bodies
final def postAsync(url: String, body: String, headers: Headers, timeout: Duration): Future[AsyncResponse]

Perform a POST request returning an AsyncResponse for reading arbitrarily long response bodies
final def postAsync(url: String, body: String, timeout: Duration): Future[AsyncResponse]

Perform a POST request returning an AsyncResponse for reading arbitrarily long response bodies
final def postAsync(url: String, body: String, headers: Headers): Future[AsyncResponse]

Perform a POST request returning an AsyncResponse for reading arbitrarily long response bodies
final def postAsync(url: String, body: String): Future[AsyncResponse]

Perform a POST request returning an AsyncResponse for reading arbitrarily long response bodies
final def postAsync(url: String, body: Array[Byte], headers: Headers, timeout: Duration): Future[AsyncResponse]

Perform a POST request returning an AsyncResponse for reading arbitrarily long response bodies
final def postAsync(url: String, body: Array[Byte], timeout: Duration): Future[AsyncResponse]

Perform a POST request returning an AsyncResponse for reading arbitrarily long response bodies
final def postAsync(url: String, body: Array[Byte], headers: Headers): Future[AsyncResponse]

Perform a POST request returning an AsyncResponse for reading arbitrarily long response bodies
final def postAsync(url: String, body: Array[Byte]): Future[AsyncResponse]

Perform a POST request returning an AsyncResponse for reading arbitrarily long response bodies
final def postFull(url: String, body: String, headers: Headers, maxLength: Long, timeout: Duration): Future[FullResponse]

Perform a POST request returning the FullResponse
final def postFull(url: String, body: String, maxLength: Long, timeout: Duration): Future[FullResponse]

Perform a POST request returning the FullResponse
final def postFull(url: String, body: String, headers: Headers, timeout: Duration): Future[FullResponse]

Perform a POST request returning the FullResponse
final def postFull(url: String, body: String, headers: Headers, maxLength: Long): Future[FullResponse]

Perform a POST request returning the FullResponse
final def postFull(url: String, body: String, timeout: Duration): Future[FullResponse]

Perform a POST request returning the FullResponse
final def postFull(url: String, body: String, maxLength: Long): Future[FullResponse]

Perform a POST request returning the FullResponse
final def postFull(url: String, body: String, headers: Headers): Future[FullResponse]

Perform a POST request returning the FullResponse
final def postFull(url: String, body: String): Future[FullResponse]

Perform a POST request returning the FullResponse
final def postFullString(url: String, body: String, headers: Headers, maxLength: Long, timeout: Duration, defaultCharset: Charset): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String, maxLength: Long, timeout: Duration, defaultCharset: Charset): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String, headers: Headers, timeout: Duration, defaultCharset: Charset): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String, headers: Headers, maxLength: Long, defaultCharset: Charset): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String, headers: Headers, maxLength: Long, timeout: Duration): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String, timeout: Duration, defaultCharset: Charset): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String, maxLength: Long, defaultCharset: Charset): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String, maxLength: Long, timeout: Duration): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String, headers: Headers, defaultCharset: Charset): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String, headers: Headers, timeout: Duration): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String, headers: Headers, maxLength: Long): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String, defaultCharset: Charset): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String, timeout: Duration): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String, maxLength: Long): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String, headers: Headers): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def postFullString(url: String, body: String): Future[FullStringResponse]

Perform a POST request returning the FullStringResponse
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def withBasicAuth(user: String, pass: String): HttpClient

Return an HttpClient that will use Basic auth for any calls made by it
final def withDigestAuth(user: String, pass: String): HttpClient

Return an HttpClient that will use Digest auth for any calls made by it

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Docs: object HttpClient | package client

abstract class HttpClient extends Closeable

Instance Constructors

new HttpClient()

Abstract Value Members

abstract def close(): Unit

abstract def defaultCharset: Charset

abstract def defaultHeaders: Headers

abstract def defaultMaxLength: Long

abstract def defaultResponseTimeout: Duration

abstract def execute(r: Request, timeout: Duration): Future[AsyncResponse]

implicit abstract def executionContext: ExecutionContext

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def execute(r: Request): Future[AsyncResponse]

final def getAsync(url: String, headers: Headers, timeout: Duration): Future[AsyncResponse]

final def getAsync(url: String, timeout: Duration): Future[AsyncResponse]

final def getAsync(url: String, headers: Headers): Future[AsyncResponse]

final def getAsync(url: String): Future[AsyncResponse]

final def getClass(): Class[_]

final def getFull(url: String, headers: Headers, maxLength: Long, timeout: Duration): Future[FullResponse]

final def getFull(url: String, maxLength: Long, timeout: Duration): Future[FullResponse]

final def getFull(url: String, headers: Headers, timeout: Duration): Future[FullResponse]

final def getFull(url: String, headers: Headers, maxLength: Long): Future[FullResponse]

final def getFull(url: String, timeout: Duration): Future[FullResponse]

final def getFull(url: String, maxLength: Long): Future[FullResponse]

final def getFull(url: String, headers: Headers): Future[FullResponse]

final def getFull(url: String): Future[FullResponse]

final def getFullString(url: String, headers: Headers, maxLength: Long, timeout: Duration, defaultCharset: Charset): Future[FullStringResponse]

final def getFullString(url: String, maxLength: Long, timeout: Duration, defaultCharset: Charset): Future[FullStringResponse]

final def getFullString(url: String, headers: Headers, timeout: Duration, defaultCharset: Charset): Future[FullStringResponse]

final def getFullString(url: String, headers: Headers, maxLength: Long, defaultCharset: Charset): Future[FullStringResponse]

final def getFullString(url: String, headers: Headers, maxLength: Long, timeout: Duration): Future[FullStringResponse]

final def getFullString(url: String, timeout: Duration, defaultCharset: Charset): Future[FullStringResponse]

final def getFullString(url: String, maxLength: Long, defaultCharset: Charset): Future[FullStringResponse]

final def getFullString(url: String, maxLength: Long, timeout: Duration): Future[FullStringResponse]

final def getFullString(url: String, headers: Headers, defaultCharset: Charset): Future[FullStringResponse]

final def getFullString(url: String, headers: Headers, timeout: Duration): Future[FullStringResponse]

final def getFullString(url: String, headers: Headers, maxLength: Long): Future[FullStringResponse]

final def getFullString(url: String, defaultCharset: Charset): Future[FullStringResponse]

final def getFullString(url: String, timeout: Duration): Future[FullStringResponse]

final def getFullString(url: String, maxLength: Long): Future[FullStringResponse]

final def getFullString(url: String, headers: Headers): Future[FullStringResponse]

final def getFullString(url: String): Future[FullStringResponse]

def hashCode(): Int

final def head(url: String, headers: Headers, timeout: Duration): Future[FullResponse]

final def head(url: String, timeout: Duration): Future[FullResponse]

final def head(url: String, headers: Headers): Future[FullResponse]

final def head(url: String): Future[FullResponse]

final def isInstanceOf[T0]: Boolean

def logException(request: Request, requestBody: Option[String], ex: Throwable): Unit

def logSuccess(request: Request, requestBody: Option[String], response: Response): Unit

def loggingHooksEnabled: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def postAsync(url: String, body: LinkedHttpContent, headers: Headers, timeout: Duration): Future[AsyncResponse]

final def postAsync(url: String, body: File, headers: Headers, timeout: Duration): Future[AsyncResponse]

final def postAsync(url: String, body: File, timeout: Duration): Future[AsyncResponse]

final def postAsync(url: String, body: File, headers: Headers): Future[AsyncResponse]

final def postAsync(url: String, body: LinkedHttpContent): Future[AsyncResponse]

final def postAsync(url: String, body: File): Future[AsyncResponse]

final def postAsync(url: String, body: String, headers: Headers, timeout: Duration): Future[AsyncResponse]

final def postAsync(url: String, body: String, timeout: Duration): Future[AsyncResponse]

final def postAsync(url: String, body: String, headers: Headers): Future[AsyncResponse]

final def postAsync(url: String, body: String): Future[AsyncResponse]

final def postAsync(url: String, body: Array[Byte], headers: Headers, timeout: Duration): Future[AsyncResponse]

final def postAsync(url: String, body: Array[Byte], timeout: Duration): Future[AsyncResponse]

final def postAsync(url: String, body: Array[Byte], headers: Headers): Future[AsyncResponse]

final def postAsync(url: String, body: Array[Byte]): Future[AsyncResponse]

final def postFull(url: String, body: String, headers: Headers, maxLength: Long, timeout: Duration): Future[FullResponse]

final def postFull(url: String, body: String, maxLength: Long, timeout: Duration): Future[FullResponse]

final def postFull(url: String, body: String, headers: Headers, timeout: Duration): Future[FullResponse]