HttpClient

Instance Constructors

new HttpClient(saveDirectory: File = ..., dropNullKeys: Boolean = false)

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])(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]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
def dispose(): Unit

Disposes and cleans up this client instance.
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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)(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]
def send(request: HttpRequest): 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
returns
Future[HttpResponse]
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( ... )

Related Doc: package client

class HttpClient extends AnyRef

Instance Constructors

new HttpClient(saveDirectory: File = ..., dropNullKeys: Boolean = false)

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])(implicit decoder: Decoder[Response]): Future[Response]

def clone(): AnyRef

def defaultErrorHandler[Response]: ErrorHandler[Response]

def dispose(): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def send(request: HttpRequest): Future[HttpResponse]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped