HttpRequest (worldedit-core 7.2.0 API)

java.lang.Object
- com.sk89q.worldedit.util.net.HttpRequest

All Implemented Interfaces:: java.io.Closeable, java.lang.AutoCloseable

public class HttpRequest
extends java.lang.Object
implements java.io.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 `bodyUrlEncodedForm(Form)`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`body(java.lang.String data)` Submit data.
`HttpRequest`	`bodyMultipartForm(HttpRequest.Form form)` Submit form data.
`HttpRequest`	`bodyUrlEncodedForm(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(java.net.URL url)` Perform a GET request.
`java.io.InputStream`	`getInputStream()` Get the input stream.
`int`	`getResponseCode()` Get the response code.
`HttpRequest`	`header(java.lang.String key, java.lang.String value)` Add a header.
`static HttpRequest`	`post(java.net.URL url)` Perform a POST request.
`static HttpRequest`	`request(java.lang.String method, java.net.URL url)` Perform a request.
`HttpRequest.BufferedResponse`	`returnContent()` Buffer the returned response.
`HttpRequest`	`saveContent(java.io.File file)` Save the result to a file.
`HttpRequest`	`saveContent(java.io.OutputStream out)` Save the result to an output stream.
`static java.net.URL`	`url(java.lang.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(java.lang.String data)
```
    Submit data.
    
    Returns:
    
    this object
  - bodyUrlEncodedForm
```
public HttpRequest bodyUrlEncodedForm(HttpRequest.Form form)
```
    Submit form data.
    
    Parameters:
    
    form - the form
    
    Returns:
    
    this object
  - bodyMultipartForm
```
public HttpRequest bodyMultipartForm(HttpRequest.Form form)
```
    Submit form data.
    
    Parameters:
    
    form - the form
    
    Returns:
    
    this object
  - header
```
public HttpRequest header(java.lang.String key,
                          java.lang.String value)
```
    Add a header.
    
    Parameters:
    
    key - the header key
    
    value - the header value
    
    Returns:
    
    this object
  - execute
```
public HttpRequest execute()
                    throws java.io.IOException
```
    Execute the request.
    After execution, close() should be called.
    
    Returns:
    
    this object
    
    Throws:
    
    java.io.IOException - on I/O error
  - expectResponseCode
```
public HttpRequest expectResponseCode(int... codes)
                               throws java.io.IOException
```
    Require that the response code is one of the given response codes.
    
    Parameters:
    
    codes - a list of codes
    
    Returns:
    
    this object
    
    Throws:
    
    java.io.IOException - if there is an I/O error or the response code is not expected
  - getResponseCode
```
public int getResponseCode()
                    throws java.io.IOException
```
    Get the response code.
    
    Returns:
    
    the response code
    
    Throws:
    
    java.io.IOException - on I/O error
  - getInputStream
```
public java.io.InputStream getInputStream()
```
    Get the input stream.
    
    Returns:
    
    the input stream
  - returnContent
```
public HttpRequest.BufferedResponse returnContent()
                                           throws java.io.IOException,
                                                  java.lang.InterruptedException
```
    Buffer the returned response.
    
    Returns:
    
    the buffered response
    
    Throws:
    
    java.io.IOException - on I/O error
    
    java.lang.InterruptedException - on interruption
  - saveContent
```
public HttpRequest saveContent(java.io.File file)
                        throws java.io.IOException,
                               java.lang.InterruptedException
```
    Save the result to a file.
    
    Parameters:
    
    file - the file
    
    Returns:
    
    this object
    
    Throws:
    
    java.io.IOException - on I/O error
    
    java.lang.InterruptedException - on interruption
  - saveContent
```
public HttpRequest saveContent(java.io.OutputStream out)
                        throws java.io.IOException,
                               java.lang.InterruptedException
```
    Save the result to an output stream.
    
    Parameters:
    
    out - the output stream
    
    Returns:
    
    this object
    
    Throws:
    
    java.io.IOException - on I/O error
    
    java.lang.InterruptedException - on interruption
  - close
```
public void close()
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
  - get
```
public static HttpRequest get(java.net.URL url)
```
    Perform a GET request.
    
    Parameters:
    
    url - the URL
    
    Returns:
    
    a new request object
  - post
```
public static HttpRequest post(java.net.URL url)
```
    Perform a POST request.
    
    Parameters:
    
    url - the URL
    
    Returns:
    
    a new request object
  - request
```
public static HttpRequest request(java.lang.String method,
                                  java.net.URL url)
```
    Perform a request.
    
    Parameters:
    
    method - the method
    
    url - the URL
    
    Returns:
    
    a new request object
  - url
```
public static java.net.URL url(java.lang.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:
    
    java.lang.RuntimeException - if the URL is invalid

Class HttpRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

body

bodyUrlEncodedForm

bodyMultipartForm

header

execute

expectResponseCode

getResponseCode

getInputStream

returnContent

saveContent

saveContent

close

get

post

request

url