com.rallydev.rest.request

Class Request

java.lang.Object

com.rallydev.rest.request.Request

Direct Known Subclasses:

CollectionUpdateRequest, CreateRequest, DeleteRequest, GetRequest, QueryRequest, UpdateRequest

public abstract class Request
extends Object

Base class for all WSAPI requests.

Subclasses classes should provide an implementation of toUrl()

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.gson.GsonBuilder	gsonBuilder Gson Builder used for JSON serialization in this request.

Constructor Summary

Constructors

Constructor and Description
Request() Create a new request.

Method Summary

Modifier and Type	Method and Description
void	addParam(String name, String value) Add the specified parameter to this request.
com.google.gson.GsonBuilder	getGsonBuilder() Get the Gson Builder used for JSON serialization in this request.
List<org.apache.http.NameValuePair>	getParams() Get the list of additional parameters included in this request.
void	setGsonBuilder(com.google.gson.GsonBuilder gsonBuilder) Set the Gson Builder used for JSON serialization in this request.
void	setParams(List<org.apache.http.NameValuePair> params) Set the list of additional parameters included in this request.
abstract String	toUrl() Convert this request into a url compatible with the WSAPI.

Methods inherited from class java.lang.Object

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

Field Detail

gsonBuilder

protected com.google.gson.GsonBuilder gsonBuilder

Gson Builder used for JSON serialization in this request.

Constructor Detail

Request

public Request()

Create a new request.

Method Detail

getParams

public List<org.apache.http.NameValuePair> getParams()

Get the list of additional parameters included in this request.

Returns:

The list of additional parameters

setParams

public void setParams(List<org.apache.http.NameValuePair> params)

Set the list of additional parameters included in this request.

Parameters:

params - The list of additional parameters

addParam

public void addParam(String name,
                     String value)

Add the specified parameter to this request.

Parameters:

name - the parameter name

value - the parameter value

getGsonBuilder

public com.google.gson.GsonBuilder getGsonBuilder()

Get the Gson Builder used for JSON serialization in this request.

Returns:

The Gson Builder used for JSON serialization

setGsonBuilder

public void setGsonBuilder(com.google.gson.GsonBuilder gsonBuilder)

Set the Gson Builder used for JSON serialization in this request.

Parameters:

gsonBuilder - The Gson Builder used for JSON serialization

toUrl

public abstract String toUrl()

Convert this request into a url compatible with the WSAPI.

Must be implemented by subclasses.

Returns:

the url representing this request.