play.libs.ws

Class WS

java.lang.Object

play.libs.ws.WS

public class WS
extends java.lang.Object

Asynchronous API to to query web services, as an http client. The value returned is a Promise<Response>, and you should use Play's asynchronous mechanisms to use this response.

Constructor Summary

Constructors

Constructor and Description
WS()

Method Summary

Modifier and Type	Method and Description
static WSClient	client()
static WSClient	newClient(int port) Create a new WSClient.
static WSRequestHolder	url(java.lang.String url) Prepare a new request.

Methods inherited from class java.lang.Object

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

Constructor Detail

WS

public WS()

Method Detail

client

public static WSClient client()

url

public static WSRequestHolder url(java.lang.String url)

Prepare a new request. You can then construct it by chaining calls.

Parameters:

url - the URL to request

newClient

public static WSClient newClient(int port)

Create a new WSClient. This client holds on to resources such as connections and threads, and so must be closed after use. If the URL passed into the url method of this client is a host relative absolute path (that is, if it starts with /), then this client will make the request on localhost using the supplied port. This is particularly useful in test situations.

Parameters:

port - The port to use on localhost when relative URLs are requested.

Returns:

A running WS client.