play-ahc-ws-standalone
API
Generated with
play-ahc-ws-standalone/play.api.libs/play.api.libs.ws.ahc/StandaloneAhcWSRequest

StandaloneAhcWSRequest

play.api.libs.ws.ahc.StandaloneAhcWSRequest
case class StandaloneAhcWSRequest(client: StandaloneAhcWSClient, url: String, method: String, body: WSBody, headers: Map[String, Seq[String]], queryString: Map[String, Seq[String]], cookies: Seq[WSCookie], calc: Option[WSSignatureCalculator], auth: Option[(String, String, WSAuthScheme)], followRedirects: Option[Boolean], requestTimeout: Option[Duration], virtualHost: Option[String], proxyServer: Option[WSProxyServer], disableUrlEncoding: Option[Boolean], filters: Seq[WSRequestFilter])(implicit materializer: Materializer) extends StandaloneWSRequest, AhcUtilities, WSCookieConverter

A Ahc WS Request.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AhcUtilities
trait StandaloneWSRequest
class Object
trait Matchable
class Any
Show all

Members list

Type members

Types

override type Response = StandaloneWSResponse
override type Self = StandaloneAhcWSRequest

Value members

Concrete methods

override def addHttpHeaders(hdrs: (String, String)*): Self

Returns this request with the given headers, preserving the existing ones.

Returns this request with the given headers, preserving the existing ones.

Value parameters

hdrs

the headers to be added

Attributes

Definition Classes
StandaloneWSRequest
override def addQueryStringParameters(parameters: (String, String)*): Self

Returns this request with the given query string parameters, preserving the existing ones.

Returns this request with the given query string parameters, preserving the existing ones.

Value parameters

parameters

the query string parameters

Attributes

Definition Classes
StandaloneWSRequest
def buildRequest(): Request

Creates and returns an AHC request, running all operations on it.

Creates and returns an AHC request, running all operations on it.

Attributes

override def contentType: Option[String]

The content type for this request, if any is defined.

The content type for this request, if any is defined.

Attributes

Definition Classes
StandaloneWSRequest
override def delete(): Future[Response]

Perform a DELETE on the request asynchronously.

Perform a DELETE on the request asynchronously.

Attributes

Definition Classes
StandaloneWSRequest
override def execute(method: String): Future[Response]

Executes the given HTTP method.

Executes the given HTTP method.

Value parameters

method

the HTTP method that will be executed

Attributes

Returns

a future with the response for this request

Definition Classes
StandaloneWSRequest
override def execute(): Future[Response]

Execute this request

Execute this request

Attributes

Definition Classes
StandaloneWSRequest
override def get(): Future[Response]

performs a get

performs a get

Attributes

Definition Classes
StandaloneWSRequest
override def head(): Future[Response]

Perform a HEAD on the request asynchronously.

Perform a HEAD on the request asynchronously.

Attributes

Definition Classes
StandaloneWSRequest
override def options(): Future[Response]

Perform a OPTIONS on the request asynchronously.

Perform a OPTIONS on the request asynchronously.

Attributes

Definition Classes
StandaloneWSRequest
override def patch[T : BodyWritable](body: T): Future[Response]

Attributes

Definition Classes
StandaloneWSRequest
override def post[T : BodyWritable](body: T): Future[Response]

Attributes

Definition Classes
StandaloneWSRequest
override def put[T : BodyWritable](body: T): Future[Response]

Attributes

Definition Classes
StandaloneWSRequest
def requestHeader(name: String): Option[String]

Returns the HTTP header given by name, using the request builder. This may be signed, so may return extra headers that were not directly input.

Returns the HTTP header given by name, using the request builder. This may be signed, so may return extra headers that were not directly input.

Attributes

def requestHeaders: Map[String, Seq[String]]

Returns the current headers of the request, using the request builder. This may be signed, so may return extra headers that were not directly input.

Returns the current headers of the request, using the request builder. This may be signed, so may return extra headers that were not directly input.

Attributes

def requestQueryParams: Map[String, Seq[String]]

Returns the current query string parameters, using the request builder. This may be signed, so may not return the same parameters that were input.

Returns the current query string parameters, using the request builder. This may be signed, so may not return the same parameters that were input.

Attributes

def requestUrl: String

Returns the current URL, using the request builder. This may be signed by OAuth, as opposed to request.url. This is an AHC specific method.

Returns the current URL, using the request builder. This may be signed by OAuth, as opposed to request.url. This is an AHC specific method.

Attributes

override def sign(calc: WSSignatureCalculator): Self

sets the signature calculator for the request

sets the signature calculator for the request

Value parameters

calc

the signature calculator

Attributes

Definition Classes
StandaloneWSRequest
override def stream(): Future[Response]

Execute this request and stream the response body.

Execute this request and stream the response body.

Attributes

Definition Classes
StandaloneWSRequest
override def withAuth(username: String, password: String, scheme: WSAuthScheme): Self

sets the authentication realm

sets the authentication realm

Attributes

Definition Classes
StandaloneWSRequest
def withBody[T : BodyWritable](body: T): Self

Sets the body for this request.

Sets the body for this request.

Attributes

override def withCookies(cookies: WSCookie*): Self

Returns this request with the given cookies, discarding the existing ones. In general, cookies set on a request are used only on that request and then discarded. But when play.ws.ahc.useCookieStore is enabled, there will be a global cookie store that keeps cookies between requests.

Returns this request with the given cookies, discarding the existing ones. In general, cookies set on a request are used only on that request and then discarded. But when play.ws.ahc.useCookieStore is enabled, there will be a global cookie store that keeps cookies between requests.

Value parameters

cookies

the cookies to be used

Attributes

Definition Classes
StandaloneWSRequest
override def withDisableUrlEncoding(disableUrlEncoding: Boolean): Self

Sets whether url encoding should be disabled

Sets whether url encoding should be disabled

Attributes

Definition Classes
StandaloneWSRequest
override def withFollowRedirects(follow: Boolean): Self

Sets whether redirects (301, 302) should be followed automatically

Sets whether redirects (301, 302) should be followed automatically

Attributes

Definition Classes
StandaloneWSRequest
override def withHttpHeaders(hdrs: (String, String)*): Self

Returns this request with the given headers, discarding the existing ones.

Returns this request with the given headers, discarding the existing ones.

Value parameters

headers

the headers to be used

Attributes

Definition Classes
StandaloneWSRequest
override def withMethod(method: String): Self

Sets the method for this request

Sets the method for this request

Attributes

Definition Classes
StandaloneWSRequest
override def withProxyServer(proxyServer: WSProxyServer): Self

Sets the proxy server to use in this request

Sets the proxy server to use in this request

Attributes

Definition Classes
StandaloneWSRequest
override def withQueryStringParameters(parameters: (String, String)*): Self

Returns this request with the given query string parameters, discarding the existing ones.

Returns this request with the given query string parameters, discarding the existing ones.

Value parameters

parameters

the query string parameters

Attributes

Definition Classes
StandaloneWSRequest
override def withRequestFilter(filter: WSRequestFilter): Self

Adds a filter to the request that can transform the request for subsequent filters.

Adds a filter to the request that can transform the request for subsequent filters.

Attributes

Definition Classes
StandaloneWSRequest
override def withRequestTimeout(timeout: Duration): Self

Sets the maximum time you expect the request to take. Use Duration.Inf to set an infinite request timeout. Warning: a stream consumption will be interrupted when this time is reached unless Duration.Inf is set.

Sets the maximum time you expect the request to take. Use Duration.Inf to set an infinite request timeout. Warning: a stream consumption will be interrupted when this time is reached unless Duration.Inf is set.

Attributes

Definition Classes
StandaloneWSRequest
override def withUrl(url: String): Self

Sets the url for this request.

Sets the url for this request.

Attributes

Definition Classes
StandaloneWSRequest
override def withVirtualHost(vh: String): Self

Sets the virtual host to use in this request

Sets the virtual host to use in this request

Attributes

Definition Classes
StandaloneWSRequest

Inherited methods

def addCookies(cookies: WSCookie*): Self

Returns this request with the given query string parameters, preserving the existing ones.

Returns this request with the given query string parameters, preserving the existing ones.

Value parameters

cookies

the cookies to be used

Attributes

Inherited from:
StandaloneWSRequest
def asCookie(c: Cookie): WSCookie

Attributes

Inherited from:
WSCookieConverter
def asCookie(cookie: WSCookie): Cookie

Attributes

Inherited from:
WSCookieConverter
def header(name: String): Option[String]

Get the value of the header with the specified name. If there are more than one values for this header, the first value is returned. If there are no values, than a None is returned.

Get the value of the header with the specified name. If there are more than one values for this header, the first value is returned. If there are no values, than a None is returned.

Value parameters

name

the header name

Attributes

Returns

the header value

Inherited from:
StandaloneWSRequest
def headerValues(name: String): Seq[String]

Get all the values of header with the specified name. If there are no values for the header with the specified name, than an empty sequence is returned.

Get all the values of header with the specified name. If there are no values for the header with the specified name, than an empty sequence is returned.

Value parameters

name

the header name.

Attributes

Returns

all the values for this header name.

Inherited from:
StandaloneWSRequest
def headersToMap(headers: HttpHeaders): TreeMap[String, Seq[String]]

Attributes

Inherited from:
AhcUtilities
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

lazy override val uri: URI

The URI for this request

The URI for this request

Attributes

Generated with