com.sk89q.worldguard.util.net

Class HttpRequest

java.lang.Object

com.sk89q.worldguard.util.net.HttpRequest

All Implemented Interfaces:

Closeable, AutoCloseable

public class HttpRequest
extends Object
implements Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HttpRequest.BufferedResponse Used to buffer the response in memory.
static class	HttpRequest.Form Used with bodyForm(Form).

Method Summary

Modifier and Type	Method and Description
HttpRequest	body(String data) Submit data.
HttpRequest	bodyForm(HttpRequest.Form form) Submit form data.
void	close()
HttpRequest	execute() Execute the request.
HttpRequest	expectResponseCode(int... codes) Require that the response code is one of the given response codes.
static HttpRequest	get(URL url) Perform a GET request.
InputStream	getInputStream() Get the input stream.
int	getResponseCode() Get the response code.
HttpRequest	header(String key, String value) Add a header.
static HttpRequest	post(URL url) Perform a POST request.
static HttpRequest	request(String method, URL url) Perform a request.
HttpRequest.BufferedResponse	returnContent() Buffer the returned response.
HttpRequest	saveContent(File file) Save the result to a file.
HttpRequest	saveContent(OutputStream out) Save the result to an output stream.
static URL	url(String url) Create a new URL and throw a RuntimeException if the URL is not valid.

Methods inherited from class java.lang.Object

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

Method Detail

body

public HttpRequest body(String data)

Submit data.

Returns:

this object

bodyForm

public HttpRequest bodyForm(HttpRequest.Form form)

Submit form data.

Parameters:

form - the form

Returns:

this object

header

public HttpRequest header(String key,
                          String value)

Add a header.

Parameters:

key - the header key

value - the header value

Returns:

this object

execute

public HttpRequest execute()
                    throws IOException

Execute the request.

After execution, close() should be called.

Returns:

this object

Throws:

IOException - on I/O error

expectResponseCode

public HttpRequest expectResponseCode(int... codes)
                               throws IOException

Require that the response code is one of the given response codes.

Parameters:

codes - a list of codes

Returns:

this object

Throws:

IOException - if there is an I/O error or the response code is not expected

getResponseCode

public int getResponseCode()
                    throws IOException

Get the response code.

Returns:

the response code

Throws:

IOException - on I/O error

getInputStream

public InputStream getInputStream()

Get the input stream.

Returns:

the input stream

returnContent

public HttpRequest.BufferedResponse returnContent()
                                           throws IOException,
                                                  InterruptedException

Buffer the returned response.

Returns:

the buffered response

Throws:

IOException - on I/O error

InterruptedException - on interruption

saveContent

public HttpRequest saveContent(File file)
                        throws IOException,
                               InterruptedException

Save the result to a file.

Parameters:

file - the file

Returns:

this object

Throws:

IOException - on I/O error

InterruptedException - on interruption

saveContent

public HttpRequest saveContent(OutputStream out)
                        throws IOException,
                               InterruptedException

Save the result to an output stream.

Parameters:

out - the output stream

Returns:

this object

Throws:

IOException - on I/O error

InterruptedException - on interruption

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

get

public static HttpRequest get(URL url)

Perform a GET request.

Parameters:

url - the URL

Returns:

a new request object

post

public static HttpRequest post(URL url)

Perform a POST request.

Parameters:

url - the URL

Returns:

a new request object

request

public static HttpRequest request(String method,
                                  URL url)

Perform a request.

Parameters:

method - the method

url - the URL

Returns:

a new request object

url

public static URL url(String url)

Create a new URL and throw a RuntimeException if the URL is not valid.

Parameters:

url - the url

Returns:

a URL object

Throws:

RuntimeException - if the URL is invalid