Class/Object

requests

Requester

Related Docs: object Requester | package requests

Permalink

case class Requester(verb: String, sess: BaseSession) extends Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Requester
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Requester(verb: String, sess: BaseSession)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def apply(r: Request, data: RequestBlob, chunkedUpload: Boolean): Response

    Permalink

    Overload of Requester.apply that takes a Request object as configuration

  5. def apply(url: String, auth: RequestAuth = sess.auth, params: Iterable[(String, String)] = Nil, headers: Iterable[(String, String)] = Nil, data: RequestBlob = RequestBlob.EmptyRequestBlob, readTimeout: Int = sess.readTimeout, connectTimeout: Int = sess.connectTimeout, proxy: (String, Int) = sess.proxy, cert: Cert = sess.cert, sslContext: SSLContext = sess.sslContext, cookies: Map[String, HttpCookie] = Map(), cookieValues: Map[String, String] = Map(), maxRedirects: Int = sess.maxRedirects, verifySslCerts: Boolean = sess.verifySslCerts, autoDecompress: Boolean = sess.autoDecompress, compress: Compress = sess.compress, keepAlive: Boolean = true, check: Boolean = sess.check, chunkedUpload: Boolean = sess.chunkedUpload): Response

    Permalink

    Makes a single HTTP request, and returns a Response object.

    Makes a single HTTP request, and returns a Response object. Requires all uploaded request data to be provided up-front, and aggregates all downloaded response data before returning it in the response. If you need streaming access to the upload and download, use the Requester.stream function instead.

    url

    The URL to which you want to make this HTTP request

    auth

    HTTP authentication you want to use with this request; defaults to none

    params

    URL params to pass to this request, for GETs and DELETEs

    headers

    Custom headers to use, in addition to the defaults

    data

    Body data to pass to this request, for POSTs and PUTs. Can be a Map[String, String] of form data, bulk data as a String or Array[Byte], or MultiPart form data.

    readTimeout

    How long to wait for data to be read before timing out

    connectTimeout

    How long to wait for a connection before timing out

    proxy

    Host and port of a proxy you want to use

    cert

    Client certificate configuration

    sslContext

    Client sslContext configuration

    cookies

    Custom cookies to send up with this request

    maxRedirects

    How many redirects to automatically resolve; defaults to 5. You can also set it to 0 to prevent Requests from resolving redirects for you

    verifySslCerts

    Set this to false to ignore problems with SSL certificates

    check

    Throw an exception on a 4xx or 5xx response code. Defaults to true

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

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

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

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

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. val sess: BaseSession

    Permalink
  16. def stream(r: Request, data: RequestBlob, chunkedUpload: Boolean, onHeadersReceived: (StreamHeaders) ⇒ Unit): Writable

    Permalink

    Overload of Requester.stream that takes a Request object as configuration

  17. def stream(url: String, auth: RequestAuth = sess.auth, params: Iterable[(String, String)] = Nil, blobHeaders: Iterable[(String, String)] = Nil, headers: Iterable[(String, String)] = Nil, data: RequestBlob = RequestBlob.EmptyRequestBlob, readTimeout: Int = sess.readTimeout, connectTimeout: Int = sess.connectTimeout, proxy: (String, Int) = sess.proxy, cert: Cert = sess.cert, sslContext: SSLContext = sess.sslContext, cookies: Map[String, HttpCookie] = Map(), cookieValues: Map[String, String] = Map(), maxRedirects: Int = sess.maxRedirects, verifySslCerts: Boolean = sess.verifySslCerts, autoDecompress: Boolean = sess.autoDecompress, compress: Compress = sess.compress, keepAlive: Boolean = true, check: Boolean = true, chunkedUpload: Boolean = false, redirectedFrom: Option[Response] = None, onHeadersReceived: (StreamHeaders) ⇒ Unit = null): Readable

    Permalink

    Performs a streaming HTTP request.

    Performs a streaming HTTP request. Most of the parameters are the same as apply, except that the data parameter is missing, and no Response object is returned. Instead, the caller gets access via three callbacks (described below). This provides a lower-level API than Requester.apply, allowing the caller fine-grained access to the upload/download streams so they can direct them where-ever necessary without first aggregating all the data into memory.

    onHeadersReceived

    the second callback to be called, this provides access to the response's status code, status message, headers, and any previous re-direct responses. Returns a boolean, where false can be used to

    returns

    a Writable that can be used to write the output data to any destination

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

    Permalink
    Definition Classes
    AnyRef
  19. val verb: String

    Permalink
  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped