play.libs

Class WS.WSRequestHolder

java.lang.Object

play.libs.WS.WSRequestHolder

Enclosing class:

WS

public static class WS.WSRequestHolder
extends java.lang.Object

provides the User facing API for building WS request.

Constructor Summary

Constructors

Constructor and Description
WS.WSRequestHolder(java.lang.String url)

Method Summary

Methods

Modifier and Type	Method and Description
F.Promise<WS.Response>	delete() Perform a DELETE on the request asynchronously.
F.Promise<WS.Response>	get() Perform a GET on the request asynchronously.
F.Promise<WS.Response>	head() Perform a HEAD on the request asynchronously.
F.Promise<WS.Response>	option() Perform a OPTION on the request asynchronously.
F.Promise<WS.Response>	post(java.io.File body) Perform a POST on the request asynchronously.
F.Promise<WS.Response>	post(java.io.InputStream body) Perform a POST on the request asynchronously.
F.Promise<WS.Response>	post(java.lang.String body) Perform a POST on the request asynchronously.
F.Promise<WS.Response>	put(java.io.File body) Perform a PUT on the request asynchronously.
F.Promise<WS.Response>	put(java.io.InputStream body) Perform a PUT on the request asynchronously.
F.Promise<WS.Response>	put(java.lang.String body) Perform a PUT on the request asynchronously.
WS.WSRequestHolder	setAuth(java.lang.String username, java.lang.String password, com.ning.http.client.Realm.AuthScheme scheme) Sets the authentication header for the current request.
WS.WSRequestHolder	setFollowRedirects(java.lang.Boolean followRedirects) Sets whether redirects (301, 302) should be followed automatically
WS.WSRequestHolder	setHeader(java.lang.String name, java.lang.String value) Sets a header with the given name, this can be called repeatedly
WS.WSRequestHolder	setQueryParameter(java.lang.String name, java.lang.String value) Sets a query parameter with the given name,this can be called repeatedly
WS.WSRequestHolder	setTimeout(int timeout) Sets the request timeout in milliseconds

Methods inherited from class java.lang.Object

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

Constructor Detail

WS.WSRequestHolder

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

Method Detail

setHeader

public WS.WSRequestHolder setHeader(java.lang.String name,
                           java.lang.String value)

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

Parameters:

name -

value -

setQueryParameter

public WS.WSRequestHolder setQueryParameter(java.lang.String name,
                                   java.lang.String value)

Sets a query parameter with the given name,this can be called repeatedly

Parameters:

name -

value -

setAuth

public WS.WSRequestHolder setAuth(java.lang.String username,
                         java.lang.String password,
                         com.ning.http.client.Realm.AuthScheme scheme)

Sets the authentication header for the current request.

Parameters:

username -

password -

scheme - authentication scheme

setFollowRedirects

public WS.WSRequestHolder setFollowRedirects(java.lang.Boolean followRedirects)

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

Parameters:

followRedirect -

setTimeout

public WS.WSRequestHolder setTimeout(int timeout)

Sets the request timeout in milliseconds

Parameters:

timeout -

get

public F.Promise<WS.Response> get()

Perform a GET on the request asynchronously.

post

public F.Promise<WS.Response> post(java.lang.String body)

Perform a POST on the request asynchronously.

Parameters:

body - represented as String

put

public F.Promise<WS.Response> put(java.lang.String body)

Perform a PUT on the request asynchronously.

Parameters:

body - represented as String

post

public F.Promise<WS.Response> post(java.io.InputStream body)

Perform a POST on the request asynchronously.

Parameters:

body - represented as an InputStream

put

public F.Promise<WS.Response> put(java.io.InputStream body)

Perform a PUT on the request asynchronously.

Parameters:

body - represented as an InputStream

post

public F.Promise<WS.Response> post(java.io.File body)

Perform a POST on the request asynchronously.

Parameters:

body - represented as a File

put

public F.Promise<WS.Response> put(java.io.File body)

Perform a PUT on the request asynchronously.

Parameters:

body - represented as a File

delete

public F.Promise<WS.Response> delete()

Perform a DELETE on the request asynchronously.

head

public F.Promise<WS.Response> head()

Perform a HEAD on the request asynchronously.

option

public F.Promise<WS.Response> option()

Perform a OPTION on the request asynchronously.