doc.com.rallydev.rest.request.Request.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rally-rest-api Show documentation

A java toolkit for interacting with the Rally Rest API

The newest version!






Request (Rally Rest API for Java 2.2)













Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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()











Constructor Summary

Constructors 

Constructor and Description


Request()
Create a new request.










Method Summary

Methods 

Modifier and Type
Method and Description


void
addParam(String name,
        String value)
Add the specified parameter to this request.



GsonBuilder
getGsonBuilder()
Get the Gson Builder used for JSON serialization in this request.



List<NameValuePair>
getParams()
Get the list of additional parameters included in this request.



void
setGsonBuilder(GsonBuilder gsonBuilder)
Set the Gson Builder used for JSON serialization in this request.



void
setParams(List<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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Request
public Request()
Create a new request.









Method Detail





getParams
public List<NameValuePair> getParams()
Get the list of additional parameters included in this request.
Returns:
The list of additional parameters







setParams
public void setParams(List<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 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(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.
















Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method

Modifier and Type	Method and Description
`void`	`addParam(String name, String value)` Add the specified parameter to this request.
`GsonBuilder`	`getGsonBuilder()` Get the Gson Builder used for JSON serialization in this request.
`List<NameValuePair>`	`getParams()` Get the list of additional parameters included in this request.
`void`	`setGsonBuilder(GsonBuilder gsonBuilder)` Set the Gson Builder used for JSON serialization in this request.
`void`	`setParams(List<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.