play.libs.ws.ahc

Class StandaloneAhcWSClient

java.lang.Object

play.libs.ws.ahc.StandaloneAhcWSClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, StandaloneWSClient

public class StandaloneAhcWSClient
extends java.lang.Object
implements StandaloneWSClient

A WS asyncHttpClient backed by an AsyncHttpClient instance.

Constructor Summary

Constructors

Constructor and Description
StandaloneAhcWSClient(play.shaded.ahc.org.asynchttpclient.AsyncHttpClient asyncHttpClient, akka.stream.Materializer materializer) Creates a new client with the default Jackson ObjectMapper.
StandaloneAhcWSClient(play.shaded.ahc.org.asynchttpclient.AsyncHttpClient asyncHttpClient, akka.stream.Materializer materializer, com.fasterxml.jackson.databind.ObjectMapper mapper) Creates a new client.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this client, and releases underlying resources.
static StandaloneAhcWSClient	create(play.api.libs.ws.ahc.AhcWSClientConfig ahcWSClientConfig, javax.cache.Cache<play.api.libs.ws.ahc.cache.EffectiveURIKey,play.api.libs.ws.ahc.cache.ResponseEntry> cache, akka.stream.Materializer materializer) A convenience method for creating a StandaloneAhcWSClient from configuration.
java.lang.Object	getUnderlying() The underlying implementation of the client, if any.
StandaloneAhcWSRequest	url(java.lang.String url) Returns a StandaloneWSRequest object representing the URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandaloneAhcWSClient

@Inject
public StandaloneAhcWSClient(play.shaded.ahc.org.asynchttpclient.AsyncHttpClient asyncHttpClient,
                                     akka.stream.Materializer materializer,
                                     com.fasterxml.jackson.databind.ObjectMapper mapper)

Creates a new client.

Parameters:

asyncHttpClient - the underlying AsyncHttpClient

materializer - the Materializer to use for streams

mapper - the ObjectMapper to use for serializing JSON objects

StandaloneAhcWSClient

public StandaloneAhcWSClient(play.shaded.ahc.org.asynchttpclient.AsyncHttpClient asyncHttpClient,
                             akka.stream.Materializer materializer)

Creates a new client with the default Jackson ObjectMapper.

Parameters:

asyncHttpClient - the underlying AsyncHttpClient

materializer - the Materializer to use for streams

Method Detail

getUnderlying

public java.lang.Object getUnderlying()

Description copied from interface: StandaloneWSClient

The underlying implementation of the client, if any. You must cast the returned value to the type you want.

Specified by:

getUnderlying in interface StandaloneWSClient

Returns:

the backing class.

url

public StandaloneAhcWSRequest url(java.lang.String url)

Description copied from interface: StandaloneWSClient

Returns a StandaloneWSRequest object representing the URL. You can append additional properties on the StandaloneWSRequest by chaining calls, and execute the request to return an asynchronous CompletionStage<StandaloneWSResponse>.

Specified by:

url in interface StandaloneWSClient

Parameters:

url - the URL to request

Returns:

the request

close

public void close()
           throws java.io.IOException

Description copied from interface: StandaloneWSClient

Closes this client, and releases underlying resources.

Use this for manually instantiated clients.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface StandaloneWSClient

Throws:

java.io.IOException

create

public static StandaloneAhcWSClient create(play.api.libs.ws.ahc.AhcWSClientConfig ahcWSClientConfig,
                                           javax.cache.Cache<play.api.libs.ws.ahc.cache.EffectiveURIKey,play.api.libs.ws.ahc.cache.ResponseEntry> cache,
                                           akka.stream.Materializer materializer)

A convenience method for creating a StandaloneAhcWSClient from configuration.

Parameters:

ahcWSClientConfig - the configuration object

cache - if not null, will be used for HTTP response caching.

materializer - an akka materializer

Returns:

a fully configured StandaloneAhcWSClient instance.