play.libs.ws

Interface StandaloneWSClient

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

StandaloneAhcWSClient

public interface StandaloneWSClient
extends java.io.Closeable

This is the WS Client interface.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this client, and releases underlying resources.
java.lang.Object	getUnderlying() The underlying implementation of the client, if any.
StandaloneWSRequest	url(java.lang.String url) Returns a StandaloneWSRequest object representing the URL.

Method Detail

getUnderlying

java.lang.Object getUnderlying()

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

Returns:

the backing class.

url

StandaloneWSRequest url(java.lang.String url)

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>.

Parameters:

url - the URL to request

Returns:

the request

close

void close()
    throws java.io.IOException

Closes this client, and releases underlying resources.

Use this for manually instantiated clients.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException