StandaloneAhcWSRequest

Instance Constructors

new StandaloneAhcWSRequest(client: StandaloneAhcWSClient, url: String, method: String = "GET", body: WSBody = EmptyBody, headers: Map[String, Seq[String]] = TreeMap()(CaseInsensitiveOrdered), queryString: Map[String, Seq[String]] = Map.empty, calc: Option[WSSignatureCalculator] = None, auth: Option[(String, String, WSAuthScheme)] = None, followRedirects: Option[Boolean] = None, requestTimeout: Option[Int] = None, virtualHost: Option[String] = None, proxyServer: Option[WSProxyServer] = None, disableUrlEncoding: Option[Boolean] = None, filters: Seq[WSRequestFilter] = Nil)(implicit materializer: Materializer)

Type Members

type Response = StandaloneWSResponse

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
type Self = StandaloneWSRequest

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest

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
val auth: Option[(String, String, WSAuthScheme)]

The authentication this request should use
The authentication this request should use

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
val body: WSBody

The body of this request
The body of this request

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def buildRequest(): Request

Creates and returns an AHC request, running all operations on it.
val calc: Option[WSSignatureCalculator]

A calculator of the signature for this request
A calculator of the signature for this request

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
val client: StandaloneAhcWSClient
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def contentType: Option[String]

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

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

Perform a DELETE on the request asynchronously.
Perform a DELETE on the request asynchronously.

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
val disableUrlEncoding: Option[Boolean]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def execute(): Future[Response]

Execute this request
Execute this request

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

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def filterWSRequestExecutor(next: WSRequestExecutor): WSRequestExecutor

Attributes
protected
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val followRedirects: Option[Boolean]

Whether this request should follow redirects
Whether this request should follow redirects

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

performs a get
performs a get

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def getBody: Option[ByteString]

Returns the body as an array of bytes.
Returns the body as an array of bytes. This is an AHC specific method.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def head(): Future[Response]

Perform a HEAD on the request asynchronously.
Perform a HEAD on the request asynchronously.

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
val headers: Map[String, Seq[String]]

The headers for this request
The headers for this request

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def headersToMap(headers: HttpHeaders): TreeMap[String, Seq[String]]

Definition Classes
AhcUtilities
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val method: String

The method for this request
The method for this request

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def options(): Future[Response]

Perform a OPTIONS on the request asynchronously.
Perform a OPTIONS on the request asynchronously.

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def patch(body: File): Future[Response]

Perform a PATCH on the request asynchronously.
Perform a PATCH on the request asynchronously. Request body won't be chunked

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def patch[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def post(body: File): Future[Response]

Perform a POST on the request asynchronously.
Perform a POST on the request asynchronously. Request body won't be chunked

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def post[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
val proxyServer: Option[WSProxyServer]

The proxy server this request will use
The proxy server this request will use

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def put(body: File): Future[Response]

Perform a PUT on the request asynchronously.
Perform a PUT on the request asynchronously. Request body won't be chunked

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def put[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
val queryString: Map[String, Seq[String]]

The query string for this request
The query string for this request

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

Returns the HTTP header given by name, using the request builder.
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.
def requestHeaders: Map[String, Seq[String]]

Returns the current headers of the request, using the request builder.
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.
def requestQueryParams: Map[String, Seq[String]]

Returns the current query string parameters, using the request builder.
Returns the current query string parameters, using the request builder. This may be signed, so may not return the same parameters that were input.
val requestTimeout: Option[Int]

The timeout for the request
The timeout for the request

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def requestUrl: String

Returns the current URL, using the request builder.
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.
def sign(calc: WSSignatureCalculator): Self

sets the signature calculator for the request
sets the signature calculator for the request

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def stream(): Future[StreamedResponse]

Execute this request and stream the response body.
Execute this request and stream the response body.

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
lazy val uri: URI

The URI for this request
The URI for this request

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
val url: String

The base URL for this request
The base URL for this request

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
val virtualHost: Option[String]

The virtual host this request will use
The virtual host this request will use

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
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( ... )
def withAuth(username: String, password: String, scheme: WSAuthScheme): Self

sets the authentication realm
sets the authentication realm

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def withBody[T](body: T)(implicit arg0: BodyWritable[T]): Self

Sets the body for this request.
Sets the body for this request.

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def withBody(body: WSBody): Self

Sets the body for this request
Sets the body for this request

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def withBody(body: File): Self

Sets the body for this request
Sets the body for this request

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def withFollowRedirects(follow: Boolean): Self

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

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def withHeaders(hdrs: (String, String)*): Self

adds any number of HTTP headers
adds any number of HTTP headers

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def withMethod(method: String): Self

Sets the method for this request
Sets the method for this request

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def withProxyServer(proxyServer: WSProxyServer): Self

Sets the proxy server to use in this request
Sets the proxy server to use in this request

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def withQueryString(parameters: (String, String)*): Self

adds any number of query string parameters to this request
adds any number of query string parameters to this request

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
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.

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def withRequestTimeout(timeout: Duration): Self

Sets the maximum time you expect the request to take.
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.

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest
def withVirtualHost(vh: String): Self

Sets the virtual host to use in this request
Sets the virtual host to use in this request

Definition Classes
StandaloneAhcWSRequest → StandaloneWSRequest

Related Doc: package ahc

Instance Constructors

Type Members

type Response = StandaloneWSResponse

type Self = StandaloneWSRequest

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val auth: Option[(String, String, WSAuthScheme)]

val body: WSBody

def buildRequest(): Request

val calc: Option[WSSignatureCalculator]

val client: StandaloneAhcWSClient

def clone(): AnyRef

def contentType: Option[String]

def delete(): Future[Response]

val disableUrlEncoding: Option[Boolean]

final def eq(arg0: AnyRef): Boolean

def execute(): Future[Response]

def execute(method: String): Future[Response]

def filterWSRequestExecutor(next: WSRequestExecutor): WSRequestExecutor

def finalize(): Unit

val followRedirects: Option[Boolean]

def get(): Future[Response]

def getBody: Option[ByteString]

final def getClass(): Class[_]

def head(): Future[Response]

val headers: Map[String, Seq[String]]

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

final def isInstanceOf[T0]: Boolean

val method: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def options(): Future[Response]

def patch(body: File): Future[Response]

def patch[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

def post(body: File): Future[Response]

def post[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

val proxyServer: Option[WSProxyServer]

def put(body: File): Future[Response]

def put[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

val queryString: Map[String, Seq[String]]

def requestHeader(name: String): Option[String]

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

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

val requestTimeout: Option[Int]

def requestUrl: String

def sign(calc: WSSignatureCalculator): Self

def stream(): Future[StreamedResponse]

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

lazy val uri: URI

val url: String

val virtualHost: Option[String]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withAuth(username: String, password: String, scheme: WSAuthScheme): Self

def withBody[T](body: T)(implicit arg0: BodyWritable[T]): Self

def withBody(body: WSBody): Self

def withBody(body: File): Self

def withFollowRedirects(follow: Boolean): Self

def withHeaders(hdrs: (String, String)*): Self

def withMethod(method: String): Self

def withProxyServer(proxyServer: WSProxyServer): Self

def withQueryString(parameters: (String, String)*): Self

def withRequestFilter(filter: WSRequestFilter): Self

def withRequestTimeout(timeout: Duration): Self

def withVirtualHost(vh: String): Self

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AhcUtilities

Inherited from StandaloneWSRequest

Inherited from AnyRef

Inherited from Any