play.libs.ws.ahc

Class StandaloneAhcWSRequest

java.lang.Object

play.libs.ws.ahc.StandaloneAhcWSRequest

All Implemented Interfaces:

StandaloneWSRequest

public class StandaloneAhcWSRequest
extends java.lang.Object
implements StandaloneWSRequest

Provides the User facing API for building a WS request.

Constructor Summary

Constructors

Constructor and Description
StandaloneAhcWSRequest(StandaloneAhcWSClient client, java.lang.String url, akka.stream.Materializer materializer)
StandaloneAhcWSRequest(StandaloneAhcWSClient client, java.lang.String url, akka.stream.Materializer materializer, com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	delete() Perform a DELETE on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	execute() Execute an arbitrary method on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	execute(java.lang.String method) Execute an arbitrary method on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	get() Perform a GET on the request asynchronously.
WSSignatureCalculator	getCalculator()
java.lang.String	getContentType()
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<? extends StandaloneWSResponse>	head() Perform a HEAD on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	options() Perform an OPTIONS on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	patch(java.io.File body) Perform a PATCH on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	patch(java.io.InputStream body) Perform a PATCH on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	patch(com.fasterxml.jackson.databind.JsonNode body) Perform a PATCH on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	patch(java.lang.String body) Perform a PATCH on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	post(java.io.File body) Perform a POST on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	post(java.io.InputStream body) Perform a POST on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	post(com.fasterxml.jackson.databind.JsonNode body) Perform a POST on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	post(java.lang.String body) Perform a POST on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	put(java.io.File body) Perform a PUT on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	put(java.io.InputStream body) Perform a PUT on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	put(com.fasterxml.jackson.databind.JsonNode body) Perform a PUT on the request asynchronously.
java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>	put(java.lang.String body) Perform a PUT on the request asynchronously.
StandaloneAhcWSRequest	setAuth(java.lang.String userInfo) Sets the authentication header for the current request using BASIC authentication.
StandaloneAhcWSRequest	setAuth(java.lang.String username, java.lang.String password) Sets the authentication header for the current request using BASIC authentication.
StandaloneAhcWSRequest	setAuth(java.lang.String username, java.lang.String password, WSAuthScheme scheme) Sets the authentication header for the current request.
StandaloneAhcWSRequest	setBody(java.io.File body) Set the body this request should use.
StandaloneAhcWSRequest	setBody(java.io.InputStream body) Deprecated. use setBody(Source) instead.
StandaloneAhcWSRequest	setBody(com.fasterxml.jackson.databind.JsonNode body) Set the body this request should use.
StandaloneAhcWSRequest	setBody(java.lang.Object body) Sets a body directly.
<U> StandaloneAhcWSRequest	setBody(akka.stream.javadsl.Source<akka.util.ByteString,U> body) Set the body this request should use.
StandaloneAhcWSRequest	setBody(java.lang.String body) Set the body this request should use.
StandaloneAhcWSRequest	setContentType(java.lang.String contentType) Set the content type.
StandaloneAhcWSRequest	setFollowRedirects(boolean followRedirects) Sets whether redirects (301, 302) should be followed automatically.
StandaloneAhcWSRequest	setHeader(java.lang.String name, java.lang.String value) Sets a header with the given name, this can be called repeatedly.
StandaloneAhcWSRequest	setMethod(java.lang.String method) Sets the HTTP method this request should use, where the no args execute() method is invoked.
StandaloneAhcWSRequest	setQueryParameter(java.lang.String name, java.lang.String value) Sets a query parameter with the given name, this can be called repeatedly.
StandaloneAhcWSRequest	setQueryString(java.lang.String query) Sets a query string
StandaloneAhcWSRequest	setRequestFilter(WSRequestFilter filter) Adds a request filter.
StandaloneAhcWSRequest	setRequestTimeout(long timeout) Sets the request timeout in milliseconds.
StandaloneAhcWSRequest	setVirtualHost(java.lang.String virtualHost) Sets the virtual host as a "hostname:port" string.
StandaloneAhcWSRequest	sign(WSSignatureCalculator calculator) Sets an (OAuth) signature calculator.
java.util.concurrent.CompletionStage<? extends StreamedResponse>	stream() Execute this request and stream the response body.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StandaloneAhcWSRequest

public StandaloneAhcWSRequest(StandaloneAhcWSClient client,
                              java.lang.String url,
                              akka.stream.Materializer materializer,
                              com.fasterxml.jackson.databind.ObjectMapper mapper)

StandaloneAhcWSRequest

public StandaloneAhcWSRequest(StandaloneAhcWSClient client,
                              java.lang.String url,
                              akka.stream.Materializer materializer)

Method Detail

setRequestFilter

public StandaloneAhcWSRequest setRequestFilter(WSRequestFilter filter)

Description copied from interface: StandaloneWSRequest

Adds a request filter.

Specified by:

setRequestFilter in interface StandaloneWSRequest

Parameters:

filter - a transforming filter.

Returns:

the modified request.

setHeader

public StandaloneAhcWSRequest setHeader(java.lang.String name,
                                        java.lang.String value)

Sets a header with the given name, this can be called repeatedly.

Specified by:

setHeader in interface StandaloneWSRequest

Parameters:

name - the header name

value - the header value

Returns:

the receiving WSRequest, with the new header set.

setQueryString

public StandaloneAhcWSRequest setQueryString(java.lang.String query)

Sets a query string

Specified by:

setQueryString in interface StandaloneWSRequest

Parameters:

query - the query string

Returns:

the modified WSRequest.

setQueryParameter

public StandaloneAhcWSRequest setQueryParameter(java.lang.String name,
                                                java.lang.String value)

Description copied from interface: StandaloneWSRequest

Sets a query parameter with the given name, this can be called repeatedly. Duplicate query parameters are allowed.

Specified by:

setQueryParameter in interface StandaloneWSRequest

Parameters:

name - the query parameter name

value - the query parameter value

Returns:

the modified WSRequest.

setAuth

public StandaloneAhcWSRequest setAuth(java.lang.String userInfo)

Description copied from interface: StandaloneWSRequest

Sets the authentication header for the current request using BASIC authentication.

Specified by:

setAuth in interface StandaloneWSRequest

Parameters:

userInfo - a string formed as "username:password".

Returns:

the modified WSRequest.

setAuth

public StandaloneAhcWSRequest setAuth(java.lang.String username,
                                      java.lang.String password)

Description copied from interface: StandaloneWSRequest

Sets the authentication header for the current request using BASIC authentication.

Specified by:

setAuth in interface StandaloneWSRequest

Parameters:

username - the basic auth username

password - the basic auth password

Returns:

the modified WSRequest.

setAuth

public StandaloneAhcWSRequest setAuth(java.lang.String username,
                                      java.lang.String password,
                                      WSAuthScheme scheme)

Description copied from interface: StandaloneWSRequest

Sets the authentication header for the current request.

Specified by:

setAuth in interface StandaloneWSRequest

Parameters:

username - the username

password - the password

scheme - authentication scheme

Returns:

the modified WSRequest.

sign

public StandaloneAhcWSRequest sign(WSSignatureCalculator calculator)

Description copied from interface: StandaloneWSRequest

Sets an (OAuth) signature calculator.

Specified by:

sign in interface StandaloneWSRequest

Parameters:

calculator - the signature calculator

Returns:

the modified WSRequest

setFollowRedirects

public StandaloneAhcWSRequest setFollowRedirects(boolean followRedirects)

Description copied from interface: StandaloneWSRequest

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

Specified by:

setFollowRedirects in interface StandaloneWSRequest

Parameters:

followRedirects - true if the request should follow redirects

Returns:

the modified WSRequest

setVirtualHost

public StandaloneAhcWSRequest setVirtualHost(java.lang.String virtualHost)

Description copied from interface: StandaloneWSRequest

Sets the virtual host as a "hostname:port" string.

Specified by:

setVirtualHost in interface StandaloneWSRequest

Parameters:

virtualHost - the virtual host

Returns:

the modified WSRequest

setRequestTimeout

public StandaloneAhcWSRequest setRequestTimeout(long timeout)

Description copied from interface: StandaloneWSRequest

Sets the request timeout in milliseconds.

Specified by:

setRequestTimeout in interface StandaloneWSRequest

Parameters:

timeout - the request timeout in milliseconds. A value of -1 indicates an infinite request timeout.

Returns:

the modified WSRequest.

setContentType

public StandaloneAhcWSRequest setContentType(java.lang.String contentType)

Description copied from interface: StandaloneWSRequest

Set the content type. If the request body is a String, and no charset parameter is included, then it will default to UTF-8.

Specified by:

setContentType in interface StandaloneWSRequest

Parameters:

contentType - The content type

Returns:

the modified WSRequest

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface StandaloneWSRequest

Returns:

the content type, if any, or null.

setMethod

public StandaloneAhcWSRequest setMethod(java.lang.String method)

Description copied from interface: StandaloneWSRequest

Sets the HTTP method this request should use, where the no args execute() method is invoked.

Specified by:

setMethod in interface StandaloneWSRequest

Parameters:

method - the HTTP method.

Returns:

the modified WSRequest.

setBody

public StandaloneAhcWSRequest setBody(java.lang.Object body)

Sets a body directly.

Parameters:

body - the body as an unbound object.

Returns:

the body directly

setBody

public StandaloneAhcWSRequest setBody(java.lang.String body)

Description copied from interface: StandaloneWSRequest

Set the body this request should use.

Specified by:

setBody in interface StandaloneWSRequest

Parameters:

body - the body of the request.

Returns:

the modified WSRequest.

setBody

public StandaloneAhcWSRequest setBody(com.fasterxml.jackson.databind.JsonNode body)

Description copied from interface: StandaloneWSRequest

Set the body this request should use.

Specified by:

setBody in interface StandaloneWSRequest

Parameters:

body - the body of the request.

Returns:

the modified WSRequest.

setBody

@Deprecated
public StandaloneAhcWSRequest setBody(java.io.InputStream body)

Deprecated. use setBody(Source) instead.

Set the body this request should use.

Specified by:

setBody in interface StandaloneWSRequest

Parameters:

body - Deprecated

Returns:

Deprecated

setBody

public StandaloneAhcWSRequest setBody(java.io.File body)

Description copied from interface: StandaloneWSRequest

Set the body this request should use.

Specified by:

setBody in interface StandaloneWSRequest

Parameters:

body - the body of the request.

Returns:

the modified WSRequest.

setBody

public <U> StandaloneAhcWSRequest setBody(akka.stream.javadsl.Source<akka.util.ByteString,U> body)

Description copied from interface: StandaloneWSRequest

Set the body this request should use.

Specified by:

setBody in interface StandaloneWSRequest

Parameters:

body - the body of the request.

Returns:

the modified WSRequest.

getUrl

public java.lang.String getUrl()

Specified by:

getUrl in interface StandaloneWSRequest

Returns:

the URL of the request. This has not passed through an internal request builder and so will not be signed.

getHeaders

public java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getHeaders()

Specified by:

getHeaders in interface StandaloneWSRequest

Returns:

the headers (a copy to prevent side-effects). This has not passed through an internal request builder and so will not be signed.

getQueryParameters

public java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getQueryParameters()

Specified by:

getQueryParameters in interface StandaloneWSRequest

Returns:

the query parameters (a copy to prevent side-effects). This has not passed through an internal request builder and so will not be signed.

getUsername

public java.lang.String getUsername()

Specified by:

getUsername in interface StandaloneWSRequest

Returns:

the auth username, null if not an authenticated request.

getPassword

public java.lang.String getPassword()

Specified by:

getPassword in interface StandaloneWSRequest

Returns:

the auth password, null if not an authenticated request

getScheme

public WSAuthScheme getScheme()

Specified by:

getScheme in interface StandaloneWSRequest

Returns:

the auth scheme, null if not an authenticated request.

getCalculator

public WSSignatureCalculator getCalculator()

Specified by:

getCalculator in interface StandaloneWSRequest

Returns:

the signature calculator (example: OAuth), null if none is set.

getRequestTimeout

public long getRequestTimeout()

Description copied from interface: StandaloneWSRequest

Gets the original request timeout in milliseconds, passed into the request as input.

Specified by:

getRequestTimeout in interface StandaloneWSRequest

Returns:

the timeout

getFollowRedirects

public boolean getFollowRedirects()

Specified by:

getFollowRedirects in interface StandaloneWSRequest

Returns:

true if the request is configure to follow redirect, false if it is configure not to, null if nothing is configured and the global client preference should be used instead.

get

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> get()

Description copied from interface: StandaloneWSRequest

Perform a GET on the request asynchronously.

Specified by:

get in interface StandaloneWSRequest

Returns:

a promise to the response

patch

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> patch(java.lang.String body)

Description copied from interface: StandaloneWSRequest

Perform a PATCH on the request asynchronously.

Specified by:

patch in interface StandaloneWSRequest

Parameters:

body - represented as String

Returns:

a promise to the response

patch

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> patch(com.fasterxml.jackson.databind.JsonNode body)

Description copied from interface: StandaloneWSRequest

Perform a PATCH on the request asynchronously.

Specified by:

patch in interface StandaloneWSRequest

Parameters:

body - represented as JSON

Returns:

a promise to the response

patch

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> patch(java.io.InputStream body)

Description copied from interface: StandaloneWSRequest

Perform a PATCH on the request asynchronously.

Specified by:

patch in interface StandaloneWSRequest

Parameters:

body - represented as an InputStream

Returns:

a promise to the response

patch

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> patch(java.io.File body)

Description copied from interface: StandaloneWSRequest

Perform a PATCH on the request asynchronously.

Specified by:

patch in interface StandaloneWSRequest

Parameters:

body - represented as a File

Returns:

a promise to the response

post

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> post(java.lang.String body)

Description copied from interface: StandaloneWSRequest

Perform a POST on the request asynchronously.

Specified by:

post in interface StandaloneWSRequest

Parameters:

body - represented as String

Returns:

a promise to the response

post

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> post(com.fasterxml.jackson.databind.JsonNode body)

Description copied from interface: StandaloneWSRequest

Perform a POST on the request asynchronously.

Specified by:

post in interface StandaloneWSRequest

Parameters:

body - represented as JSON

Returns:

a promise to the response

post

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> post(java.io.InputStream body)

Description copied from interface: StandaloneWSRequest

Perform a POST on the request asynchronously.

Specified by:

post in interface StandaloneWSRequest

Parameters:

body - represented as an InputStream

Returns:

a promise to the response

post

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> post(java.io.File body)

Description copied from interface: StandaloneWSRequest

Perform a POST on the request asynchronously.

Specified by:

post in interface StandaloneWSRequest

Parameters:

body - represented as a File

Returns:

a promise to the response

put

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> put(java.lang.String body)

Description copied from interface: StandaloneWSRequest

Perform a PUT on the request asynchronously.

Specified by:

put in interface StandaloneWSRequest

Parameters:

body - represented as String

Returns:

a promise to the response

put

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> put(com.fasterxml.jackson.databind.JsonNode body)

Description copied from interface: StandaloneWSRequest

Perform a PUT on the request asynchronously.

Specified by:

put in interface StandaloneWSRequest

Parameters:

body - represented as JSON

Returns:

a promise to the response

put

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> put(java.io.InputStream body)

Description copied from interface: StandaloneWSRequest

Perform a PUT on the request asynchronously.

Specified by:

put in interface StandaloneWSRequest

Parameters:

body - represented as an InputStream

Returns:

a promise to the response

put

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> put(java.io.File body)

Description copied from interface: StandaloneWSRequest

Perform a PUT on the request asynchronously.

Specified by:

put in interface StandaloneWSRequest

Parameters:

body - represented as a File

Returns:

a promise to the response

delete

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> delete()

Description copied from interface: StandaloneWSRequest

Perform a DELETE on the request asynchronously.

Specified by:

delete in interface StandaloneWSRequest

Returns:

a promise to the response

head

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> head()

Description copied from interface: StandaloneWSRequest

Perform a HEAD on the request asynchronously.

Specified by:

head in interface StandaloneWSRequest

Returns:

a promise to the response

options

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> options()

Description copied from interface: StandaloneWSRequest

Perform an OPTIONS on the request asynchronously.

Specified by:

options in interface StandaloneWSRequest

Returns:

a promise to the response

execute

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> execute(java.lang.String method)

Description copied from interface: StandaloneWSRequest

Execute an arbitrary method on the request asynchronously.

Specified by:

execute in interface StandaloneWSRequest

Parameters:

method - The method to execute

Returns:

a promise to the response

execute

public java.util.concurrent.CompletionStage<? extends StandaloneWSResponse> execute()

Description copied from interface: StandaloneWSRequest

Execute an arbitrary method on the request asynchronously. Should be used with setMethod().

Specified by:

execute in interface StandaloneWSRequest

Returns:

a promise to the response

stream

public java.util.concurrent.CompletionStage<? extends StreamedResponse> stream()

Description copied from interface: StandaloneWSRequest

Execute this request and stream the response body.

Specified by:

stream in interface StandaloneWSRequest

Returns:

a promise to the streaming response