case class Req(run: (RequestBuilder) ⇒ RequestBuilder, props: Properties = Req.Properties()) extends MethodVerbs with UrlVerbs with ParamVerbs with AuthVerbs with HeaderVerbs with RequestBuilderVerbs with Product with Serializable
This wrapper provides referential transparency for the underlying RequestBuilder.
- Alphabetic
- By Inheritance
- Req
- Serializable
- Serializable
- Product
- Equals
- RequestBuilderVerbs
- HeaderVerbs
- AuthVerbs
- ParamVerbs
- UrlVerbs
- MethodVerbs
- RequestVerbs
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Req(run: (RequestBuilder) ⇒ RequestBuilder, props: Properties = Req.Properties())
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
/(segment: AnyVal): Req
Append a segment to the URL using the toString method of the provided segment.
Append a segment to the URL using the toString method of the provided segment.
- Definition Classes
- UrlVerbs
-
def
/(segment: String): Req
Append a segment to the URL.
Append a segment to the URL.
- Definition Classes
- UrlVerbs
-
def
/?(segmentOpt: Option[String]): Req
Append a segment that may or may not occur to the URL.
Append a segment that may or may not occur to the URL.
- Definition Classes
- UrlVerbs
-
def
<:<(hs: Iterable[(String, String)]): Req
Append a collecton of headers to the headers already on the request.
Append a collecton of headers to the headers already on the request.
- Definition Classes
- HeaderVerbs
-
def
<<(body: String): Req
Set request body to a given string,
Set request body to a given string,
- set method to POST unless explicitly set otherwise
- set HTTP Content-Type to "text/plain; charset=UTF-8" if unspecified.
- Definition Classes
- ParamVerbs
-
def
<<(params: Iterable[(String, String)]): Req
Adds
paramsto the request body.Adds
paramsto the request body. Sets request method to POST unless it has been explicitly set.- Definition Classes
- ParamVerbs
-
def
<<<(file: File): Req
Set a file as the request body and set method to PUT if it's not explicitly set.
Set a file as the request body and set method to PUT if it's not explicitly set.
- Definition Classes
- ParamVerbs
-
def
<<?(params: Iterable[(String, String)]): Req
Adds
paramsas query parametersAdds
paramsas query parameters- Definition Classes
- ParamVerbs
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
DELETE: Req
- Definition Classes
- MethodVerbs
-
def
GET: Req
- Definition Classes
- MethodVerbs
-
def
HEAD: Req
- Definition Classes
- MethodVerbs
-
def
OPTIONS: Req
- Definition Classes
- MethodVerbs
-
def
PATCH: Req
- Definition Classes
- MethodVerbs
-
def
POST: Req
- Definition Classes
- MethodVerbs
-
def
PUT: Req
- Definition Classes
- MethodVerbs
-
def
TRACE: Req
- Definition Classes
- MethodVerbs
-
def
addBodyPart(part: Part): Req
Add a new body part to the request.
Add a new body part to the request.
- Definition Classes
- RequestBuilderVerbs
-
def
addCookie(cookie: Cookie): Req
Add a new cookie to the request.
Add a new cookie to the request.
- Definition Classes
- RequestBuilderVerbs
-
def
addHeader(name: String, value: String): Req
Add a new header to the request.
Add a new header to the request.
- Definition Classes
- RequestBuilderVerbs
-
def
addOrReplaceCookie(cookie: Cookie): Req
Add ore replace a cookie
Add ore replace a cookie
- Definition Classes
- RequestBuilderVerbs
-
def
addParameter(key: String, value: String): Req
Add a new body parameter to the request.
Add a new body parameter to the request.
- Definition Classes
- RequestBuilderVerbs
-
def
addQueryParameter(name: String, value: String): Req
Add a new query parameter to the request.
Add a new query parameter to the request.
- Definition Classes
- RequestBuilderVerbs
-
def
appendBodyParams(params: Iterable[(String, String)]): Req
Adds
paramsto the request body.Adds
paramsto the request body. Sets request method to POST unless it has been explicitly set.- Definition Classes
- ParamVerbs
-
def
appendHeaders(hs: Iterable[(String, String)]): Req
Append a collecton of headers to the headers already on the request.
Append a collecton of headers to the headers already on the request.
- Definition Classes
- HeaderVerbs
-
def
appendOptionalSegment(segmentOpt: Option[String]): Req
Append a segment that may or may not occur to the URL.
Append a segment that may or may not occur to the URL.
- Definition Classes
- UrlVerbs
-
def
appendQueryParams(params: Iterable[(String, String)]): Req
Adds
paramsas query parametersAdds
paramsas query parameters- Definition Classes
- ParamVerbs
-
def
appendSegment(segment: AnyVal): Req
Append a segment to the URL using the toString method of the provided segment.
Append a segment to the URL using the toString method of the provided segment.
- Definition Classes
- UrlVerbs
-
def
appendSegment(segment: String): Req
Append a segment to the URL.
Append a segment to the URL.
- Definition Classes
- UrlVerbs
-
def
as(realm: Realm): Req
- Definition Classes
- AuthVerbs
-
def
as(user: String, password: String, scheme: AuthScheme): Req
- Definition Classes
- AuthVerbs
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
as_!(user: String, password: String): Req
Basic auth, use with care.
Basic auth, use with care.
- Definition Classes
- AuthVerbs
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
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
- Annotations
- @native()
-
def
implyMethod(method: String): Req
Set method unless method has been explicitly set using setMethod.
Set method unless method has been explicitly set using setMethod.
- Definition Classes
- RequestBuilderVerbs
-
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()
- val props: Properties
- val run: (RequestBuilder) ⇒ RequestBuilder
-
def
secure: Req
Ensure the request is using the https scheme.
Ensure the request is using the https scheme.
- Definition Classes
- UrlVerbs
-
def
setBody(file: File): Req
Set the request body to the contents of a File.
Set the request body to the contents of a File.
- Definition Classes
- RequestBuilderVerbs
-
def
setBody(data: String): Req
Set the request body using a string.
Set the request body using a string.
- Definition Classes
- RequestBuilderVerbs
-
def
setBody(dataWriter: BodyGenerator): Req
Set the request body using a BodyGenerator.
Set the request body using a BodyGenerator.
- Definition Classes
- RequestBuilderVerbs
-
def
setBody(dataWriter: BodyGenerator, length: Long): Req
Set the request body using a BodyGenerator and length.
Set the request body using a BodyGenerator and length.
- Definition Classes
- RequestBuilderVerbs
-
def
setBody(data: Array[Byte]): Req
Set the request body from a byte array.
Set the request body from a byte array.
- Definition Classes
- RequestBuilderVerbs
-
def
setBodyEncoding(charset: Charset): Req
Set the body encoding to the specified charset.
Set the body encoding to the specified charset.
- Definition Classes
- RequestBuilderVerbs
-
def
setContentType(mediaType: String, charset: Charset): Req
Set the content type and charset for the request.
Set the content type and charset for the request.
- Definition Classes
- RequestBuilderVerbs
-
def
setFileBody(file: File): Req
Set a file as the request body and set method to PUT if it's not explicitly set.
Set a file as the request body and set method to PUT if it's not explicitly set.
- Definition Classes
- ParamVerbs
-
def
setFollowRedirects(followRedirects: Boolean): Req
Set the follow redirects setting
Set the follow redirects setting
- Definition Classes
- RequestBuilderVerbs
-
def
setHeader(name: String, value: String): Req
Set a header
Set a header
- Definition Classes
- RequestBuilderVerbs
-
def
setHeaders(headers: Map[String, Seq[String]]): Req
Set multiple headers
Set multiple headers
- Definition Classes
- RequestBuilderVerbs
-
def
setMethod(method: String): Req
Explicitly set the method of the request.
Explicitly set the method of the request.
- Definition Classes
- RequestBuilderVerbs
-
def
setParameters(parameters: Map[String, Seq[String]]): Req
Set form parameters
Set form parameters
- Definition Classes
- RequestBuilderVerbs
-
def
setProxyServer(proxyServer: ProxyServer): Req
Set the proxy server for the request
Set the proxy server for the request
- Definition Classes
- RequestBuilderVerbs
-
def
setQueryParameters(params: Map[String, Seq[String]]): Req
Set query parameters, overwriting any pre-existing query parameters.
Set query parameters, overwriting any pre-existing query parameters.
- Definition Classes
- RequestBuilderVerbs
-
def
setRealm(realm: Realm): Req
Set auth realm
Set auth realm
- Definition Classes
- RequestBuilderVerbs
-
def
setStringBody(body: String): Req
Set request body to a given string,
Set request body to a given string,
- set method to POST unless explicitly set otherwise
- set HTTP Content-Type to "text/plain; charset=UTF-8" if unspecified.
- Definition Classes
- ParamVerbs
-
def
setUrl(url: String): Req
Set the url of the request.
Set the url of the request.
- Definition Classes
- RequestBuilderVerbs
-
def
setVirtualHost(virtualHost: String): Req
Set the virual hostname
Set the virual hostname
- Definition Classes
- RequestBuilderVerbs
-
def
subject: Req
- Definition Classes
- Req → RequestVerbs
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toRequest: Request
Convert this to a concrete request.
-
def
toRequestBuilder: RequestBuilder
Convert this to a concrete RequestBuilder setting the Content-Type for String bodies if not already set.
-
def
underlying(nextReq: (RequestBuilder) ⇒ RequestBuilder, nextProps: (Properties) ⇒ Properties): Req
Append a transform onto the underlying AHC RequestBuilder and simultaniously transform the Req.Properties.
-
def
underlying(next: (RequestBuilder) ⇒ RequestBuilder): Req
Append a transform onto the underlying AHC RequestBuilder.
-
def
url: String
Retrieve the fully materialized URL.
Retrieve the fully materialized URL.
- Definition Classes
- UrlVerbs
-
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
- @native() @throws( ... )