play.libs.ws

Interface WSClient

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

AhcWSClient

public interface WSClient
extends java.io.Closeable

This is the WS Client interface for Java. Most of the time you will access this through dependency injection, i.e.

 import javax.inject.Inject;
 import play.libs.ws.*;
 import java.util.concurrent.CompletionStage;

 public class MyService {
    @Inject WSClient ws;

    // ...
 }
 
 

Please see https://www.playframework.com/documentation/latest/JavaWS for more details.

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.
WSRequest	url(java.lang.String url) Returns a WSRequest 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

WSRequest url(java.lang.String url)

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

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