net.wildfyre.http

Class Request

java.lang.Object

net.wildfyre.http.Request

public class Request
extends java.lang.Object

Wrapper around the HTTP requests.

This class is NOT part of the public API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Request.CantConnectException Thrown when the request failed because the requested could not connect to the server.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHARSET

Constructor Summary

Constructors

Constructor and Description
Request(Method method, java.lang.String address) Creates a new request to the server, and starts to execute it.

Method Summary

Modifier and Type	Method and Description
Request	addJson(com.eclipsesource.json.JsonValue params) Adds JSON parameters to this request.
Request	addToken(java.lang.String token) Makes the request authenticated by adding the token of the user.
com.eclipsesource.json.JsonValue	get() Accesses the JSON response from the server.

Methods inherited from class java.lang.Object

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

Field Detail

CHARSET

public static final java.lang.String CHARSET

See Also:

Constant Field Values

Constructor Detail

Request

public Request(Method method,
               java.lang.String address)
        throws Request.CantConnectException

Creates a new request to the server, and starts to execute it.

Parameters:

method - the HTTP method required by the API

address - the address you'd like to access (see the API documentation)

Throws:

Request.CantConnectException - if the connection to the server fails

Method Detail

addToken

public Request addToken(java.lang.String token)

Makes the request authenticated by adding the token of the user.

Parameters:

token - the token

Returns:

This request itself, to allow method-chaining.

addJson

public Request addJson(com.eclipsesource.json.JsonValue params)
                throws Request.CantConnectException

Adds JSON parameters to this request.

Parameters:

params - the parameters

Returns:

This request itself, to allow method-chaining.

Throws:

Request.CantConnectException - if the lib cannot connect to the server

get

public com.eclipsesource.json.JsonValue get()
                                     throws IssueInTransferException

Accesses the JSON response from the server.

Returns:

The JSON response from the server.

Throws:

IssueInTransferException - if there is problem with the connection or the data