| Constructor and Description |
|---|
AhcWSRequest(AhcWSClient client,
java.lang.String url,
akka.stream.Materializer materializer) |
| Modifier and Type | Method and Description |
|---|---|
java.util.concurrent.CompletionStage<WSResponse> |
delete()
Perform a DELETE on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
execute()
Execute an arbitrary method on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
execute(java.lang.String method)
Execute an arbitrary method on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
get()
Perform a GET on the request asynchronously.
|
WSSignatureCalculator |
getCalculator() |
java.lang.Boolean |
getFollowRedirects() |
java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> |
getHeaders() |
java.lang.String |
getPassword() |
java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> |
getQueryParameters() |
long |
getRequestTimeout()
Gets the original request timeout in milliseconds, passed into the
request as input.
|
WSAuthScheme |
getScheme() |
java.lang.String |
getUrl() |
java.lang.String |
getUsername() |
java.util.concurrent.CompletionStage<WSResponse> |
head()
Perform a HEAD on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
options()
Perform an OPTIONS on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
patch(java.io.File body)
Perform a PATCH on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
patch(java.io.InputStream body)
Perform a PATCH on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
patch(com.fasterxml.jackson.databind.JsonNode body)
Perform a PATCH on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
patch(akka.stream.javadsl.Source<? super Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>,?> body)
Perform a PATCH on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
patch(java.lang.String body)
Perform a PATCH on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
post(java.io.File body)
Perform a POST on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
post(java.io.InputStream body)
Perform a POST on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
post(com.fasterxml.jackson.databind.JsonNode body)
Perform a POST on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
post(akka.stream.javadsl.Source<? super Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>,?> body)
Perform a POST on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
post(java.lang.String body)
Perform a POST on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
put(java.io.File body)
Perform a PUT on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
put(java.io.InputStream body)
Perform a PUT on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
put(com.fasterxml.jackson.databind.JsonNode body)
Perform a PUT on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
put(akka.stream.javadsl.Source<? super Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>,?> body)
Perform a PUT on the request asynchronously.
|
java.util.concurrent.CompletionStage<WSResponse> |
put(java.lang.String body)
Perform a PUT on the request asynchronously.
|
WSRequest |
setAuth(java.lang.String userInfo)
Sets the authentication header for the current request using BASIC authentication.
|
WSRequest |
setAuth(java.lang.String username,
java.lang.String password)
Sets the authentication header for the current request using BASIC authentication.
|
WSRequest |
setAuth(java.lang.String username,
java.lang.String password,
WSAuthScheme scheme)
Sets the authentication header for the current request.
|
WSRequest |
setBody(java.io.File body)
Set the body this request should use.
|
WSRequest |
setBody(java.io.InputStream body)
Set the body this request should use.
|
WSRequest |
setBody(com.fasterxml.jackson.databind.JsonNode body)
Set the body this request should use.
|
WSRequest |
setBody(akka.stream.javadsl.Source<akka.util.ByteString,?> body)
Set the body this request should use.
|
WSRequest |
setBody(java.lang.String body)
Set the body this request should use.
|
WSRequest |
setContentType(java.lang.String contentType)
Set the content type.
|
WSRequest |
setFollowRedirects(java.lang.Boolean followRedirects)
Sets whether redirects (301, 302) should be followed automatically.
|
AhcWSRequest |
setHeader(java.lang.String name,
java.lang.String value)
Sets a header with the given name, this can be called repeatedly.
|
WSRequest |
setMethod(java.lang.String method)
Set the HTTP method this request should use, where the no args execute() method is invoked.
|
WSRequest |
setQueryParameter(java.lang.String name,
java.lang.String value)
Sets a query parameter with the given name, this can be called repeatedly.
|
WSRequest |
setQueryString(java.lang.String query)
Sets a query string
|
WSRequest |
setRequestTimeout(long timeout)
Sets the request timeout in milliseconds.
|
WSRequest |
setVirtualHost(java.lang.String virtualHost)
Sets the virtual host as a "hostname:port" string.
|
WSRequest |
sign(WSSignatureCalculator calculator)
Sets an (OAuth) signature calculator.
|
java.util.concurrent.CompletionStage<StreamedResponse> |
stream()
Execute this request and stream the response body.
|
WSRequest |
withRequestFilter(WSRequestFilter filter)
Adds a request filter.
|
public AhcWSRequest(AhcWSClient client, java.lang.String url, akka.stream.Materializer materializer)
public AhcWSRequest setHeader(java.lang.String name, java.lang.String value)
public WSRequest setQueryString(java.lang.String query)
setQueryString in interface WSRequestquery - the query stringpublic WSRequest setQueryParameter(java.lang.String name, java.lang.String value)
WSRequestsetQueryParameter in interface WSRequestname - the query parameter namevalue - the query parameter valuepublic WSRequest setAuth(java.lang.String userInfo)
WSRequestpublic WSRequest setAuth(java.lang.String username, java.lang.String password)
WSRequestpublic WSRequest setAuth(java.lang.String username, java.lang.String password, WSAuthScheme scheme)
WSRequestpublic WSRequest sign(WSSignatureCalculator calculator)
WSRequestpublic WSRequest setFollowRedirects(java.lang.Boolean followRedirects)
WSRequestsetFollowRedirects in interface WSRequestfollowRedirects - true if the request should follow redirectspublic WSRequest setVirtualHost(java.lang.String virtualHost)
WSRequestsetVirtualHost in interface WSRequestvirtualHost - the virtual hostpublic WSRequest setRequestTimeout(long timeout)
WSRequestsetRequestTimeout in interface WSRequesttimeout - the request timeout in milliseconds. A value of -1 indicates an infinite request timeout.public WSRequest setContentType(java.lang.String contentType)
WSRequestsetContentType in interface WSRequestcontentType - The content typepublic WSRequest setMethod(java.lang.String method)
WSRequestpublic WSRequest setBody(java.lang.String body)
WSRequestpublic WSRequest setBody(com.fasterxml.jackson.databind.JsonNode body)
WSRequestpublic WSRequest setBody(java.io.InputStream body)
WSRequestpublic WSRequest setBody(java.io.File body)
WSRequestpublic WSRequest setBody(akka.stream.javadsl.Source<akka.util.ByteString,?> body)
WSRequestpublic java.lang.String getUrl()
public java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getHeaders()
getHeaders in interface WSRequestpublic java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getQueryParameters()
getQueryParameters in interface WSRequestpublic java.lang.String getUsername()
getUsername in interface WSRequestpublic java.lang.String getPassword()
getPassword in interface WSRequestpublic WSAuthScheme getScheme()
public WSSignatureCalculator getCalculator()
getCalculator in interface WSRequestpublic long getRequestTimeout()
WSRequestgetRequestTimeout in interface WSRequestpublic java.lang.Boolean getFollowRedirects()
getFollowRedirects in interface WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> get()
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> patch(java.lang.String body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> patch(com.fasterxml.jackson.databind.JsonNode body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> patch(java.io.InputStream body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> patch(java.io.File body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> patch(akka.stream.javadsl.Source<? super Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>,?> body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> post(java.lang.String body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> post(com.fasterxml.jackson.databind.JsonNode body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> post(java.io.InputStream body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> post(java.io.File body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> post(akka.stream.javadsl.Source<? super Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>,?> body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> put(java.lang.String body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> put(com.fasterxml.jackson.databind.JsonNode body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> put(java.io.InputStream body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> put(java.io.File body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> put(akka.stream.javadsl.Source<? super Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>,?> body)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> delete()
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> head()
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> options()
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> execute(java.lang.String method)
WSRequestpublic java.util.concurrent.CompletionStage<WSResponse> execute()
WSRequestpublic java.util.concurrent.CompletionStage<StreamedResponse> stream()
WSRequestpublic WSRequest withRequestFilter(WSRequestFilter filter)
WSRequestwithRequestFilter in interface WSRequestfilter - a tranforming filter.