JVMHttpClient

Instance Constructors

new JVMHttpClient(saveDirectory: File = ..., timeout: FiniteDuration = 15.seconds, defaultRetries: Int = 0, defaultRetryDelay: FiniteDuration = 5.seconds, pingInterval: Option[FiniteDuration] = None, connectionPool: ConnectionPool = ConnectionPool.default)

saveDirectory
the directory to save response content of a non-textual type

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 call[Response](url: URL, method: Method = Method.Get, headers: Headers = Headers.empty, errorHandler: ErrorHandler[Response] = defaultErrorHandler[Response], retry: Int = defaultRetries, retryDelay: FiniteDuration = defaultRetryDelay)(implicit decoder: Decoder[Response]): Future[Response]

Builds on the send method by supporting basic restful calls that calls a URL and returns a case class as the response.
Builds on the send method by supporting basic restful calls that calls a URL and returns a case class as the response.
Response
the response type
url
the URL of the endpoint
headers
the headers if any to provide
errorHandler
error handling support if the response status is not Success
decoder
circe decoding of the Response
returns
Future[Response]

Definition Classes
HttpClient
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val connectionPool: ConnectionPool

Definition Classes
JVMHttpClient → HttpClient
def content2Bytes(content: Content): Array[Byte]

Attributes
protected
def content2String(content: Content): String

Attributes
protected
Definition Classes
JVMHttpClient → HttpClient
def contentToBytes(contentType: ContentType, contentLength: Option[Long]): Boolean

Attributes
protected
def contentToString(contentType: ContentType, contentLength: Option[Long]): Boolean

Attributes
protected
def defaultErrorHandler[Response]: ErrorHandler[Response]

Default error handler for restful bad response statuses.
Default error handler for restful bad response statuses.
Response
the type of response
returns
throws a RuntimeException when an error occurs

Attributes
protected
Definition Classes
HttpClient
val defaultRetries: Int

Definition Classes
JVMHttpClient → HttpClient
val defaultRetryDelay: FiniteDuration

Definition Classes
JVMHttpClient → HttpClient
def dropNullValues: Boolean

Definition Classes
HttpClient
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def logStats(): Unit
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val pingInterval: Option[FiniteDuration]
lazy val printer: Printer

Attributes
protected
Definition Classes
HttpClient
def restful[Request, Response](url: URL, request: Request, headers: Headers = Headers.empty, errorHandler: ErrorHandler[Response] = defaultErrorHandler[Response], method: Method = Method.Post, processor: (Json) ⇒ Json = (json: Json) => json, retry: Int = defaultRetries, retryDelay: FiniteDuration = defaultRetryDelay)(implicit encoder: Encoder[Request], decoder: Decoder[Response]): Future[Response]

Builds on the send method by supporting basic restful calls that take a case class as the request and returns a case class as the response.
Builds on the send method by supporting basic restful calls that take a case class as the request and returns a case class as the response.
Request
the request type
Response
the response type
url
the URL of the endpoint
request
the request instance
headers
the headers if any to provide
errorHandler
error handling support if the response status is not Success
encoder
circe encoding of the Request
decoder
circe decoding of the Response
returns
Future[Response]

Definition Classes
HttpClient
val saveDirectory: File

the directory to save response content of a non-textual type
def send(request: HttpRequest, retry: Int = defaultRetries, retryDelay: FiniteDuration = defaultRetryDelay): Future[HttpResponse]

Sends an HttpRequest and receives an asynchronous HttpResponse future.
Sends an HttpRequest and receives an asynchronous HttpResponse future.
request
the request to send
retry
the number of times to retry a failed request. This defaults to zero as most requests are not idempotent and calling multiple times can cause side-effects
retryDelay
if a failure occurs and a retry must occur, how long to wait until retrying. This defaults to 5.0 seconds
returns
Future[HttpResponse]

Definition Classes
JVMHttpClient → HttpClient
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val timeout: FiniteDuration
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( ... )

Related Docs: object JVMHttpClient | package client

Instance Constructors

new JVMHttpClient(saveDirectory: File = ..., timeout: FiniteDuration = 15.seconds, defaultRetries: Int = 0, defaultRetryDelay: FiniteDuration = 5.seconds, pingInterval: Option[FiniteDuration] = None, connectionPool: ConnectionPool = ConnectionPool.default)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def call[Response](url: URL, method: Method = Method.Get, headers: Headers = Headers.empty, errorHandler: ErrorHandler[Response] = defaultErrorHandler[Response], retry: Int = defaultRetries, retryDelay: FiniteDuration = defaultRetryDelay)(implicit decoder: Decoder[Response]): Future[Response]

def clone(): AnyRef

val connectionPool: ConnectionPool

def content2Bytes(content: Content): Array[Byte]

def content2String(content: Content): String

def contentToBytes(contentType: ContentType, contentLength: Option[Long]): Boolean

def contentToString(contentType: ContentType, contentLength: Option[Long]): Boolean

def defaultErrorHandler[Response]: ErrorHandler[Response]

val defaultRetries: Int

val defaultRetryDelay: FiniteDuration

def dropNullValues: Boolean

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

def logStats(): Unit

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val pingInterval: Option[FiniteDuration]

lazy val printer: Printer

val saveDirectory: File

def send(request: HttpRequest, retry: Int = defaultRetries, retryDelay: FiniteDuration = defaultRetryDelay): Future[HttpResponse]

final def synchronized[T0](arg0: ⇒ T0): T0

val timeout: FiniteDuration

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HttpClient

Inherited from AnyRef

Inherited from Any

Ungrouped