diff --git a/.gitignore b/.gitignore index 9a5d438..c745262 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ out/ .DS_Store -RallyRestApiJava.iws /target - .idea +*.iws diff --git a/README.md b/README.md index 6e118c5..7194c58 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ## License -Copyright (c) 2002-2013 Rally Software Development Corp. All Rights Reserved. Your use of this Software is governed by the terms and conditions of the applicable Subscription Agreement between your company and Rally Software Development Corp. +Copyright (c) Rally Software Development Corp. 2013 Distributed under the MIT License. ## Warranty @@ -8,471 +8,21 @@ The Java Toolkit for Rally REST API is available on an as-is basis. ## Support -Rally Software does not actively maintain this toolkit. If you have a question or problem, we recommend posting it to Stack Overflow: http://stackoverflow.com/questions/ask?tags=rally +Rally Software does not actively maintain or support this toolkit. If you have a question or problem, we recommend posting it to Stack Overflow: http://stackoverflow.com/questions/ask?tags=rally -##Introduction +## Download -The Java Toolkit for Rally REST API provides an intuitive Java API for accessing your Rally Data. +[Download REST API jar and dependencies](https://github.com/RallyTools/RallyRestToolkitForJava/wiki/User-Guide#setup) -It provides a rich set of capabilities for querying, along with methods for creating, reading, updating, and deleting individual items. +## User Guide -[Java 7 Download](http://people.rallydev.com/connector/RallyRestApiJava/1.0.7/java7/rally-rest-api-1.0.7.jar) +Please view the [Java Toolkit for Rally REST API User Guide](https://github.com/RallyTools/RallyRestToolkitForJava/wiki/User-Guide) in the attached wiki -[Java 6 Download](http://people.rallydev.com/connector/RallyRestApiJava/1.0.7/java6/rally-rest-api-1.0.7.jar) - -[Full API documentation](https://docs.rallydev.com/javarestapi/index.html) +[Java Toolkit for Rally REST API javadocs](http://rallytools.github.io/RallyRestToolkitForJava/) [Web Services API documentation](https://rally1.rallydev.com/slm/doc/webservice) -## Setup - -Create a new Java project in your favorite IDE. - -#### Manual -Add rally-rest-api-2.0.2.jar appropriate to your version of JDK to your classpath. - -You will also need to add the following jars: - -* httpcore-4.2.1.jar -* httpclient-4.2.1.jar -* httpclient-cache-4.2.1.jar -* commons-logging-1.1.1.jar -* commons-codec-1.6.jar -* gson-2.1.jar - -All the jars except gson-2.1.jar can be found in [httpcomponents-client-4.2.1-bin.zip](http://archive.apache.org/dist/httpcomponents/httpclient/binary/httpcomponents-client-4.2.1-bin.zip) in the archives for the Apache httpcomponents project. - -The gson-2.1.jar file can be found in [google-gson-2.1-release.zip](http://google-gson.googlecode.com/files/google-gson-2.1-release.zip) on Google Code. - -#### Managed (Maven) -Add the rally-rest-api dependency to your pom.xml - -```xml - - com.rallydev.rest - rally-rest-api - 2.0.2 - -``` - -## Usage - -In your main method, instantiate a new [RallyRestApi](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html): - -RallyRestApi restApi = new RallyRestApi(new URI("https://rally1.rallydev.com"), "user@company.com", "password"); - - -

The parameters for [RallyRestApi](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html) are as follows: - - - - - - - - - - - - - - - - - - - - - - -
ParameterDescriptionExample
server*The Rally server to connect to."https://rally1.rallydev.com"
userName*The username to connect to Rally with."user@company.com"
password*The password to connect to Rally with."password"
-  * = required parameter - -## Public Methods - -[RallyRestApi](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html) exposes the following public methods: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Method NameParametersDescription
[create](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html#create(com.rallydev.rest.request.CreateRequest))[CreateRequest](https://docs.rallydev.com/javarestapi/com/rallydev/rest/request/CreateRequest.html) request*Create the object described by the request parameter. Returns a [CreateResponse](https://docs.rallydev.com/javarestapi/com/rallydev/rest/response/CreateResponse.html) object containing the results of the request.
**Example:** - - JsonObject newDefect = new JsonObject(); - newDefect.addProperty("Name", "Test Defect"); - CreateRequest createRequest = new CreateRequest("defect", newDefect); - CreateResponse createResponse = restApi.create(createRequest); - -
[get](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html#get(com.rallydev.rest.request.GetRequest))[GetRequest](https://docs.rallydev.com/javarestapi/com/rallydev/rest/request/GetRequest.html) request*Retrieve the object described by the request parameter. Returns a [GetResponse](https://docs.rallydev.com/javarestapi/com/rallydev/rest/response/GetResponse.html) object containing the results of the request.
**Example:** - - GetRequest getRequest = new GetRequest("/defect/1234.js"); - GetResponse getResponse = restApi.get(getRequest); - -
[update](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html#update(com.rallydev.rest.request.UpdateRequest))[UpdateRequest](https://docs.rallydev.com/javarestapi/com/rallydev/rest/request/UpdateRequest.html) request*Update the object described by the request parameter. Returns a [UpdateResponse](https://docs.rallydev.com/javarestapi/com/rallydev/rest/response/UpdateResponse.html) object containing the results of the request.
**Example:** - - JsonObject updatedDefect = new JsonObject(); - updatedDefect.addProperty("State", "Fixed"); - UpdateRequest updateRequest = new UpdateRequest("/defect/1234.js", updatedDefect); - UpdateResponse updateResponse = restApi.update(updateRequest); - -
[delete](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html#delete(com.rallydev.rest.request.DeleteRequest))[DeleteRequest](https://docs.rallydev.com/javarestapi/com/rallydev/rest/request/DeleteRequest.html) request*Delete the object described by the request parameter. Returns a [DeleteResponse](https://docs.rallydev.com/javarestapi/com/rallydev/rest/response/DeleteResponse.html) object containing the results of the request.
**Example:** - - DeleteRequest deleteRequest = new DeleteRequest("/defect/1234.js"); - DeleteResponse deleteResponse = restApi.delete(deleteRequest); - -
[query](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html#query(com.rallydev.rest.request.QueryRequest))[QueryRequest](https://docs.rallydev.com/javarestapi/com/rallydev/rest/request/QueryRequest.html) request*Query for objects matching the specified request. By default one page of data will be returned. Paging will automatically be performed if a limit is set on the request. Returns a [QueryResponse](https://docs.rallydev.com/javarestapi/com/rallydev/rest/response/QueryResponse.html) object containing the results of the request.
**Example:** - - QueryRequest defectRequest = new QueryRequest("defect"); - - defectRequest.setFetch(new Fetch("FormattedID", "Name", "State", "Priority")); - defectRequest.setQueryFilter(new QueryFilter("State", "=", "Fixed").and(new QueryFilter("Priority", "=", "Resolve Immediately"))); - defectRequest.setOrder("Priority ASC,FormattedID ASC"); - - defectRequest.setPageSize(25); - defectRequest.setLimit(100); - - QueryResponse queryResponse = restApi.query(defectRequest); - -
[setWsapiVersion](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html#setWsapiVersion(java.lang.String))String wsapiVersion*Specifies the version of Rally's web services API to use. Defaults to 1.33
**Example:** - - restApi.setWsapiVersion("1.29"); - -
[getWsapiVersion](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html#getWsapiVersion()) Gets the version of Rally's web services that the Toolkit is configured to use.
**Example:** - - String version = restApi.getWsapiVersion(); - -
[setApplicationName](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html#setApplicationName(java.lang.String))String name*Set the name of your application. This name can be whatever you wish, and is added to the request headers of any web service requests your application makes. We encourage you to set this value, as it helps track usage of the toolkit.
**Example:** - - restApi.setApplicationName("Universal Rally Data Extractor"); - -
[setApplicationVersion](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html#setApplicationVersion(java.lang.String))String version*Set the version of the application using the Java Toolkit. This version can be whatever you wish, and is added to the request headers of any web service requests your application makes.
**Example:** - - restApi.setApplicationVersion("1.1"); - -
[setApplicationVendor](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html#setApplicationVendor(java.lang.String)l)String vendor*Set the vendor of the application using the Java Toolkit. This name can be whatever you wish (usually your company name), and is added to the request headers of any web service requests your application makes.
**Example:** - - restApi.setApplicationVendor("My Company, Inc."); - -
[setProxy](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html#setProxy(java.net.URI))java.net.URI proxy* -String userName -String passwordSet the proxy server to use, if you connect to Rally through a proxy server. By default, no proxy is configured. The userName and password parameters are optional, and are used if your proxy server requires authentication.
**Example:** - - restApi.setProxy(new URI("http://myproxy.mycompany.com"), "MyProxyUsername", "MyProxyPassword"); - -
[close](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html#close()) Closes open connections and releases resources. You should always call this method before your application exits.
**Example:** - - restApi.close(); - -
- -  * = required parameter - -## Examples - -The following code illustrates how to create, read, update, and delete a defect using the [RallyRestApi](https://docs.rallydev.com/javarestapi/com/rallydev/rest/RallyRestApi.html) object. -``` - -import com.google.gson.JsonObject; -import com.rallydev.rest.RallyRestApi; -import com.rallydev.rest.request.CreateRequest; -import com.rallydev.rest.request.DeleteRequest; -import com.rallydev.rest.request.GetRequest; -import com.rallydev.rest.request.UpdateRequest; -import com.rallydev.rest.response.CreateResponse; -import com.rallydev.rest.response.DeleteResponse; -import com.rallydev.rest.response.GetResponse; -import com.rallydev.rest.response.UpdateResponse; -import com.rallydev.rest.util.Ref; - -import java.io.IOException; -import java.net.URI; -import java.net.URISyntaxException; - -public class CrudExample { - - public static void main(String[] args) throws URISyntaxException, IOException { - - //Create and configure a new instance of RallyRestApi - RallyRestApi restApi = new RallyRestApi(new URI("https://rally1.rallydev.com"), "user@company.com", "password"); - restApi.setApplicationName("CrudExample"); - - try { - - //Create a defect - System.out.println("Creating defect..."); - JsonObject newDefect = new JsonObject(); - newDefect.addProperty("Name", "Test Defect"); - CreateRequest createRequest = new CreateRequest("defect", newDefect); - CreateResponse createResponse = restApi.create(createRequest); - System.out.println(String.format("Created %s", createResponse.getObject().get("_ref").getAsString())); - - //Read defect - String ref = Ref.getRelativeRef(createResponse.getObject().get("_ref").getAsString()); - System.out.println(String.format("\nReading defect %s...", ref)); - GetRequest getRequest = new GetRequest(ref); - GetResponse getResponse = restApi.get(getRequest); - JsonObject obj = getResponse.getObject(); - System.out.println(String.format("Read defect. Name = %s, State = %s", - obj.get("Name").getAsString(), obj.get("State").getAsString())); - - //Update defect - System.out.println("\nUpdating defect state..."); - JsonObject updatedDefect = new JsonObject(); - updatedDefect.addProperty("State", "Fixed"); - UpdateRequest updateRequest = new UpdateRequest(ref, updatedDefect); - UpdateResponse updateResponse = restApi.update(updateRequest); - obj = updateResponse.getObject(); - System.out.println(String.format("Updated defect. State = %s", obj.get("State").getAsString())); - - //Delete defect - System.out.println("\nDeleting defect..."); - DeleteRequest deleteRequest = new DeleteRequest(ref); - DeleteResponse deleteResponse = restApi.delete(deleteRequest); - if (deleteResponse.wasSuccessful()) { - System.out.println("Deleted defect."); - } - - } finally { - //Release all resources - restApi.close(); - } - } -} - -``` - -The following code illustrates how to query for the top 5 highest priority defects: -``` - -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.rallydev.rest.RallyRestApi; -import com.rallydev.rest.request.QueryRequest; -import com.rallydev.rest.response.QueryResponse; -import com.rallydev.rest.util.Fetch; -import com.rallydev.rest.util.QueryFilter; - -import java.io.IOException; -import java.net.URI; -import java.net.URISyntaxException; - -public class QueryExample { - - public static void main(String[] args) throws URISyntaxException, IOException { - - //Create and configure a new instance of RallyRestApi - RallyRestApi restApi = new RallyRestApi(new URI("https://rally1.rallydev.com"), "user@company.com", "password"); - restApi.setApplicationName("QueryExample"); - - try { - - System.out.println("Querying for top 5 highest priority unfixed defects..."); - - QueryRequest defects = new QueryRequest("defect"); - - defects.setFetch(new Fetch("FormattedID", "Name", "State", "Priority")); - defects.setQueryFilter(new QueryFilter("State", "<", "Fixed")); - defects.setOrder("Priority ASC,FormattedID ASC"); - - //Return up to 5, 1 per page - defects.setPageSize(1); - defects.setLimit(5); - - QueryResponse queryResponse = restApi.query(defects); - if (queryResponse.wasSuccessful()) { - System.out.println(String.format("\nTotal results: %d", queryResponse.getTotalResultCount())); - System.out.println("Top 5:"); - for (JsonElement result : queryResponse.getResults()) { - JsonObject defect = result.getAsJsonObject(); - System.out.println(String.format("\t%s - %s: Priority=%s, State=%s", - defect.get("FormattedID").getAsString(), - defect.get("Name").getAsString(), - defect.get("Priority").getAsString(), - defect.get("State").getAsString())); - } - } else { - System.err.println("The following errors occurred: "); - for (String err : queryResponse.getErrors()) { - System.err.println("\t" + err); - } - } - - } finally { - //Release resources - restApi.close(); - } - } -} - -``` - -## Development -### Releasing to Maven central -#### One-time Setup -* Install Maven 3 -* Install gpg to sign the artifacts - -```bash -brew install gpg -``` -* Get a copy of the the gpg key pair archive from Matt Cholick, Kyle Morse, or Charles Ferentchak -* Place the contents of the key pair archive in ~/.gnupg -* Add login login information to Sonatype's repository to your ~/.m2/settings.xml (again getting the credentials from Matt, Kyle, or Charles) - -```xml - - - - sonatype-nexus-snapshots - user - password - - - sonatype-nexus-staging - user - password - - - -``` -#### Releasing to Sonatype OSS (central) -This is a stripped down version of a much, much longer guide https://docs.sonatype.org/display/Repository/Sonatype+OSS+Maven+Repository+Usage+Guide - -* Prepare the release (create tag & update pom) - -```bash -mvn release:clean -mvn release:prepare -``` -* Release! - -```bash -mvn release:perform -``` +[Examples](https://github.com/RallyCommunity/rally-java-rest-apps) -Finally, draft a Github release from the tag created by Maven. \ No newline at end of file +## Developer Guide +Please view the [Developer Guide](https://github.com/RallyTools/RallyRestToolkitForJava/wiki/Developer-Guide) in the attached wiki diff --git a/RallyRestToolkitForJava.iml b/RallyRestToolkitForJava.iml new file mode 100644 index 0000000..f6c27af --- /dev/null +++ b/RallyRestToolkitForJava.iml @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/RallyRestToolkitForJava.ipr b/RallyRestToolkitForJava.ipr new file mode 100644 index 0000000..9034498 --- /dev/null +++ b/RallyRestToolkitForJava.ipr @@ -0,0 +1,793 @@ + + + + + $PROJECT_DIR$/out/artifacts/rally_rest_api_2_2.1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/pom.xml b/pom.xml index 23e0e50..8ec9fc6 100644 --- a/pom.xml +++ b/pom.xml @@ -1,6 +1,10 @@ 4.0.0 + + 8 + 8 + org.sonatype.oss oss-parent @@ -10,7 +14,7 @@ Rally Rest Toolkit For Java com.rallydev.rest rally-rest-api - 2.0.3-SNAPSHOT + 2.3.0 A java toolkit for interacting with the Rally Rest API @@ -23,13 +27,6 @@ - - - krmorse - Kyle Morse - - - scm:git:git@github.com:RallyTools/RallyRestToolkitForJava.git scm:git:git@github.com:RallyTools/RallyRestToolkitForJava.git @@ -77,7 +74,7 @@ org.sonatype.plugins nexus-staging-maven-plugin - 1.4.4 + 1.6.2 true sonatype-nexus-staging @@ -92,12 +89,12 @@ org.apache.httpcomponents httpclient - 4.2.5 + 4.5.14 com.google.code.gson gson - 2.1 + 2.8.9 org.testng diff --git a/src/main/java/META-INF/MANIFEST.MF b/src/main/java/META-INF/MANIFEST.MF index 04c03eb..e2ce639 100644 --- a/src/main/java/META-INF/MANIFEST.MF +++ b/src/main/java/META-INF/MANIFEST.MF @@ -1,9 +1,9 @@ Manifest-Version: "1.2" Implementation-Vendor: "Rally Software, Inc." -Implementation-Title: "com.rallydev.rest" -Implementation-Version: "2.0" +Implementation-Title: "com.rallydev.rest" +Implementation-Version: "2.2.1" Class-Path: "httpcore-4.2.4.jar httpclient-4.2.5.jar commons-logging-1.1.1.jar commons-codec-1.6.jar gson-2.2.4.jar" Specification-Vendor: "Rally Software, Inc." Name: "com/rallydev/rest/" -Specification-Title: "Rally Rest API for Java" -Specification-Version: "2.0" +Specification-Title: "Rally Rest API for Java" +Specification-Version: "2.2.1" diff --git a/src/main/java/com/rallydev/rest/RallyRestApi.java b/src/main/java/com/rallydev/rest/RallyRestApi.java index 1b4d87d..6a0eaa8 100644 --- a/src/main/java/com/rallydev/rest/RallyRestApi.java +++ b/src/main/java/com/rallydev/rest/RallyRestApi.java @@ -1,43 +1,15 @@ package com.rallydev.rest; import com.google.gson.JsonArray; -import com.google.gson.JsonObject; -import com.google.gson.JsonPrimitive; -import com.rallydev.rest.request.CreateRequest; -import com.rallydev.rest.request.DeleteRequest; -import com.rallydev.rest.request.GetRequest; -import com.rallydev.rest.request.QueryRequest; -import com.rallydev.rest.request.UpdateRequest; -import com.rallydev.rest.response.CreateResponse; -import com.rallydev.rest.response.DeleteResponse; -import com.rallydev.rest.response.GetResponse; -import com.rallydev.rest.response.QueryResponse; -import com.rallydev.rest.response.UpdateResponse; -import com.rallydev.rest.util.InvalidURLException; -import org.apache.http.HttpEntity; -import org.apache.http.HttpHost; -import org.apache.http.HttpResponse; -import org.apache.http.auth.AuthScope; -import org.apache.http.auth.UsernamePasswordCredentials; -import org.apache.http.client.methods.HttpDelete; -import org.apache.http.client.methods.HttpGet; -import org.apache.http.client.methods.HttpPost; -import org.apache.http.client.methods.HttpPut; -import org.apache.http.client.methods.HttpRequestBase; -import org.apache.http.client.utils.URIBuilder; -import org.apache.http.conn.BasicManagedEntity; -import org.apache.http.conn.params.ConnRoutePNames; -import org.apache.http.entity.StringEntity; -import org.apache.http.impl.auth.BasicScheme; -import org.apache.http.impl.client.DefaultHttpClient; -import org.apache.http.util.EntityUtils; +import com.rallydev.rest.client.ApiKeyClient; +import com.rallydev.rest.client.BasicAuthClient; +import com.rallydev.rest.client.HttpClient; +import com.rallydev.rest.request.*; +import com.rallydev.rest.response.*; import java.io.Closeable; import java.io.IOException; import java.net.URI; -import java.net.URISyntaxException; -import java.util.HashMap; -import java.util.Map; /** *

The main interface to the Rest API.

@@ -45,42 +17,7 @@ */ public class RallyRestApi implements Closeable { - private enum Header { - Library, - Name, - Vendor, - Version - } - - /** - * The default version of the WSAPI to target. - */ - public static final String DEFAULT_WSAPI_VERSION = "v2.0"; - public static final String CREATE_RESULT_KEY = "CreateResult"; - public static final String OPERATION_RESULT_KEY = "OperationResult"; - public static final String QUERY_RESULT_KEY = "QueryResult"; - - protected static final String SECURITY_ENDPOINT_DOES_NOT_EXIST = "SECURITY_ENDPOINT_DOES_NOT_EXIST"; - protected static final String SECURITY_TOKEN_PARAM_KEY = "key"; - private static final String SECURITY_TOKEN_URL = "/security/authorize"; - protected static final String SECURITY_TOKEN_KEY = "SecurityToken"; - - protected URI server; - protected URI proxy; - - protected String wsapiVersion = DEFAULT_WSAPI_VERSION; - protected DefaultHttpClient httpClient; - private UsernamePasswordCredentials usernamePasswordCredentials; - private String securityToken; - - protected Map headers = new HashMap() { - { - put(Header.Library, "Rally Rest API for Java v2.0"); - put(Header.Name, "Rally Rest API for Java"); - put(Header.Vendor, "Rally Software, Inc."); - put(Header.Version, "2.0"); - } - }; + protected HttpClient client; /** * Creates a new instance for the specified server using the specified credentials. @@ -88,11 +25,24 @@ private enum Header { * @param server The server to connect to, e.g. {@code new URI("https://rally1.rallydev.com")} * @param userName The username to be used for authentication. * @param password The password to be used for authentication. + * @deprecated Use the api key constructor instead. */ public RallyRestApi(URI server, String userName, String password) { - this.server = server; - httpClient = new DefaultHttpClient(); - setClientCredentials(server, userName, password); + this(new BasicAuthClient(server, userName, password)); + } + + /** + * Creates a new instance for the specified server using the specified API Key. + * + * @param server The server to connect to, e.g. {@code new URI("https://rally1.rallydev.com")} + * @param apiKey The API Key to be used for authentication. + */ + public RallyRestApi(URI server, String apiKey) { + this(new ApiKeyClient(server, apiKey)); + } + + protected RallyRestApi(HttpClient httpClient) { + this.client = httpClient; } /** @@ -101,8 +51,7 @@ public RallyRestApi(URI server, String userName, String password) { * @param proxy The proxy server, e.g. {@code new URI("http://my.proxy.com:8000")} */ public void setProxy(URI proxy) { - this.proxy = proxy; - httpClient.getParams().setParameter(ConnRoutePNames.DEFAULT_PROXY, new HttpHost(proxy.getHost(), proxy.getPort(), proxy.getScheme())); + client.setProxy(proxy); } /** @@ -113,15 +62,7 @@ public void setProxy(URI proxy) { * @param password The password to be used for authentication. */ public void setProxy(URI proxy, String userName, String password) { - setProxy(proxy); - setClientCredentials(proxy, userName, password); - } - - private void setClientCredentials(URI server, String userName, String password) { - usernamePasswordCredentials = new UsernamePasswordCredentials(userName, password); - httpClient.getCredentialsProvider().setCredentials( - new AuthScope(server.getHost(), server.getPort()), - usernamePasswordCredentials); + client.setProxy(proxy, userName, password); } /** @@ -131,7 +72,7 @@ private void setClientCredentials(URI server, String userName, String password) * @param value The vendor header to be included on all requests. */ public void setApplicationVendor(String value) { - headers.put(Header.Vendor, value); + client.setApplicationVendor(value); } /** @@ -141,7 +82,7 @@ public void setApplicationVendor(String value) { * @param value The vendor header to be included on all requests. */ public void setApplicationVersion(String value) { - headers.put(Header.Version, value); + client.setApplicationVersion(value); } /** @@ -151,7 +92,26 @@ public void setApplicationVersion(String value) { * @param value The vendor header to be included on all requests. */ public void setApplicationName(String value) { - headers.put(Header.Name, value); + client.setApplicationName(value); + } + + /** + * Get the current version of the WSAPI being targeted. + * Defaults to v2.0 + * + * @return the current WSAPI version. + */ + public String getWsapiVersion() { + return client.getWsapiVersion(); + } + + /** + * Set the current version of the WSAPI being targeted. + * + * @param wsapiVersion the new version, e.g. {@code "1.30"} + */ + public void setWsapiVersion(String wsapiVersion) { + client.setWsapiVersion(wsapiVersion); } /** @@ -162,16 +122,7 @@ public void setApplicationName(String value) { * @throws IOException if an error occurs during the creation. */ public CreateResponse create(CreateRequest request) throws IOException { - return create(request, true); - } - - private CreateResponse create(CreateRequest request, boolean retryOnFail) throws IOException { - CreateResponse createResponse = new CreateResponse(doPost(buildWsapiUrl() + request.toUrl(), request.getBody())); - if (retryOnFail && createResponse.getErrors().length != 0) { - setSecurityToken(null); - return create(request, false); - } - return createResponse; + return new CreateResponse(client.doPost(request.toUrl(), request.getBody())); } /** @@ -182,16 +133,19 @@ private CreateResponse create(CreateRequest request, boolean retryOnFail) throws * @throws IOException if an error occurs during the update. */ public UpdateResponse update(UpdateRequest request) throws IOException { - return update(request, true); + return new UpdateResponse(client.doPost(request.toUrl(), request.getBody())); } - private UpdateResponse update(UpdateRequest request, boolean retryOnFail) throws IOException { - UpdateResponse updateResponse = new UpdateResponse(doPost(buildWsapiUrl() + request.toUrl(), request.getBody())); - if (retryOnFail && updateResponse.getErrors().length != 0) { - setSecurityToken(null); - return update(request, false); - } - return updateResponse; + /** + * Update the specified collection. + * Note that this method is only usable with WSAPI versions 2.0 and above. + * + * @param request the {@link CollectionUpdateRequest} specifying the collection to be updated. + * @return the resulting {@link CollectionUpdateResponse} + * @throws IOException if an error occurs during the update. + */ + public CollectionUpdateResponse updateCollection(CollectionUpdateRequest request) throws IOException { + return new CollectionUpdateResponse(client.doPost(request.toUrl(), request.getBody())); } /** @@ -202,16 +156,7 @@ private UpdateResponse update(UpdateRequest request, boolean retryOnFail) throws * @throws IOException if an error occurs during the deletion. */ public DeleteResponse delete(DeleteRequest request) throws IOException { - return delete(request, true); - } - - private DeleteResponse delete(DeleteRequest request, boolean retryOnFail) throws IOException { - DeleteResponse deleteResponse = new DeleteResponse(doDelete(buildWsapiUrl() + request.toUrl())); - if (retryOnFail && deleteResponse.getErrors().length != 0) { - setSecurityToken(null); - return delete(request, false); - } - return deleteResponse; + return new DeleteResponse(client.doDelete(request.toUrl())); } /** @@ -224,14 +169,14 @@ private DeleteResponse delete(DeleteRequest request, boolean retryOnFail) throws * @throws IOException if an error occurs during the query. */ public QueryResponse query(QueryRequest request) throws IOException { - QueryResponse queryResponse = new QueryResponse(doGet(buildWsapiUrl() + request.toUrl(), false)); + QueryResponse queryResponse = new QueryResponse(client.doGet(request.toUrl())); if (queryResponse.wasSuccessful()) { int receivedRecords = request.getPageSize(); while (receivedRecords < request.getLimit() && (receivedRecords + request.getStart() - 1) < queryResponse.getTotalResultCount()) { QueryRequest pageRequest = request.clone(); pageRequest.setStart(receivedRecords + request.getStart()); - QueryResponse pageResponse = new QueryResponse(doGet(buildWsapiUrl() + pageRequest.toUrl(), false)); + QueryResponse pageResponse = new QueryResponse(client.doGet(pageRequest.toUrl())); if (pageResponse.wasSuccessful()) { JsonArray results = queryResponse.getResults(); results.addAll(pageResponse.getResults()); @@ -251,19 +196,7 @@ public QueryResponse query(QueryRequest request) throws IOException { * @throws IOException if an error occurs during the retrieval. */ public GetResponse get(GetRequest request) throws IOException { - return get(request, false); - } - - /** - * Get the specified object. Forces basic auth as part of the request if specified - * - * @param request the {@link GetRequest} specifying the object to be retrieved. - * @param forceReauth boolean indicating if basic auth should be conducted as part of the request - * @return the resulting {@link GetResponse} - * @throws IOException if an error occurs during the retrieval. - */ - protected GetResponse get(GetRequest request, boolean forceReauth) throws IOException { - return new GetResponse(doGet(buildWsapiUrl() + request.toUrl(), forceReauth)); + return new GetResponse(client.doGet(request.toUrl())); } /** @@ -272,200 +205,17 @@ protected GetResponse get(GetRequest request, boolean forceReauth) throws IOExce * @throws IOException if an error occurs releasing resources */ public void close() throws IOException { - httpClient.getConnectionManager().shutdown(); - } - - /** - * Get the current version of the WSAPI being targeted. - * Defaults to {@link RallyRestApi#DEFAULT_WSAPI_VERSION} - * - * @return the current WSAPI version. - */ - public String getWsapiVersion() { - return wsapiVersion; - } - - /** - * Set the current version of the WSAPI being targeted. - * - * @param wsapiVersion the new version, e.g. {@code "1.30"} - */ - public void setWsapiVersion(String wsapiVersion) { - this.wsapiVersion = wsapiVersion; - } - - /** - * Execute a request against the WSAPI - * - * @param request the request to be executed - * @return the JSON encoded string response - * @throws IOException if a non-200 response code is returned or if some other - * problem occurs while executing the request - */ - protected String doRequest(HttpRequestBase request) throws IOException { - for (Map.Entry header : headers.entrySet()) { - request.setHeader("X-RallyIntegration" + header.getKey().name(), header.getValue()); - } - - HttpResponse response = httpClient.execute(request); - HttpEntity entity = response.getEntity(); - if (response.getStatusLine().getStatusCode() == 200) { - return EntityUtils.toString(entity, "utf-8"); - } else if (response.getStatusLine().getStatusCode() == 500) { - ((BasicManagedEntity) entity).releaseConnection(); - throw new InvalidURLException(request.getURI().toString() + " is an Invalid URL"); - } else { - throw new IOException(response.getStatusLine().toString()); - } - } - - /** - * Execute a request against the WSAPI with a basic auth header to force reauthorization - * - * @param request the request to be executed - * @return the JSON encoded string response - * @throws IOException if a non-200 response code is returned or if some other - * problem occurs while executing the request - */ - protected String doForceReauthRequest(HttpRequestBase request) throws IOException { - request.addHeader(BasicScheme.authenticate(usernamePasswordCredentials, "UTF-8", false)); - return doRequest(request); - } - - /** - * Execute a request against WSAPI that requires a security token due to data change/creation: - * 1. Post - * 2. Put - * 3. Delete - * - * @param request the request to be executed - * @return the JSON encoded string response - * @throws IOException if a non-200 response code is returned or if some other - * problem occurs while executing the request - */ - private String doSecuredRequest(HttpRequestBase request) throws IOException { - if (!request.getMethod().equals(HttpGet.METHOD_NAME) && - !this.getWsapiVersion().matches("^1[.]\\d+")) { - try { - attachSecurityInfo(request); - } catch (URISyntaxException e) { - throw new IOException("Unable to build URI with security token", e); - } - } - - return doRequest(request); - } - - /** - * Attach the security token parameter to the request. - *

- * Response Structure: - * {"OperationResult": {"SecurityToken": "UUID"}} - * - * @param request the request to be modified - * @throws IOException if a non-200 response code is returned or if some other - * problem occurs while executing the request - */ - protected void attachSecurityInfo(HttpRequestBase request) throws IOException, URISyntaxException { - if (!SECURITY_ENDPOINT_DOES_NOT_EXIST.equals(securityToken)) { - try { - if (securityToken == null) { - GetResponse getResponse = get(new GetRequest(SECURITY_TOKEN_URL), true); - JsonObject operationResult = getResponse.getObject(); - JsonPrimitive securityTokenPrimitive = operationResult.getAsJsonPrimitive(SECURITY_TOKEN_KEY); - securityToken = securityTokenPrimitive.getAsString(); - } - request.setURI(new URIBuilder(request.getURI()).addParameter(SECURITY_TOKEN_PARAM_KEY, securityToken).build()); - } catch (InvalidURLException e) { - //swallow the exception in this case as url does not exist indicates running and old version of - //ALM without the security endpoint - securityToken = SECURITY_ENDPOINT_DOES_NOT_EXIST; - } - } - } - - /** - * Sets the value on the security token for security enabled requests - * - * @param securityToken value fo the security token - */ - protected void setSecurityToken(String securityToken) { - this.securityToken = securityToken; - } - - /** - * Returns the current value of the security token. - * - * @return string value of security token - */ - protected String getSecurityToken() { - return securityToken; - } - - /** - * Perform a post against the WSAPI - * - * @param url the request url - * @param body the body of the post - * @return the JSON encoded string response - * @throws IOException if a non-200 response code is returned or if some other - * problem occurs while executing the request - */ - protected String doPost(String url, String body) throws IOException { - HttpPost httpPost = new HttpPost(url); - httpPost.setEntity(new StringEntity(body, "utf-8")); - return doSecuredRequest(httpPost); - } - - - /** - * Perform a put against the WSAPI - * - * @param url the request url - * @param body the body of the put - * @return the JSON encoded string response - * @throws IOException if a non-200 response code is returned or if some other - * problem occurs while executing the request - */ - protected String doPut(String url, String body) throws IOException { - HttpPut httpPut = new HttpPut(url); - httpPut.setEntity(new StringEntity(body, "utf-8")); - return doSecuredRequest(httpPut); - } - - /** - * Perform a delete against the WSAPI - * - * @param url the request url - * @return the JSON encoded string response - * @throws IOException if a non-200 response code is returned or if some other - * problem occurs while executing the request - */ - protected String doDelete(String url) throws IOException { - HttpDelete httpDelete = new HttpDelete(url); - return doSecuredRequest(httpDelete); - } - - /** - * Perform a get against the WSAPI - * - * @param url the request url - * @param forceReauth - * @return the JSON encoded string response - * @throws IOException if a non-200 response code is returned or if some other - * problem occurs while executing the request - */ - protected String doGet(String url, boolean forceReauth) throws IOException { - HttpGet httpGet = new HttpGet(url); - return forceReauth ? doForceReauthRequest(httpGet) : doRequest(httpGet); + client.close(); } /** - * Get the WSAPI base url based on the current server and WSAPI version + * Get the underlying http client implementation. + * This is exposed with the intent of providing the ability to supply additional configuration to the client. + * It should not be used to directly make i/o calls. * - * @return the fully qualified WSAPI base url, e.g. https://rally1.rallydev.com/slm/webservice/1.33 + * @return the raw http client */ - protected String buildWsapiUrl() { - return server.toString() + "/slm/webservice/" + wsapiVersion; + public HttpClient getClient() { + return client; } } \ No newline at end of file diff --git a/src/main/java/com/rallydev/rest/client/ApiKeyClient.java b/src/main/java/com/rallydev/rest/client/ApiKeyClient.java new file mode 100644 index 0000000..2295824 --- /dev/null +++ b/src/main/java/com/rallydev/rest/client/ApiKeyClient.java @@ -0,0 +1,39 @@ +package com.rallydev.rest.client; + +import org.apache.http.client.methods.HttpRequestBase; + +import java.io.IOException; +import java.net.URI; + +/** + * A HttpClient which authenticates using an API Key. + */ +public class ApiKeyClient extends HttpClient { + + protected String apiKey; + protected static final String API_KEY_HEADER = "zsessionid"; + + /** + * Construct a new client. + * @param server the server to connect to + * @param apiKey the key to be used for authentication + */ + public ApiKeyClient(URI server, String apiKey) { + super(server); + this.apiKey = apiKey; + } + + /** + * Execute a request against the WSAPI + * + * @param request the request to be executed + * @return the JSON encoded string response + * @throws java.io.IOException if a non-200 response code is returned or if some other + * problem occurs while executing the request + */ + @Override + protected String doRequest(HttpRequestBase request) throws IOException { + request.setHeader(API_KEY_HEADER, this.apiKey); + return super.doRequest(request); + } +} \ No newline at end of file diff --git a/src/main/java/com/rallydev/rest/client/BasicAuthClient.java b/src/main/java/com/rallydev/rest/client/BasicAuthClient.java new file mode 100644 index 0000000..d119ef3 --- /dev/null +++ b/src/main/java/com/rallydev/rest/client/BasicAuthClient.java @@ -0,0 +1,107 @@ +package com.rallydev.rest.client; + +import com.google.gson.JsonObject; +import com.google.gson.JsonPrimitive; +import com.rallydev.rest.response.GetResponse; +import org.apache.http.auth.Credentials; +import org.apache.http.auth.UsernamePasswordCredentials; +import org.apache.http.client.methods.HttpGet; +import org.apache.http.client.methods.HttpRequestBase; +import org.apache.http.client.utils.URIBuilder; +import org.apache.http.impl.auth.BasicScheme; +import java.io.IOException; +import java.net.URI; +import java.net.URISyntaxException; + +/** + * A HttpClient which authenticates using basic authentication (username/password). + */ +public class BasicAuthClient extends HttpClient { + + protected static final String SECURITY_ENDPOINT_DOES_NOT_EXIST = "SECURITY_ENDPOINT_DOES_NOT_EXIST"; + protected static final String SECURITY_TOKEN_PARAM_KEY = "key"; + private static final String SECURITY_TOKEN_URL = "/security/authorize"; + protected static final String SECURITY_TOKEN_KEY = "SecurityToken"; + protected String securityToken; + protected Credentials credentials; + + /** + * Construct a new client. + * @param server the server to connect to + * @param userName the username to be used for authentication + * @param password the password to be used for authentication + */ + public BasicAuthClient(URI server, String userName, String password) { + super(server, userName, password); + resetCredentials(userName, password); + } + + /** + * Execute a request against the WSAPI + * + * @param request the request to be executed + * @return the JSON encoded string response + * @throws java.io.IOException if a non-200 response code is returned or if some other + * problem occurs while executing the request + */ + @Override + protected String doRequest(HttpRequestBase request) throws IOException { + if(!request.getMethod().equals(HttpGet.METHOD_NAME) && + !this.getWsapiVersion().matches("^1[.]\\d+")) { + try { + attachSecurityInfo(request); + } catch (URISyntaxException e) { + throw new IOException("Unable to build URI with security token", e); + } + } + return super.doRequest(request); + } + + /** + * Attach the security token parameter to the request. + * + * Response Structure: + * {"OperationResult": {"SecurityToken": "UUID"}} + * + * @param request the request to be modified + * @throws IOException if a non-200 response code is returned or if some other + * problem occurs while executing the request + * @throws URISyntaxException if there is a problem with the url in the request + */ + protected void attachSecurityInfo(HttpRequestBase request) throws IOException, URISyntaxException { + if (!SECURITY_ENDPOINT_DOES_NOT_EXIST.equals(securityToken)) { + try { + if (securityToken == null) { + HttpGet httpGet = new HttpGet(getWsapiUrl() + SECURITY_TOKEN_URL); + httpGet.addHeader(BasicScheme.authenticate(credentials, "utf-8", false)); + GetResponse getResponse = new GetResponse(doRequest(httpGet)); + JsonObject operationResult = getResponse.getObject(); + JsonPrimitive securityTokenPrimitive = operationResult.getAsJsonPrimitive(SECURITY_TOKEN_KEY); + securityToken = securityTokenPrimitive.getAsString(); + } + request.setURI(new URIBuilder(request.getURI()).addParameter(SECURITY_TOKEN_PARAM_KEY, securityToken).build()); + } catch (IOException e) { + //swallow the exception in this case as url does not exist indicates running and old version of + //ALM without the security endpoint + securityToken = SECURITY_ENDPOINT_DOES_NOT_EXIST; + } + } + } + + /** + * Set the authenticated proxy server to use. By default no proxy is configured. + * + * @param proxy The proxy server, e.g. {@code new URI("http://my.proxy.com:8000")} + * @param userName The username to be used for authentication. + * @param password The password to be used for authentication. + */ + public void setProxy(URI proxy, String userName, String password) { + super.setProxy(proxy, userName, password); + resetCredentials(userName, password); + } + + private void resetCredentials(String userName, String password) { + this.credentials = new UsernamePasswordCredentials(userName, password); + securityToken = null; + } +} \ No newline at end of file diff --git a/src/main/java/com/rallydev/rest/client/HttpClient.java b/src/main/java/com/rallydev/rest/client/HttpClient.java new file mode 100644 index 0000000..4d830c0 --- /dev/null +++ b/src/main/java/com/rallydev/rest/client/HttpClient.java @@ -0,0 +1,298 @@ +package com.rallydev.rest.client; + +import org.apache.http.HttpEntity; +import org.apache.http.HttpHost; +import org.apache.http.auth.AuthScope; +import org.apache.http.auth.UsernamePasswordCredentials; +import org.apache.http.client.AuthenticationStrategy; +import org.apache.http.client.CredentialsProvider; +import org.apache.http.client.config.CookieSpecs; +import org.apache.http.client.config.RequestConfig; +import org.apache.http.client.methods.*; +import org.apache.http.conn.params.ConnRoutePNames; +import org.apache.http.entity.StringEntity; +import org.apache.http.impl.client.BasicCredentialsProvider; +import org.apache.http.impl.client.CloseableHttpClient; +import org.apache.http.impl.client.HttpClientBuilder; +import org.apache.http.impl.client.HttpClients; +import org.apache.http.impl.client.ProxyAuthenticationStrategy; +import org.apache.http.util.EntityUtils; + +import java.io.Closeable; +import java.io.IOException; +import java.net.URI; +import java.util.HashMap; +import java.util.Map; + +/** + * A HttpClient implementation providing connectivity to Rally. This class does not + * provide any authentication on its own but instead relies on a concrete subclass to do so. + */ +public class HttpClient + implements Closeable { + + protected final URI server; + protected String wsapiVersion = "v2.0"; + protected CloseableHttpClient client; + private String userName; + private String password; + private URI proxy; + + private enum Header { + Library, + Name, + Vendor, + Version + } + + private Map headers = new HashMap() { + { + put(Header.Library, "Rally Rest API for Java v2.2.1"); + put(Header.Name, "Rally Rest API for Java"); + put(Header.Vendor, "Rally Software, Inc."); + put(Header.Version, "2.2.1"); + } + }; + + protected HttpClient(URI server) { + this(server, null, null); + } + + protected HttpClient(URI server, String userName, String password) { + this.server = server; + this.userName = userName; + this.password = password; + this.client = buildClient(); + } + + protected CloseableHttpClient buildClient() { + HttpClientBuilder builder = HttpClients.custom(). + setDefaultRequestConfig(getRequestConfig()); + if (userName != null && password != null) { + builder.setDefaultCredentialsProvider(getCredentials(userName, password)); + } + if (proxy != null) { + builder.setProxy(new HttpHost(proxy.getHost(), proxy.getPort(), proxy.getScheme())); + } + return builder.build(); + } + + private RequestConfig getRequestConfig() { + return RequestConfig.custom(). + setCookieSpec(CookieSpecs.STANDARD). + build(); + } + + private CredentialsProvider getCredentials(String userName, String password) { + BasicCredentialsProvider provider = new BasicCredentialsProvider(); + UsernamePasswordCredentials credentials = new UsernamePasswordCredentials(userName, password); + provider.setCredentials( AuthScope.ANY, credentials); + return provider; + } + + /** + * Set the unauthenticated proxy server to use. By default no proxy is configured. + * + * @param proxy The proxy server, e.g. {@code new URI("http://my.proxy.com:8000")} + */ + public void setProxy(URI proxy) { + setProxy(proxy, null, null); + } + + /** + * Set the authenticated proxy server to use. By default no proxy is configured. + * + * @param proxy The proxy server, e.g. {@code new URI("http://my.proxy.com:8000")} + * @param userName The username to be used for authentication. + * @param password The password to be used for authentication. + */ + public void setProxy(URI proxy, String userName, String password) { + closeClient(); + this.proxy = proxy; + this.userName = userName; + this.password = password; + client = buildClient(); + } + + public URI getProxy() { + return proxy; + } + + private void closeClient() { + try { + client.close(); + } catch (Throwable t) { + throw new RuntimeException(t); + } + } + + /** + * Set the value of the X-RallyIntegrationVendor header included on all requests. + * This should be set to your company name. + * + * @param value The vendor header to be included on all requests. + */ + public void setApplicationVendor(String value) { + headers.put(Header.Vendor, value); + } + + /** + * Set the value of the X-RallyIntegrationVersion header included on all requests. + * This should be set to the version of your application. + * + * @param value The vendor header to be included on all requests. + */ + public void setApplicationVersion(String value) { + headers.put(Header.Version, value); + } + + /** + * Set the value of the X-RallyIntegrationName header included on all requests. + * This should be set to the name of your application. + * + * @param value The vendor header to be included on all requests. + */ + public void setApplicationName(String value) { + headers.put(Header.Name, value); + } + + /** + * Get the current server being targeted. + * + * @return the current server. + */ + public String getServer() { + return server.toString(); + } + + /** + * Get the current version of the WSAPI being targeted. + * + * @return the current WSAPI version. + */ + public String getWsapiVersion() { + return wsapiVersion; + } + + /** + * Set the current version of the WSAPI being targeted. + * + * @param wsapiVersion the new version, e.g. {@code "1.30"} + */ + public void setWsapiVersion(String wsapiVersion) { + this.wsapiVersion = wsapiVersion; + } + + /** + * Execute a request against the WSAPI + * + * @param request the request to be executed + * @return the JSON encoded string response + * @throws IOException if a non-200 response code is returned or if some other + * problem occurs while executing the request + */ + protected String doRequest(HttpRequestBase request) throws IOException { + for (Map.Entry header : headers.entrySet()) { + request.setHeader("X-RallyIntegration" + header.getKey().name(), header.getValue()); + } + + return this.executeRequest(request); + } + + /** + * Execute a request against the WSAPI + * + * @param request the request to be executed + * @return the JSON encoded string response + * @throws IOException if a non-200 response code is returned or if some other + * problem occurs while executing the request + */ + protected String executeRequest(HttpRequestBase request) throws IOException { + try (CloseableHttpResponse response = client.execute(request)) { + HttpEntity entity = response.getEntity(); + if (response.getStatusLine().getStatusCode() == 200) { + return EntityUtils.toString(entity, "utf-8"); + } else { + EntityUtils.consumeQuietly(entity); + throw new IOException(response.getStatusLine().toString()); + } + } + } + + /** + * Perform a post against the WSAPI + * + * @param url the request url + * @param body the body of the post + * @return the JSON encoded string response + * @throws IOException if a non-200 response code is returned or if some other + * problem occurs while executing the request + */ + public String doPost(String url, String body) throws IOException { + HttpPost httpPost = new HttpPost(getWsapiUrl() + url); + httpPost.setEntity(new StringEntity(body, "utf-8")); + return doRequest(httpPost); + } + + + /** + * Perform a put against the WSAPI + * + * @param url the request url + * @param body the body of the put + * @return the JSON encoded string response + * @throws IOException if a non-200 response code is returned or if some other + * problem occurs while executing the request + */ + public String doPut(String url, String body) throws IOException { + HttpPut httpPut = new HttpPut(getWsapiUrl() + url); + httpPut.setEntity(new StringEntity(body, "utf-8")); + return doRequest(httpPut); + } + + /** + * Perform a delete against the WSAPI + * + * @param url the request url + * @return the JSON encoded string response + * @throws IOException if a non-200 response code is returned or if some other + * problem occurs while executing the request + */ + public String doDelete(String url) throws IOException { + HttpDelete httpDelete = new HttpDelete(getWsapiUrl() + url); + return doRequest(httpDelete); + } + + /** + * Perform a get against the WSAPI + * + * @param url the request url + * @return the JSON encoded string response + * @throws IOException if a non-200 response code is returned or if some other + * problem occurs while executing the request + */ + public String doGet(String url) throws IOException { + HttpGet httpGet = new HttpGet(getWsapiUrl() + url); + return doRequest(httpGet); + } + + /** + * Release all resources associated with this instance. + */ + public void close() { + try { + client.close(); + } catch (Throwable t) { + throw new RuntimeException(t); + } + } + + /** + * Get the WSAPI base url based on the current server and WSAPI version + * + * @return the fully qualified WSAPI base url, e.g. https://rally1.rallydev.com/slm/webservice/1.33 + */ + public String getWsapiUrl() { + return getServer() + "/slm/webservice/" + getWsapiVersion(); + } +} diff --git a/src/main/java/com/rallydev/rest/client/package-info.java b/src/main/java/com/rallydev/rest/client/package-info.java new file mode 100644 index 0000000..2b38cbd --- /dev/null +++ b/src/main/java/com/rallydev/rest/client/package-info.java @@ -0,0 +1,4 @@ +/** + * Provides the underlying http client implementations. + */ +package com.rallydev.rest.client; \ No newline at end of file diff --git a/src/main/java/com/rallydev/rest/request/CollectionUpdateRequest.java b/src/main/java/com/rallydev/rest/request/CollectionUpdateRequest.java new file mode 100644 index 0000000..4b162b1 --- /dev/null +++ b/src/main/java/com/rallydev/rest/request/CollectionUpdateRequest.java @@ -0,0 +1,96 @@ +package com.rallydev.rest.request; + +import com.google.gson.JsonArray; +import com.google.gson.JsonObject; +import com.rallydev.rest.util.Fetch; +import com.rallydev.rest.util.Ref; +import org.apache.http.NameValuePair; +import org.apache.http.client.utils.URLEncodedUtils; +import org.apache.http.message.BasicNameValuePair; + +import java.util.ArrayList; +import java.util.List; + +/** + * Represents a WSAPI request to update a collection. + */ +public class CollectionUpdateRequest extends Request { + + private String ref; + private JsonArray items; + private boolean adding; + private Fetch fetch = new Fetch(); + + /** + * Create a new update request for the specified collection and values. + * Note that this class is only usable with WSAPI versions 2.0 and above. + * + * @param collection the collection to be updated + * @param items the items to be added or removed + * @param add true if adding, false if removing + */ + public CollectionUpdateRequest(JsonObject collection, JsonArray items, boolean add) { + this(collection.get("_ref").getAsString(), items, add); + } + + /** + * Create a new update request for the specified collection and values. + * + * @param collectionRef the ref of the collection to be updated. May be absolute or relative, e.g. "/defect/12345/tags" + * @param items the items to be added or removed + * @param adding true if adding, false if removing + */ + public CollectionUpdateRequest(String collectionRef, JsonArray items, boolean adding) { + this.ref = collectionRef; + this.items = items; + this.adding = adding; + } + + /** + * Get the JSON encoded string representation of the object to be updated. + * + * @return the JSON encoded object + */ + public String getBody() { + JsonObject wrapper = new JsonObject(); + wrapper.add("CollectionItems", items); + return gsonBuilder.create().toJson(wrapper); + } + + /** + *

Get the current list of fields to be returned on the updated object.

+ * By default all fields will be returned in the response (fetch=true). + * + * @return the current list of fields. + */ + public Fetch getFetch() { + return fetch; + } + + /** + * Set the current list of fields to be returned on the updated object. + * + * @param fetch the list of fields to be returned. + */ + public void setFetch(Fetch fetch) { + this.fetch = fetch; + } + + /** + *

Convert this request into a url compatible with the WSAPI.

+ * The current fetch and any other parameters will be included. + * + * @return the url representing this request. + */ + @Override + public String toUrl() { + + List params = new ArrayList(getParams()); + + params.add(new BasicNameValuePair("fetch", getFetch().toString())); + + return String.format("%s/%s.js?%s", Ref.getRelativeRef(ref), + adding ? "add" : "remove", + URLEncodedUtils.format(params, "utf-8")); + } +} diff --git a/src/main/java/com/rallydev/rest/request/CreateRequest.java b/src/main/java/com/rallydev/rest/request/CreateRequest.java index f63318a..86aa554 100644 --- a/src/main/java/com/rallydev/rest/request/CreateRequest.java +++ b/src/main/java/com/rallydev/rest/request/CreateRequest.java @@ -1,15 +1,12 @@ package com.rallydev.rest.request; -import com.google.gson.Gson; import com.google.gson.JsonObject; import com.rallydev.rest.util.Fetch; -import com.rallydev.rest.util.Ref; import org.apache.http.NameValuePair; import org.apache.http.client.utils.URLEncodedUtils; import org.apache.http.message.BasicNameValuePair; import java.util.ArrayList; -import java.util.HashMap; import java.util.List; /** @@ -40,7 +37,7 @@ public CreateRequest(String type, JsonObject obj) { public String getBody() { JsonObject wrapper = new JsonObject(); wrapper.add(type, obj); - return new Gson().toJson(wrapper); + return gsonBuilder.create().toJson(wrapper); } /** diff --git a/src/main/java/com/rallydev/rest/request/QueryRequest.java b/src/main/java/com/rallydev/rest/request/QueryRequest.java index b26e1c7..c013452 100644 --- a/src/main/java/com/rallydev/rest/request/QueryRequest.java +++ b/src/main/java/com/rallydev/rest/request/QueryRequest.java @@ -98,9 +98,8 @@ public String getWorkspace() { } /** - *

Specify the workspace which the result set should be scoped to.

+ *

Specify the workspace which the result set should be scoped to.

* The default is the user's default workspace. - *

* * @param workspaceRef the ref of the workspace to scope to. May be an absolute or relative ref, e.g. /workspace/1234 */ @@ -118,10 +117,9 @@ public String getProject() { } /** - *

Specify the project which the result set should be scoped to.

+ *

Specify the project which the result set should be scoped to.

* The default is the user's default project. * Specifying null will cause the result to be scoped to the entire specified workspace. - *

* * @param projectRef the ref of the project to scope to. May be null or an absolute or relative ref, e.g. /project/1234 */ @@ -131,7 +129,6 @@ public void setProject(String projectRef) { /** * If a project has been specified, get whether to include matching objects in parent projects in the result set. - *

* * @return whether to include matching objects in parent projects. */ @@ -142,7 +139,6 @@ public boolean isScopedUp() { /** *

If a project has been specified, set whether to include matching objects in parent projects in the result set.

* Defaults to false. - *

* * @param scopeUp whether to include matching objects in parent projects */ @@ -152,7 +148,6 @@ public void setScopedUp(boolean scopeUp) { /** * If a project has been specified, get whether to include matching objects in child projects in the result set. - *

* * @return whether to include matching objects in child projects. */ @@ -163,7 +158,6 @@ public boolean isScopedDown() { /** *

If a project has been specified, set whether to include matching objects in child projects in the result set.

* Defaults to true. - *

* * @param scopeDown whether to include matching objects in child projects */ diff --git a/src/main/java/com/rallydev/rest/request/Request.java b/src/main/java/com/rallydev/rest/request/Request.java index 3a37b91..9e86066 100644 --- a/src/main/java/com/rallydev/rest/request/Request.java +++ b/src/main/java/com/rallydev/rest/request/Request.java @@ -1,5 +1,6 @@ package com.rallydev.rest.request; +import com.google.gson.GsonBuilder; import org.apache.http.NameValuePair; import org.apache.http.message.BasicNameValuePair; @@ -14,10 +15,16 @@ public abstract class Request { private List params = new ArrayList(); + /** + * Gson Builder used for JSON serialization in this request. + */ + protected GsonBuilder gsonBuilder; + /** * Create a new request. */ public Request() { + this.gsonBuilder = new GsonBuilder().serializeNulls(); } /** @@ -48,6 +55,24 @@ public void addParam(String name, String value) { getParams().add(new BasicNameValuePair(name, value)); } + /** + * Get the Gson Builder used for JSON serialization in this request. + * + * @return The Gson Builder used for JSON serialization + */ + public GsonBuilder getGsonBuilder() { + return gsonBuilder; + } + + /** + * Set the Gson Builder used for JSON serialization in this request. + * + * @param gsonBuilder The Gson Builder used for JSON serialization + */ + public void setGsonBuilder(GsonBuilder gsonBuilder) { + this.gsonBuilder = gsonBuilder; + } + /** *

Convert this request into a url compatible with the WSAPI.

* Must be implemented by subclasses. diff --git a/src/main/java/com/rallydev/rest/request/UpdateRequest.java b/src/main/java/com/rallydev/rest/request/UpdateRequest.java index 758db49..e0f3a7d 100644 --- a/src/main/java/com/rallydev/rest/request/UpdateRequest.java +++ b/src/main/java/com/rallydev/rest/request/UpdateRequest.java @@ -1,6 +1,5 @@ package com.rallydev.rest.request; -import com.google.gson.Gson; import com.google.gson.JsonObject; import com.rallydev.rest.util.Fetch; import com.rallydev.rest.util.Ref; @@ -27,7 +26,7 @@ public class UpdateRequest extends Request { * @param obj the JSON representation of the values of the object */ public UpdateRequest(String ref, JsonObject obj) { - this.ref= ref; + this.ref = ref; this.obj = obj; } @@ -39,7 +38,7 @@ public UpdateRequest(String ref, JsonObject obj) { public String getBody() { JsonObject wrapper = new JsonObject(); wrapper.add(Ref.getTypeFromRef(ref), obj); - return new Gson().toJson(wrapper); + return gsonBuilder.create().toJson(wrapper); } /** diff --git a/src/main/java/com/rallydev/rest/response/CollectionUpdateResponse.java b/src/main/java/com/rallydev/rest/response/CollectionUpdateResponse.java new file mode 100644 index 0000000..6a42b3f --- /dev/null +++ b/src/main/java/com/rallydev/rest/response/CollectionUpdateResponse.java @@ -0,0 +1,37 @@ +package com.rallydev.rest.response; + +import com.google.gson.JsonArray; + +/** + * Represents a WSAPI response from updating a collection. + */ +public class CollectionUpdateResponse extends Response { + + /** + * Create a new collection update response from the specified JSON encoded string. + * Note that this class is only usable with WSAPI versions 2.0 and above. + * + * @param updateResponse the JSON encoded string + */ + public CollectionUpdateResponse(String updateResponse) { + super(updateResponse); + } + + /** + * Get the name of the root JSON result + * + * @return the root element name + */ + @Override + protected String getRoot() { + return "OperationResult"; + } + + /** + * Get the results of the collection update + * @return the results + */ + public JsonArray getResults() { + return result.getAsJsonArray("Results"); + } +} diff --git a/src/main/java/com/rallydev/rest/response/CreateResponse.java b/src/main/java/com/rallydev/rest/response/CreateResponse.java index 373797a..1a60045 100644 --- a/src/main/java/com/rallydev/rest/response/CreateResponse.java +++ b/src/main/java/com/rallydev/rest/response/CreateResponse.java @@ -4,13 +4,13 @@ import com.rallydev.rest.RallyRestApi; /** - * Represents a WSAPI response from creating an object + * Represents a WSAPI response from creating an object */ public class CreateResponse extends Response { /** * Create a new create response from the specified JSON encoded string. - * + * * @param createResponse the JSON encoded string */ public CreateResponse(String createResponse) { @@ -19,17 +19,17 @@ public CreateResponse(String createResponse) { /** * Get the name of the root JSON result - * + * * @return the root element name */ @Override protected String getRoot() { - return RallyRestApi.CREATE_RESULT_KEY; + return "CreateResult"; } /** * Get the created object. - *

Returns null if the operation was not successful

+ *

Returns null if the operation was not successful

* @return the created object */ public JsonObject getObject() { diff --git a/src/main/java/com/rallydev/rest/response/DeleteResponse.java b/src/main/java/com/rallydev/rest/response/DeleteResponse.java index a4e98c7..477efff 100644 --- a/src/main/java/com/rallydev/rest/response/DeleteResponse.java +++ b/src/main/java/com/rallydev/rest/response/DeleteResponse.java @@ -1,7 +1,5 @@ package com.rallydev.rest.response; -import static com.rallydev.rest.RallyRestApi.OPERATION_RESULT_KEY; - /** * Represents a WSAPI response from deleting an object */ @@ -23,6 +21,6 @@ public DeleteResponse(String deleteResponse) { */ @Override protected String getRoot() { - return OPERATION_RESULT_KEY; + return "OperationResult"; } } diff --git a/src/main/java/com/rallydev/rest/response/QueryResponse.java b/src/main/java/com/rallydev/rest/response/QueryResponse.java index 8dfecd3..148f92e 100644 --- a/src/main/java/com/rallydev/rest/response/QueryResponse.java +++ b/src/main/java/com/rallydev/rest/response/QueryResponse.java @@ -2,8 +2,6 @@ import com.google.gson.JsonArray; -import static com.rallydev.rest.RallyRestApi.QUERY_RESULT_KEY; - /** * Represents a WSAPI response from querying for objects. */ @@ -25,12 +23,12 @@ public QueryResponse(String queryResponse) { */ @Override protected String getRoot() { - return QUERY_RESULT_KEY; + return "QueryResult"; } /** * Get the total number of objects that matched the query - * + * * @return the total number of objects */ public int getTotalResultCount() { @@ -40,7 +38,7 @@ public int getTotalResultCount() { /** * Get the results of the query *

Depending on the limit of the original request this may include one or more pages.

- * + * * @return the results */ public JsonArray getResults() { @@ -49,7 +47,7 @@ public JsonArray getResults() { /** * Get the page size of the results - * + * * @return the page size */ public int getPageSize() { @@ -58,7 +56,7 @@ public int getPageSize() { /** * Get the start index of the results - * + * * @return the start index */ public int getStart() { diff --git a/src/main/java/com/rallydev/rest/response/UpdateResponse.java b/src/main/java/com/rallydev/rest/response/UpdateResponse.java index df4043e..0e12292 100644 --- a/src/main/java/com/rallydev/rest/response/UpdateResponse.java +++ b/src/main/java/com/rallydev/rest/response/UpdateResponse.java @@ -2,8 +2,6 @@ import com.google.gson.JsonObject; -import static com.rallydev.rest.RallyRestApi.OPERATION_RESULT_KEY; - /** * Represents a WSAPI response from updating an object. */ @@ -25,12 +23,12 @@ public UpdateResponse(String updateResponse) { */ @Override protected String getRoot() { - return OPERATION_RESULT_KEY; + return "OperationResult"; } /** * Get the updated object. - *

Returns null if the operation was not successful

+ *

Returns null if the operation was not successful

* @return the updated object */ public JsonObject getObject() { diff --git a/src/main/java/com/rallydev/rest/util/InvalidURLException.java b/src/main/java/com/rallydev/rest/util/InvalidURLException.java deleted file mode 100644 index ccd341b..0000000 --- a/src/main/java/com/rallydev/rest/util/InvalidURLException.java +++ /dev/null @@ -1,7 +0,0 @@ -package com.rallydev.rest.util; - -public class InvalidURLException extends RuntimeException { - public InvalidURLException(String msg) { - super(msg); - } -} diff --git a/src/main/java/com/rallydev/rest/util/Ref.java b/src/main/java/com/rallydev/rest/util/Ref.java index 7d56fba..2463787 100644 --- a/src/main/java/com/rallydev/rest/util/Ref.java +++ b/src/main/java/com/rallydev/rest/util/Ref.java @@ -23,10 +23,24 @@ public class Ref { Pattern.compile(".*?/(\\w+/-?\\d+)/(\\w+)(?:\\.js\\??.*)*$"), //basic ref (/defect/1234) - Pattern.compile(".*?/(\\w+)/(\\d+)(?:\\.js\\??.*)*$"), + Pattern.compile(".*?/(\\w+)/(-?\\d+)(?:\\.js\\??.*)*$"), //permission ref (/workspacepermission/123u456w1) - Pattern.compile(".*?/(\\w+)/(\\d+u\\d+[pw]\\d+)(?:\\.js\\??.*)*$") + Pattern.compile(".*?/(\\w+)/(\\d+u\\d+[pw]\\d+)(?:\\.js\\??.*)*$"), + + //adding UUID regex support in the ref urls + + //dynatype collection ref (/portfolioitem/feature/81348db8-aacd-447e-8678-2fb910ae9dc3 + Pattern.compile(".*?/(\\w{2,}/\\w+)/([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/\\w+)(?:\\.js\\??.*)*$"), + + //dynatype ref (/portfolioitem/feature/81348db8-aacd-447e-8678-2fb910ae9dc3 + Pattern.compile(".*?/(\\w{2,}/\\w+)/([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})(?:\\.js\\??.*)*$"), + + //collection ref (/defect/81348db8-aacd-447e-8678-2fb910ae9dc3/tasks) + Pattern.compile(".*?/(\\w+/-?[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})/(\\w+)(?:\\.js\\??.*)*$"), + + //basic ref (/defect/81348db8-aacd-447e-8678-2fb910ae9dc3) + Pattern.compile(".*?/(\\w+)/([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})(?:\\.js\\??.*)*$") )); private static Matcher match(String ref) { diff --git a/src/main/resources/doc/allclasses-frame.html b/src/main/resources/doc/allclasses-frame.html index 95c9880..85b129b 100644 --- a/src/main/resources/doc/allclasses-frame.html +++ b/src/main/resources/doc/allclasses-frame.html @@ -2,15 +2,19 @@ - -All Classes (Rally Rest API for Java 2.0) - + +All Classes (Rally Rest API for Java 2.2) +

All Classes

    +
  • ApiKeyClient
    • +
  • BasicAuthClient
    • +
  • CollectionUpdateRequest
    • +
  • CollectionUpdateResponse
  • CreateRequest
  • CreateResponse
  • DeleteRequest
    • @@ -18,7 +22,7 @@

    All Classes

  • Fetch
  • GetRequest
  • GetResponse
    • -
  • InvalidURLException
    • +
  • HttpClient
  • QueryFilter
  • QueryRequest
  • QueryResponse
    • diff --git a/src/main/resources/doc/allclasses-noframe.html b/src/main/resources/doc/allclasses-noframe.html index 28857f4..5797e15 100644 --- a/src/main/resources/doc/allclasses-noframe.html +++ b/src/main/resources/doc/allclasses-noframe.html @@ -2,15 +2,19 @@ - -All Classes (Rally Rest API for Java 2.0) - + +All Classes (Rally Rest API for Java 2.2) +

    All Classes

      +
    • ApiKeyClient
      • +
    • BasicAuthClient
      • +
    • CollectionUpdateRequest
      • +
    • CollectionUpdateResponse
    • CreateRequest
    • CreateResponse
    • DeleteRequest
      • @@ -18,7 +22,7 @@

      All Classes

    • Fetch
    • GetRequest
    • GetResponse
      • -
    • InvalidURLException
      • +
    • HttpClient
    • QueryFilter
    • QueryRequest
    • QueryResponse
      • diff --git a/src/main/resources/doc/com/rallydev/rest/CollectionAddExample.html b/src/main/resources/doc/com/rallydev/rest/CollectionAddExample.html new file mode 100644 index 0000000..b2e95d8 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/CollectionAddExample.html @@ -0,0 +1,261 @@ + + + + + +CollectionAddExample (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest
      +

      Class CollectionAddExample

      +
      +
      + +
      +
        +
      • +
        +
        +
        public class CollectionAddExample
+extends Object
        +
        • +
      +
      +
      + +
      +
      + +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/CollectionQueryExample.html b/src/main/resources/doc/com/rallydev/rest/CollectionQueryExample.html new file mode 100644 index 0000000..fb0971c --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/CollectionQueryExample.html @@ -0,0 +1,261 @@ + + + + + +CollectionQueryExample (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest
      +

      Class CollectionQueryExample

      +
      +
      + +
      +
        +
      • +
        +
        +
        public class CollectionQueryExample
+extends Object
        +
        • +
      +
      +
      + +
      +
      + +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/CollectionSummaryExample.html b/src/main/resources/doc/com/rallydev/rest/CollectionSummaryExample.html new file mode 100644 index 0000000..0edcc04 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/CollectionSummaryExample.html @@ -0,0 +1,261 @@ + + + + + +CollectionSummaryExample (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest
      +

      Class CollectionSummaryExample

      +
      +
      + +
      +
        +
      • +
        +
        +
        public class CollectionSummaryExample
+extends Object
        +
        • +
      +
      +
      + +
      +
      + +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/CrudExample.html b/src/main/resources/doc/com/rallydev/rest/CrudExample.html new file mode 100644 index 0000000..94c9c7a --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/CrudExample.html @@ -0,0 +1,261 @@ + + + + + +CrudExample (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest
      +

      Class CrudExample

      +
      +
      + +
      +
        +
      • +
        +
        +
        public class CrudExample
+extends Object
        +
        • +
      +
      +
      + +
      +
      + +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/QueryExample.html b/src/main/resources/doc/com/rallydev/rest/QueryExample.html new file mode 100644 index 0000000..df7ba86 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/QueryExample.html @@ -0,0 +1,261 @@ + + + + + +QueryExample (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest
      +

      Class QueryExample

      +
      +
      + +
      +
        +
      • +
        +
        +
        public class QueryExample
+extends Object
        +
        • +
      +
      +
      + +
      +
      + +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/RallyRestApi.html b/src/main/resources/doc/com/rallydev/rest/RallyRestApi.html index c354c4f..3fe53db 100644 --- a/src/main/resources/doc/com/rallydev/rest/RallyRestApi.html +++ b/src/main/resources/doc/com/rallydev/rest/RallyRestApi.html @@ -2,15 +2,15 @@ - -RallyRestApi (Rally Rest API for Java 2.0) - + +RallyRestApi (Rally Rest API for Java 2.2) + @@ -62,13 +62,13 @@ @@ -111,39 +111,6 @@

      Class RallyRestApi

      • - -
        • @@ -156,10 +123,18 @@

          Constructor Summary

          Constructor and Description +          RallyRestApi(URI server, + String apiKey) +
          Creates a new instance for the specified server using the specified API Key.
          + + + RallyRestApi(URI server, String userName, String password) -
          Creates a new instance for the specified server using the specified credentials.
          +
          Deprecated.  +
          Use the api key constructor instead.
          +
          @@ -202,42 +177,48 @@

          Method Summary

          +HttpClient +getClient() +
          Get the underlying http client implementation.
          + + + String getWsapiVersion()
          Get the current version of the WSAPI being targeted.
          - + QueryResponse query(QueryRequest request)
          Query for objects matching the specified request.
          - + void setApplicationName(String value)
          Set the value of the X-RallyIntegrationName header included on all requests.
          - + void setApplicationVendor(String value)
          Set the value of the X-RallyIntegrationVendor header included on all requests.
          - + void setApplicationVersion(String value)
          Set the value of the X-RallyIntegrationVersion header included on all requests.
          - + void setProxy(URI proxy)
          Set the unauthenticated proxy server to use.
          - + void setProxy(URI proxy, String userName, @@ -245,18 +226,24 @@

          Method Summary

          Set the authenticated proxy server to use.
          - + void setWsapiVersion(String wsapiVersion)
          Set the current version of the WSAPI being targeted.
          - + UpdateResponse update(UpdateRequest request)
          Update the specified object.
          + +CollectionUpdateResponse +updateCollection(CollectionUpdateRequest request) +
          Update the specified collection.
          + +
          • @@ -273,55 +260,6 @@

            Methods inherited from class java.lang.
            • - -
              • @@ -331,16 +269,29 @@

                Constructor Detail

                 -
                  +

                  • RallyRestApi

                    public RallyRestApi(URI server,
             String userName,
             String password)
                    +
                    Deprecated. Use the api key constructor instead.
                    Creates a new instance for the specified server using the specified credentials.
                    Parameters:
                    server - The server to connect to, e.g. new URI("https://rally1.rallydev.com")
                    userName - The username to be used for authentication.
                    password - The password to be used for authentication.
                  + + + +
                    +
                  • +

                    RallyRestApi

                    +
                    public RallyRestApi(URI server,
+            String apiKey)
                    +
                    Creates a new instance for the specified server using the specified API Key.
                    +
                    Parameters:
                    server - The server to connect to, e.g. new URI("https://rally1.rallydev.com")
                    apiKey - The API Key to be used for authentication.
                    +
                    • +
                @@ -409,6 +360,29 @@

                setApplicationName

                Parameters:
                value - The vendor header to be included on all requests.
              + + + +
                +
              • +

                getWsapiVersion

                +
                public String getWsapiVersion()
                +
                Get the current version of the WSAPI being targeted. + Defaults to v2.0
                +
                Returns:
                the current WSAPI version.
                +
                • +
              + + + +
                +
              • +

                setWsapiVersion

                +
                public void setWsapiVersion(String wsapiVersion)
                +
                Set the current version of the WSAPI being targeted.
                +
                Parameters:
                wsapiVersion - the new version, e.g. "1.30"
                +
                • +
              @@ -439,6 +413,22 @@

              update

              IOException - if an error occurs during the update.
            + + + + @@ -504,27 +494,17 @@

            close

            IOException - if an error occurs releasing resources
          - - - -
            -
          • -

            getWsapiVersion

            -
            public String getWsapiVersion()
            -
            Get the current version of the WSAPI being targeted. - Defaults to DEFAULT_WSAPI_VERSION
            -
            Returns:
            the current WSAPI version.
            -
            • -
          - +
          • -

            setWsapiVersion

            -
            public void setWsapiVersion(String wsapiVersion)
            -
            Set the current version of the WSAPI being targeted.
            -
            Parameters:
            wsapiVersion - the new version, e.g. "1.30"
            +

            getClient

            +
            public HttpClient getClient()
            +
            Get the underlying http client implementation. + This is exposed with the intent of providing the ability to supply additional configuration to the client. + It should not be used to directly make i/o calls.
            +
            Returns:
            the raw http client
          • @@ -579,13 +559,13 @@

          setWsapiVersion

          diff --git a/src/main/resources/doc/com/rallydev/rest/RallyRestApiTest.html b/src/main/resources/doc/com/rallydev/rest/RallyRestApiTest.html new file mode 100644 index 0000000..46f65b1 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/RallyRestApiTest.html @@ -0,0 +1,567 @@ + + + + + +RallyRestApiTest (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + +
          +
          com.rallydev.rest
          +

          Class RallyRestApiTest

          +
          +
          + +
          +
            +
          • +
            +
            +
            public class RallyRestApiTest
+extends Object
            +
            • +
          +
          +
          + +
          +
          +
            +
          • + +
              +
            • + + +

              Constructor Detail

              + + + +
                +
              • +

                RallyRestApiTest

                +
                public RallyRestApiTest()
                +
                • +
              +
              • +
            + +
              +
            • + + +

              Method Detail

              + + + +
                +
              • +

                shouldInitializeBasicAuthClient

                +
                public void shouldInitializeBasicAuthClient()
                +
                • +
              + + + +
                +
              • +

                shouldInitializeApiKeyClient

                +
                public void shouldInitializeApiKeyClient()
                +
                • +
              + + + +
                +
              • +

                shouldSetProxy

                +
                public void shouldSetProxy()
+                    throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldSetProxyWithCredentials

                +
                public void shouldSetProxyWithCredentials()
+                                   throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldSetVendor

                +
                public void shouldSetVendor()
+                     throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldSetVersion

                +
                public void shouldSetVersion()
+                      throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldSetName

                +
                public void shouldSetName()
+                   throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldGetWsapiVersion

                +
                public void shouldGetWsapiVersion()
                +
                • +
              + + + +
                +
              • +

                shouldSetWsapiVersion

                +
                public void shouldSetWsapiVersion()
                +
                • +
              + + + + + + + + + + + +
                +
              • +

                shouldUpdateCollection

                +
                public void shouldUpdateCollection()
+                            throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + + + + + + + + + +
                +
              • +

                shouldQueryOnePage

                +
                public void shouldQueryOnePage()
+                        throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldQueryAllPages

                +
                public void shouldQueryAllPages()
+                         throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldQuerySomePages

                +
                public void shouldQuerySomePages()
+                          throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldQueryNoPages

                +
                public void shouldQueryNoPages()
+                        throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldQuerySomePagesWithNonStandardStart

                +
                public void shouldQuerySomePagesWithNonStandardStart()
+                                              throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldQueryAllPagesWithNonStandardStart

                +
                public void shouldQueryAllPagesWithNonStandardStart()
+                                             throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + + +
              • +
            +
            • +
          +
          +
          + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/RestApiFactory.html b/src/main/resources/doc/com/rallydev/rest/RestApiFactory.html new file mode 100644 index 0000000..f181a80 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/RestApiFactory.html @@ -0,0 +1,259 @@ + + + + + +RestApiFactory (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + +
          +
          com.rallydev.rest
          +

          Class RestApiFactory

          +
          +
          + +
          +
            +
          • +
            +
            +
            public class RestApiFactory
+extends Object
            +
            • +
          +
          +
          + +
          +
          + +
          +
          + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/class-use/CollectionAddExample.html b/src/main/resources/doc/com/rallydev/rest/class-use/CollectionAddExample.html new file mode 100644 index 0000000..5651ee3 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/class-use/CollectionAddExample.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.CollectionAddExample (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.CollectionAddExample

          +
          +
          No usage of com.rallydev.rest.CollectionAddExample
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/class-use/CollectionQueryExample.html b/src/main/resources/doc/com/rallydev/rest/class-use/CollectionQueryExample.html new file mode 100644 index 0000000..b8b2403 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/class-use/CollectionQueryExample.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.CollectionQueryExample (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.CollectionQueryExample

          +
          +
          No usage of com.rallydev.rest.CollectionQueryExample
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/class-use/CollectionSummaryExample.html b/src/main/resources/doc/com/rallydev/rest/class-use/CollectionSummaryExample.html new file mode 100644 index 0000000..c7bf7fb --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/class-use/CollectionSummaryExample.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.CollectionSummaryExample (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.CollectionSummaryExample

          +
          +
          No usage of com.rallydev.rest.CollectionSummaryExample
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/class-use/CrudExample.html b/src/main/resources/doc/com/rallydev/rest/class-use/CrudExample.html new file mode 100644 index 0000000..d803248 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/class-use/CrudExample.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.CrudExample (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.CrudExample

          +
          +
          No usage of com.rallydev.rest.CrudExample
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/class-use/QueryExample.html b/src/main/resources/doc/com/rallydev/rest/class-use/QueryExample.html new file mode 100644 index 0000000..1e4de46 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/class-use/QueryExample.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.QueryExample (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.QueryExample

          +
          +
          No usage of com.rallydev.rest.QueryExample
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/class-use/RallyRestApi.html b/src/main/resources/doc/com/rallydev/rest/class-use/RallyRestApi.html index dbc54ca..d2d25e6 100644 --- a/src/main/resources/doc/com/rallydev/rest/class-use/RallyRestApi.html +++ b/src/main/resources/doc/com/rallydev/rest/class-use/RallyRestApi.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.RallyRestApi (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.RallyRestApi (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/class-use/RallyRestApiTest.html b/src/main/resources/doc/com/rallydev/rest/class-use/RallyRestApiTest.html new file mode 100644 index 0000000..a1044f6 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/class-use/RallyRestApiTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.RallyRestApiTest (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.RallyRestApiTest

          +
          +
          No usage of com.rallydev.rest.RallyRestApiTest
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/class-use/RestApiFactory.html b/src/main/resources/doc/com/rallydev/rest/class-use/RestApiFactory.html new file mode 100644 index 0000000..bfece53 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/class-use/RestApiFactory.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.RestApiFactory (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.RestApiFactory

          +
          +
          No usage of com.rallydev.rest.RestApiFactory
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/ApiKeyClient.html b/src/main/resources/doc/com/rallydev/rest/client/ApiKeyClient.html new file mode 100644 index 0000000..2579642 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/ApiKeyClient.html @@ -0,0 +1,275 @@ + + + + + +ApiKeyClient (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          +
            +
          • Detail: 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          +
          + + +
          + + +
          +
          com.rallydev.rest.client
          +

          Class ApiKeyClient

          +
          +
          + +
          + +
          +
          + +
          +
          +
            +
          • + +
              +
            • + + +

              Constructor Detail

              + + + +
                +
              • +

                ApiKeyClient

                +
                public ApiKeyClient(URI server,
+            String apiKey)
                +
                Construct a new client.
                +
                Parameters:
                server - the server to connect to
                apiKey - the key to be used for authentication
                +
                • +
              +
              • +
            +
            • +
          +
          +
          + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          +
            +
          • Detail: 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/ApiKeyClientTest.html b/src/main/resources/doc/com/rallydev/rest/client/ApiKeyClientTest.html new file mode 100644 index 0000000..5063ad9 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/ApiKeyClientTest.html @@ -0,0 +1,288 @@ + + + + + +ApiKeyClientTest (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + +
          +
          com.rallydev.rest.client
          +

          Class ApiKeyClientTest

          +
          +
          + +
          +
            +
          • +
            +
            +
            public class ApiKeyClientTest
+extends Object
            +
            • +
          +
          +
          + +
          +
          +
            +
          • + +
              +
            • + + +

              Constructor Detail

              + + + +
                +
              • +

                ApiKeyClientTest

                +
                public ApiKeyClientTest()
                +
                • +
              +
              • +
            + + +
            • +
          +
          +
          + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/BasicAuthClient.html b/src/main/resources/doc/com/rallydev/rest/client/BasicAuthClient.html new file mode 100644 index 0000000..0c0a069 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/BasicAuthClient.html @@ -0,0 +1,277 @@ + + + + + +BasicAuthClient (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          +
            +
          • Detail: 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          +
          + + +
          + + +
          +
          com.rallydev.rest.client
          +

          Class BasicAuthClient

          +
          +
          + +
          +
            +
          • +
            +
            All Implemented Interfaces:
            +
            Closeable, AutoCloseable, HttpClient
            +
            +
            +
            +
            public class BasicAuthClient
+extends HttpClient
            +
            A HttpClient which authenticates using basic authentication (username/password).
            +
            • +
          +
          +
          + +
          +
          +
            +
          • + +
              +
            • + + +

              Constructor Detail

              + + + +
                +
              • +

                BasicAuthClient

                +
                public BasicAuthClient(URI server,
+               String userName,
+               String password)
                +
                Construct a new client.
                +
                Parameters:
                server - the server to connect to
                userName - the username to be used for authentication
                password - the password to be used for authentication
                +
                • +
              +
              • +
            +
            • +
          +
          +
          + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          +
            +
          • Detail: 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/BasicAuthClientTest.html b/src/main/resources/doc/com/rallydev/rest/client/BasicAuthClientTest.html new file mode 100644 index 0000000..0195145 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/BasicAuthClientTest.html @@ -0,0 +1,368 @@ + + + + + +BasicAuthClientTest (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + +
          +
          com.rallydev.rest.client
          +

          Class BasicAuthClientTest

          +
          +
          + +
          +
            +
          • +
            +
            +
            public class BasicAuthClientTest
+extends Object
            +
            • +
          +
          +
          + +
          +
          +
            +
          • + +
              +
            • + + +

              Constructor Detail

              + + + +
                +
              • +

                BasicAuthClientTest

                +
                public BasicAuthClientTest()
                +
                • +
              +
              • +
            + +
              +
            • + + +

              Method Detail

              + + + + + + + +
                +
              • +

                shouldIntialize

                +
                public void shouldIntialize()
                +
                • +
              + + + +
                +
              • +

                shouldNotIncludeCSRFTokenOnGet

                +
                public void shouldNotIncludeCSRFTokenOnGet()
+                                    throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldNotIncludeCSRFTokenOnWsapiv1

                +
                public void shouldNotIncludeCSRFTokenOnWsapiv1()
+                                        throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldRequestCSRFToken

                +
                public void shouldRequestCSRFToken()
+                            throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldIncludeCSRFTokenOnPost

                +
                public void shouldIncludeCSRFTokenOnPost()
+                                  throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldIncludeCSRFTokenOnPut

                +
                public void shouldIncludeCSRFTokenOnPut()
+                                 throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldIncludeCSRFTokenOnDelete

                +
                public void shouldIncludeCSRFTokenOnDelete()
+                                    throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              +
              • +
            +
            • +
          +
          +
          + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/HttpClient.html b/src/main/resources/doc/com/rallydev/rest/client/HttpClient.html new file mode 100644 index 0000000..be69a93 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/HttpClient.html @@ -0,0 +1,520 @@ + + + + + +HttpClient (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          +
            +
          • Detail: 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          +
          + + +
          + + +
          +
          com.rallydev.rest.client
          +

          Class HttpClient

          +
          +
          + +
          + +
          +
          + +
          +
          +
            +
          • + +
              +
            • + + +

              Method Detail

              + + + +
                +
              • +

                setProxy

                +
                public void setProxy(URI proxy)
                +
                Set the unauthenticated proxy server to use. By default no proxy is configured.
                +
                Parameters:
                proxy - The proxy server, e.g. new URI("http://my.proxy.com:8000")
                +
                • +
              + + + +
                +
              • +

                setProxy

                +
                public void setProxy(URI proxy,
+            String userName,
+            String password)
                +
                Set the authenticated proxy server to use. By default no proxy is configured.
                +
                Parameters:
                proxy - The proxy server, e.g. new URI("http://my.proxy.com:8000")
                userName - The username to be used for authentication.
                password - The password to be used for authentication.
                +
                • +
              + + + +
                +
              • +

                setApplicationVendor

                +
                public void setApplicationVendor(String value)
                +
                Set the value of the X-RallyIntegrationVendor header included on all requests. + This should be set to your company name.
                +
                Parameters:
                value - The vendor header to be included on all requests.
                +
                • +
              + + + +
                +
              • +

                setApplicationVersion

                +
                public void setApplicationVersion(String value)
                +
                Set the value of the X-RallyIntegrationVersion header included on all requests. + This should be set to the version of your application.
                +
                Parameters:
                value - The vendor header to be included on all requests.
                +
                • +
              + + + +
                +
              • +

                setApplicationName

                +
                public void setApplicationName(String value)
                +
                Set the value of the X-RallyIntegrationName header included on all requests. + This should be set to the name of your application.
                +
                Parameters:
                value - The vendor header to be included on all requests.
                +
                • +
              + + + +
                +
              • +

                getServer

                +
                public String getServer()
                +
                Get the current server being targeted.
                +
                Returns:
                the current server.
                +
                • +
              + + + +
                +
              • +

                getWsapiVersion

                +
                public String getWsapiVersion()
                +
                Get the current version of the WSAPI being targeted.
                +
                Returns:
                the current WSAPI version.
                +
                • +
              + + + +
                +
              • +

                setWsapiVersion

                +
                public void setWsapiVersion(String wsapiVersion)
                +
                Set the current version of the WSAPI being targeted.
                +
                Parameters:
                wsapiVersion - the new version, e.g. "1.30"
                +
                • +
              + + + +
                +
              • +

                doPost

                +
                public String doPost(String url,
+            String body)
+              throws IOException
                +
                Perform a post against the WSAPI
                +
                Parameters:
                url - the request url
                body - the body of the post
                +
                Returns:
                the JSON encoded string response
                +
                Throws:
                +
                IOException - if a non-200 response code is returned or if some other + problem occurs while executing the request
                +
                • +
              + + + +
                +
              • +

                doPut

                +
                public String doPut(String url,
+           String body)
+             throws IOException
                +
                Perform a put against the WSAPI
                +
                Parameters:
                url - the request url
                body - the body of the put
                +
                Returns:
                the JSON encoded string response
                +
                Throws:
                +
                IOException - if a non-200 response code is returned or if some other + problem occurs while executing the request
                +
                • +
              + + + +
                +
              • +

                doDelete

                +
                public String doDelete(String url)
+                throws IOException
                +
                Perform a delete against the WSAPI
                +
                Parameters:
                url - the request url
                +
                Returns:
                the JSON encoded string response
                +
                Throws:
                +
                IOException - if a non-200 response code is returned or if some other + problem occurs while executing the request
                +
                • +
              + + + +
                +
              • +

                doGet

                +
                public String doGet(String url)
+             throws IOException
                +
                Perform a get against the WSAPI
                +
                Parameters:
                url - the request url
                +
                Returns:
                the JSON encoded string response
                +
                Throws:
                +
                IOException - if a non-200 response code is returned or if some other + problem occurs while executing the request
                +
                • +
              + + + +
                +
              • +

                close

                +
                public void close()
+           throws IOException
                +
                Release all resources associated with this instance.
                +
                +
                Specified by:
                +
                close in interface Closeable
                +
                Specified by:
                +
                close in interface AutoCloseable
                +
                Throws:
                +
                IOException - if an error occurs releasing resources
                +
                • +
              + + + +
                +
              • +

                getWsapiUrl

                +
                public String getWsapiUrl()
                +
                Get the WSAPI base url based on the current server and WSAPI version
                +
                Returns:
                the fully qualified WSAPI base url, e.g. https://rally1.rallydev.com/slm/webservice/1.33
                +
                • +
              +
              • +
            +
            • +
          +
          +
          + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          +
            +
          • Detail: 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/HttpClientTest.html b/src/main/resources/doc/com/rallydev/rest/client/HttpClientTest.html new file mode 100644 index 0000000..a5b7d0b --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/HttpClientTest.html @@ -0,0 +1,490 @@ + + + + + +HttpClientTest (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + +
          +
          com.rallydev.rest.client
          +

          Class HttpClientTest

          +
          +
          + +
          +
            +
          • +
            +
            +
            public class HttpClientTest
+extends Object
            +
            • +
          +
          +
          + +
          +
          +
            +
          • + +
              +
            • + + +

              Constructor Detail

              + + + +
                +
              • +

                HttpClientTest

                +
                public HttpClientTest()
                +
                • +
              +
              • +
            + +
              +
            • + + +

              Method Detail

              + + + + + + + +
                +
              • +

                shouldIntialize

                +
                public void shouldIntialize()
                +
                • +
              + + + +
                +
              • +

                shouldSetProxy

                +
                public void shouldSetProxy()
+                    throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldSetProxyWithCredentials

                +
                public void shouldSetProxyWithCredentials()
+                                   throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldSetApplicationVendor

                +
                public void shouldSetApplicationVendor()
+                                throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldSetApplicationName

                +
                public void shouldSetApplicationName()
+                              throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldSetApplicationVersion

                +
                public void shouldSetApplicationVersion()
+                                 throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldUseDefaultWsapiVersion

                +
                public void shouldUseDefaultWsapiVersion()
                +
                • +
              + + + +
                +
              • +

                shouldSetWsapiVersion

                +
                public void shouldSetWsapiVersion()
                +
                • +
              + + + + + + + + + + + + + + + + + + + + + + + +
                +
              • +

                shouldReturnValidResponse

                +
                public void shouldReturnValidResponse()
+                               throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              + + + +
                +
              • +

                shouldExplodeWithInvalidResponse

                +
                public void shouldExplodeWithInvalidResponse()
+                                      throws Exception
                +
                Throws:
                +
                Exception
                +
                • +
              +
              • +
            +
            • +
          +
          +
          + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/class-use/ApiKeyClient.html b/src/main/resources/doc/com/rallydev/rest/client/class-use/ApiKeyClient.html new file mode 100644 index 0000000..0192075 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/class-use/ApiKeyClient.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.client.ApiKeyClient (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.client.ApiKeyClient

          +
          +
          No usage of com.rallydev.rest.client.ApiKeyClient
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/class-use/ApiKeyClientTest.html b/src/main/resources/doc/com/rallydev/rest/client/class-use/ApiKeyClientTest.html new file mode 100644 index 0000000..ebb0f60 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/class-use/ApiKeyClientTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.client.ApiKeyClientTest (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.client.ApiKeyClientTest

          +
          +
          No usage of com.rallydev.rest.client.ApiKeyClientTest
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/class-use/BasicAuthClient.html b/src/main/resources/doc/com/rallydev/rest/client/class-use/BasicAuthClient.html new file mode 100644 index 0000000..02b4cf1 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/class-use/BasicAuthClient.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.client.BasicAuthClient (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.client.BasicAuthClient

          +
          +
          No usage of com.rallydev.rest.client.BasicAuthClient
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/class-use/BasicAuthClientTest.html b/src/main/resources/doc/com/rallydev/rest/client/class-use/BasicAuthClientTest.html new file mode 100644 index 0000000..2321610 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/class-use/BasicAuthClientTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.client.BasicAuthClientTest (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.client.BasicAuthClientTest

          +
          +
          No usage of com.rallydev.rest.client.BasicAuthClientTest
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/class-use/HttpClient.html b/src/main/resources/doc/com/rallydev/rest/client/class-use/HttpClient.html new file mode 100644 index 0000000..0601e0e --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/class-use/HttpClient.html @@ -0,0 +1,191 @@ + + + + + +Uses of Class com.rallydev.rest.client.HttpClient (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.client.HttpClient

          +
          +
          + +
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/class-use/HttpClientTest.html b/src/main/resources/doc/com/rallydev/rest/client/class-use/HttpClientTest.html new file mode 100644 index 0000000..333d33c --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/class-use/HttpClientTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.client.HttpClientTest (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.client.HttpClientTest

          +
          +
          No usage of com.rallydev.rest.client.HttpClientTest
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/package-frame.html b/src/main/resources/doc/com/rallydev/rest/client/package-frame.html new file mode 100644 index 0000000..b93778d --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/package-frame.html @@ -0,0 +1,21 @@ + + + + + +com.rallydev.rest.client (Rally Rest API for Java 2.2) + + + + +

          com.rallydev.rest.client

          +
          +

          Classes

          + +
          + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/package-summary.html b/src/main/resources/doc/com/rallydev/rest/client/package-summary.html new file mode 100644 index 0000000..07186d1 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/package-summary.html @@ -0,0 +1,156 @@ + + + + + +com.rallydev.rest.client (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          + + +
          + +
          +

          Package com.rallydev.rest.client

          +
          +
          Provides the underlying http client implementations.
          +
          +

          See: Description

          +
          +
          +
            +
          • + + + + + + + + + + + + + + + + + + + + +
            Class Summary 
            ClassDescription
            ApiKeyClient +
            A HttpClient which authenticates using an API Key.
            +
            BasicAuthClient +
            A HttpClient which authenticates using basic authentication (username/password).
            +
            HttpClient +
            A HttpClient implementation providing connectivity to Rally.
            +
            +
            • +
          + + + +

          Package com.rallydev.rest.client Description

          +
          Provides the underlying http client implementations.
          +
          + +
          + + + + + +
          +
          + + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/package-tree.html b/src/main/resources/doc/com/rallydev/rest/client/package-tree.html new file mode 100644 index 0000000..79b7cb7 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/package-tree.html @@ -0,0 +1,141 @@ + + + + + +com.rallydev.rest.client Class Hierarchy (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          + + +
          + +
          +

          Hierarchy For Package com.rallydev.rest.client

          +Package Hierarchies: + +
          +
          +

          Class Hierarchy

          + +
          + +
          + + + + + +
          +
          + + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/client/package-use.html b/src/main/resources/doc/com/rallydev/rest/client/package-use.html new file mode 100644 index 0000000..a7acda1 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/client/package-use.html @@ -0,0 +1,175 @@ + + + + + +Uses of Package com.rallydev.rest.client (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Package
          com.rallydev.rest.client

          +
          +
          + +
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestBodyMatcher.html b/src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestBodyMatcher.html new file mode 100644 index 0000000..0b9e6f7 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestBodyMatcher.html @@ -0,0 +1,292 @@ + + + + + +HttpRequestBodyMatcher (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + +
          +
          com.rallydev.rest.matchers
          +

          Class HttpRequestBodyMatcher

          +
          +
          + +
          + +
          +
          +
            +
          • + + + +
              +
            • + + +

              Method Summary

              + + + + + + + + + + +
              Methods 
              Modifier and TypeMethod and Description
              booleanmatches(Object o) 
              +
                +
              • + + +

                Methods inherited from class org.mockito.ArgumentMatcher

                +describeTo
                • +
              +
                +
              • + + +

                Methods inherited from class org.hamcrest.BaseMatcher

                +_dont_implement_Matcher___instead_extend_BaseMatcher_, toString
                • +
              + +
              • +
            +
            • +
          +
          +
          + +
          +
          + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestHeaderMatcher.html b/src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestHeaderMatcher.html new file mode 100644 index 0000000..6aa62c7 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestHeaderMatcher.html @@ -0,0 +1,292 @@ + + + + + +HttpRequestHeaderMatcher (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + +
          +
          com.rallydev.rest.matchers
          +

          Class HttpRequestHeaderMatcher

          +
          +
          +
            +
          • java.lang.Object
            • +
          • +
              +
            • org.hamcrest.BaseMatcher<T>
              • +
            • +
                +
              • org.mockito.ArgumentMatcher<HttpRequestBase>
                • +
              • +
                  +
                • com.rallydev.rest.matchers.HttpRequestHeaderMatcher
                  • +
                +
                • +
              +
              • +
            +
            • +
          +
          +
            +
          • +
            +
            All Implemented Interfaces:
            +
            org.hamcrest.Matcher<HttpRequestBase>, org.hamcrest.SelfDescribing
            +
            +
            +
            +
            public class HttpRequestHeaderMatcher
+extends org.mockito.ArgumentMatcher<HttpRequestBase>
            +
            • +
          +
          +
          + +
          +
          +
            +
          • + +
              +
            • + + +

              Constructor Detail

              + + + +
                +
              • +

                HttpRequestHeaderMatcher

                +
                public HttpRequestHeaderMatcher(String name,
+                        String value)
                +
                • +
              +
              • +
            + +
              +
            • + + +

              Method Detail

              + + + +
                +
              • +

                matches

                +
                public boolean matches(Object o)
                +
                +
                Specified by:
                +
                matches in interface org.hamcrest.Matcher<HttpRequestBase>
                +
                Specified by:
                +
                matches in class org.mockito.ArgumentMatcher<HttpRequestBase>
                +
                +
                • +
              +
              • +
            +
            • +
          +
          +
          + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestUrlMatcher.html b/src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestUrlMatcher.html new file mode 100644 index 0000000..f487b9b --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestUrlMatcher.html @@ -0,0 +1,290 @@ + + + + + +HttpRequestUrlMatcher (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + +
          +
          com.rallydev.rest.matchers
          +

          Class HttpRequestUrlMatcher

          +
          +
          +
            +
          • java.lang.Object
            • +
          • +
              +
            • org.hamcrest.BaseMatcher<T>
              • +
            • +
                +
              • org.mockito.ArgumentMatcher<HttpRequestBase>
                • +
              • +
                  +
                • com.rallydev.rest.matchers.HttpRequestUrlMatcher
                  • +
                +
                • +
              +
              • +
            +
            • +
          +
          +
            +
          • +
            +
            All Implemented Interfaces:
            +
            org.hamcrest.Matcher<HttpRequestBase>, org.hamcrest.SelfDescribing
            +
            +
            +
            +
            public class HttpRequestUrlMatcher
+extends org.mockito.ArgumentMatcher<HttpRequestBase>
            +
            • +
          +
          +
          +
            +
          • + + + +
              +
            • + + +

              Method Summary

              + + + + + + + + + + +
              Methods 
              Modifier and TypeMethod and Description
              booleanmatches(Object o) 
              +
                +
              • + + +

                Methods inherited from class org.mockito.ArgumentMatcher

                +describeTo
                • +
              +
                +
              • + + +

                Methods inherited from class org.hamcrest.BaseMatcher

                +_dont_implement_Matcher___instead_extend_BaseMatcher_, toString
                • +
              + +
              • +
            +
            • +
          +
          +
          +
            +
          • + +
              +
            • + + +

              Constructor Detail

              + + + +
                +
              • +

                HttpRequestUrlMatcher

                +
                public HttpRequestUrlMatcher(String url)
                +
                • +
              +
              • +
            + +
              +
            • + + +

              Method Detail

              + + + +
                +
              • +

                matches

                +
                public boolean matches(Object o)
                +
                +
                Specified by:
                +
                matches in interface org.hamcrest.Matcher<HttpRequestBase>
                +
                Specified by:
                +
                matches in class org.mockito.ArgumentMatcher<HttpRequestBase>
                +
                +
                • +
              +
              • +
            +
            • +
          +
          +
          + + +
          + + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestBodyMatcher.html b/src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestBodyMatcher.html new file mode 100644 index 0000000..ea1d659 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestBodyMatcher.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.matchers.HttpRequestBodyMatcher (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.matchers.HttpRequestBodyMatcher

          +
          +
          No usage of com.rallydev.rest.matchers.HttpRequestBodyMatcher
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestHeaderMatcher.html b/src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestHeaderMatcher.html new file mode 100644 index 0000000..2d0bb15 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestHeaderMatcher.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.matchers.HttpRequestHeaderMatcher (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.matchers.HttpRequestHeaderMatcher

          +
          +
          No usage of com.rallydev.rest.matchers.HttpRequestHeaderMatcher
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestUrlMatcher.html b/src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestUrlMatcher.html new file mode 100644 index 0000000..ae5f943 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestUrlMatcher.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.matchers.HttpRequestUrlMatcher (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Class
          com.rallydev.rest.matchers.HttpRequestUrlMatcher

          +
          +
          No usage of com.rallydev.rest.matchers.HttpRequestUrlMatcher
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/matchers/package-frame.html b/src/main/resources/doc/com/rallydev/rest/matchers/package-frame.html new file mode 100644 index 0000000..6b1481a --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/matchers/package-frame.html @@ -0,0 +1,21 @@ + + + + + +com.rallydev.rest.matchers (Rally Rest API for Java 2.2) + + + + +

          com.rallydev.rest.matchers

          +
          +

          Classes

          + +
          + + diff --git a/src/main/resources/doc/com/rallydev/rest/matchers/package-summary.html b/src/main/resources/doc/com/rallydev/rest/matchers/package-summary.html new file mode 100644 index 0000000..4ac1875 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/matchers/package-summary.html @@ -0,0 +1,141 @@ + + + + + +com.rallydev.rest.matchers (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          + + +
          + +
          +

          Package com.rallydev.rest.matchers

          +
          +
          + +
          + +
          + + + + + +
          +
          + + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/matchers/package-tree.html b/src/main/resources/doc/com/rallydev/rest/matchers/package-tree.html new file mode 100644 index 0000000..644229c --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/matchers/package-tree.html @@ -0,0 +1,138 @@ + + + + + +com.rallydev.rest.matchers Class Hierarchy (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          + + +
          + +
          +

          Hierarchy For Package com.rallydev.rest.matchers

          +Package Hierarchies: + +
          +
          +

          Class Hierarchy

          + +
          + +
          + + + + + +
          +
          + + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/matchers/package-use.html b/src/main/resources/doc/com/rallydev/rest/matchers/package-use.html new file mode 100644 index 0000000..e2746d6 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/matchers/package-use.html @@ -0,0 +1,115 @@ + + + + + +Uses of Package com.rallydev.rest.matchers (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + +
          +

          Uses of Package
          com.rallydev.rest.matchers

          +
          +
          No usage of com.rallydev.rest.matchers
          + +
          + + + + + +
          +
          +
            +
          • Prev
            • +
          • Next
            • +
          + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/com/rallydev/rest/package-frame.html b/src/main/resources/doc/com/rallydev/rest/package-frame.html index f8682b1..f5d6a58 100644 --- a/src/main/resources/doc/com/rallydev/rest/package-frame.html +++ b/src/main/resources/doc/com/rallydev/rest/package-frame.html @@ -2,9 +2,9 @@ - -com.rallydev.rest (Rally Rest API for Java 2.0) - + +com.rallydev.rest (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/package-summary.html b/src/main/resources/doc/com/rallydev/rest/package-summary.html index b891f77..541afa1 100644 --- a/src/main/resources/doc/com/rallydev/rest/package-summary.html +++ b/src/main/resources/doc/com/rallydev/rest/package-summary.html @@ -2,15 +2,15 @@ - -com.rallydev.rest (Rally Rest API for Java 2.0) - + +com.rallydev.rest (Rally Rest API for Java 2.2) + @@ -37,7 +37,7 @@
          • Frames
            • @@ -115,7 +115,7 @@

            Package com.rallydev.rest Desc
            • Frames
              • diff --git a/src/main/resources/doc/com/rallydev/rest/package-tree.html b/src/main/resources/doc/com/rallydev/rest/package-tree.html index 07a9f5d..e76a490 100644 --- a/src/main/resources/doc/com/rallydev/rest/package-tree.html +++ b/src/main/resources/doc/com/rallydev/rest/package-tree.html @@ -2,15 +2,15 @@ - -com.rallydev.rest Class Hierarchy (Rally Rest API for Java 2.0) - + +com.rallydev.rest Class Hierarchy (Rally Rest API for Java 2.2) + @@ -37,7 +37,7 @@
              @@ -446,8 +442,7 @@

              setProject

            • isScopedUp

              public boolean isScopedUp()
              -
              If a project has been specified, get whether to include matching objects in parent projects in the result set. -

              +
              If a project has been specified, get whether to include matching objects in parent projects in the result set.
              Returns:
              whether to include matching objects in parent projects.
            @@ -459,8 +454,7 @@

            isScopedUp

            setScopedUp

            public void setScopedUp(boolean scopeUp)

            If a project has been specified, set whether to include matching objects in parent projects in the result set.

            - Defaults to false. -

            + Defaults to false.
            Parameters:
            scopeUp - whether to include matching objects in parent projects

          @@ -471,8 +465,7 @@

          setScopedUp

        • isScopedDown

          public boolean isScopedDown()
          -
          If a project has been specified, get whether to include matching objects in child projects in the result set. -

          +
          If a project has been specified, get whether to include matching objects in child projects in the result set.
          Returns:
          whether to include matching objects in child projects.
        @@ -484,8 +477,7 @@

        isScopedDown

        setScopedDown

        public void setScopedDown(boolean scopeDown)

        If a project has been specified, set whether to include matching objects in child projects in the result set.

        - Defaults to true. -

        + Defaults to true.
      Parameters:
      scopeDown - whether to include matching objects in child projects
    diff --git a/src/main/resources/doc/com/rallydev/rest/request/QueryRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/QueryRequestTest.html new file mode 100644 index 0000000..a04fc4a --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/request/QueryRequestTest.html @@ -0,0 +1,451 @@ + + + + + +QueryRequestTest (Rally Rest API for Java 2.2) + + + + + + + +
    + + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + +
    +
    com.rallydev.rest.request
    +

    Class QueryRequestTest

    +
    +
    + +
    +
      +
    • +
      +
      +
      public class QueryRequestTest
+extends Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          QueryRequestTest

          +
          public QueryRequestTest()
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          shouldCreateCorrectDefaultQuery

          +
          public void shouldCreateCorrectDefaultQuery()
          +
          • +
        + + + +
          +
        • +

          shouldCreateCorrectDefaultQueryWithExtraParam

          +
          public void shouldCreateCorrectDefaultQueryWithExtraParam()
          +
          • +
        + + + +
          +
        • +

          shouldEncodeParamsUsingUtf8

          +
          public void shouldEncodeParamsUsingUtf8()
          +
          • +
        + + + +
          +
        • +

          shouldCreateCorrectQueryWithFetch

          +
          public void shouldCreateCorrectQueryWithFetch()
          +
          • +
        + + + +
          +
        • +

          shouldCreateCorrectQueryWithDefaultOrder

          +
          public void shouldCreateCorrectQueryWithDefaultOrder()
          +
          • +
        + + + +
          +
        • +

          shouldCreateCorrectQueryWithSpecifiedOrder

          +
          public void shouldCreateCorrectQueryWithSpecifiedOrder()
          +
          • +
        + + + +
          +
        • +

          shouldCreateCorrectQueryWithPageSize

          +
          public void shouldCreateCorrectQueryWithPageSize()
          +
          • +
        + + + +
          +
        • +

          shouldCreateCorrectQueryWithStart

          +
          public void shouldCreateCorrectQueryWithStart()
          +
          • +
        + + + +
          +
        • +

          shouldCreateCorrectQueryWithQuery

          +
          public void shouldCreateCorrectQueryWithQuery()
          +
          • +
        + + + +
          +
        • +

          shouldCreateCorrectQueryWithWorkspace

          +
          public void shouldCreateCorrectQueryWithWorkspace()
          +
          • +
        + + + +
          +
        • +

          shouldCreateCorrectQueryWithProject

          +
          public void shouldCreateCorrectQueryWithProject()
          +
          • +
        + + + +
          +
        • +

          shouldCreateCorrectQueryWithNullProject

          +
          public void shouldCreateCorrectQueryWithNullProject()
          +
          • +
        + + + +
          +
        • +

          shouldCloneCorrectly

          +
          public void shouldCloneCorrectly()
          +
          • +
        + + + +
          +
        • +

          shouldCreateCorrectUrlForSubscription

          +
          public void shouldCreateCorrectUrlForSubscription()
          +
          • +
        + + + +
          +
        • +

          shouldCreateCorrectUrlForUser

          +
          public void shouldCreateCorrectUrlForUser()
          +
          • +
        + + + +
          +
        • +

          shouldCreateCorrectUrlForCollection

          +
          public void shouldCreateCorrectUrlForCollection()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + + diff --git a/src/main/resources/doc/com/rallydev/rest/request/Request.html b/src/main/resources/doc/com/rallydev/rest/request/Request.html index ebea0a8..e44dc85 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/Request.html +++ b/src/main/resources/doc/com/rallydev/rest/request/Request.html @@ -2,15 +2,15 @@ - -Request (Rally Rest API for Java 2.0) - + +Request (Rally Rest API for Java 2.2) + @@ -96,7 +96,7 @@

    Class Request

  • Direct Known Subclasses:
    -
    CreateRequest, DeleteRequest, GetRequest, QueryRequest, UpdateRequest
    +
    CollectionUpdateRequest, CreateRequest, DeleteRequest, GetRequest, QueryRequest, UpdateRequest

    @@ -149,14 +149,26 @@

    Method Summary

    -List<org.apache.http.NameValuePair> +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<org.apache.http.NameValuePair> params) +setParams(List<NameValuePair> params)
    Set the list of additional parameters included in this request.
    @@ -212,7 +224,7 @@

    Method Detail

    • getParams

      -
      public List<org.apache.http.NameValuePair> getParams()
      +
      public List<NameValuePair> getParams()
      Get the list of additional parameters included in this request.
      Returns:
      The list of additional parameters
      • @@ -223,7 +235,7 @@

      getParams

      • setParams

        -
        public void setParams(List<org.apache.http.NameValuePair> params)
        +
        public void setParams(List<NameValuePair> params)
        Set the list of additional parameters included in this request.
        Parameters:
        params - The list of additional parameters
        • @@ -240,6 +252,28 @@

        addParam

        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
        +
        • +
      diff --git a/src/main/resources/doc/com/rallydev/rest/request/RequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/RequestTest.html new file mode 100644 index 0000000..ba0ccc0 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/request/RequestTest.html @@ -0,0 +1,282 @@ + + + + + +RequestTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest.request
      +

      Class RequestTest

      +
      +
      + +
      +
        +
      • +
        +
        +
        public class RequestTest
+extends Object
        +
        • +
      +
      +
      + +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Detail

          + + + +
            +
          • +

            RequestTest

            +
            public RequestTest()
            +
            • +
          +
          • +
        + +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            shouldBeAbleToAddParams

            +
            public void shouldBeAbleToAddParams()
            +
            • +
          + + + +
            +
          • +

            shouldBeAbleToSetParams

            +
            public void shouldBeAbleToSetParams()
            +
            • +
          + + + +
            +
          • +

            shouldBeAbleToSetGsonBuilder

            +
            public void shouldBeAbleToSetGsonBuilder()
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/request/UpdateRequest.html b/src/main/resources/doc/com/rallydev/rest/request/UpdateRequest.html index 94a880b..e200940 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/UpdateRequest.html +++ b/src/main/resources/doc/com/rallydev/rest/request/UpdateRequest.html @@ -2,15 +2,15 @@ - -UpdateRequest (Rally Rest API for Java 2.0) - + +UpdateRequest (Rally Rest API for Java 2.2) + @@ -172,7 +172,7 @@

      Method Summary

      Methods inherited from class com.rallydev.rest.request.Request

      -addParam, getParams, setParams +addParam, getGsonBuilder, getParams, setGsonBuilder, setParams
    • diff --git a/src/main/resources/doc/com/rallydev/rest/request/UpdateRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/UpdateRequestTest.html new file mode 100644 index 0000000..e3b1a94 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/request/UpdateRequestTest.html @@ -0,0 +1,308 @@ + + + + + +UpdateRequestTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest.request
      +

      Class UpdateRequestTest

      +
      +
      + +
      +
        +
      • +
        +
        +
        public class UpdateRequestTest
+extends Object
        +
        • +
      +
      +
      + +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Detail

          + + + +
            +
          • +

            UpdateRequestTest

            +
            public UpdateRequestTest()
            +
            • +
          +
          • +
        + +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            shouldCreateACorrectBody

            +
            public void shouldCreateACorrectBody()
            +
            • +
          + + + +
            +
          • +

            shouldCreateACorrectBodyWithNullFieldsByDefault

            +
            public void shouldCreateACorrectBodyWithNullFieldsByDefault()
            +
            • +
          + + + +
            +
          • +

            shouldConstructTheCorrectUrl

            +
            public void shouldConstructTheCorrectUrl()
            +
            • +
          + + + +
            +
          • +

            shouldConstructTheCorrectDefaultFetchUrl

            +
            public void shouldConstructTheCorrectDefaultFetchUrl()
            +
            • +
          + + + +
            +
          • +

            shouldConstructTheCorrectUrlWithExtraParam

            +
            public void shouldConstructTheCorrectUrlWithExtraParam()
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/CollectionUpdateRequest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/CollectionUpdateRequest.html new file mode 100644 index 0000000..8a83788 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/request/class-use/CollectionUpdateRequest.html @@ -0,0 +1,159 @@ + + + + + +Uses of Class com.rallydev.rest.request.CollectionUpdateRequest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.request.CollectionUpdateRequest

      +
      +
      + +
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/CollectionUpdateRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/CollectionUpdateRequestTest.html new file mode 100644 index 0000000..88c7a95 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/request/class-use/CollectionUpdateRequestTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.request.CollectionUpdateRequestTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.request.CollectionUpdateRequestTest

      +
      +
      No usage of com.rallydev.rest.request.CollectionUpdateRequestTest
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/CreateRequest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/CreateRequest.html index 108ce27..3344800 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/CreateRequest.html +++ b/src/main/resources/doc/com/rallydev/rest/request/class-use/CreateRequest.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.request.CreateRequest (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.request.CreateRequest (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/CreateRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/CreateRequestTest.html new file mode 100644 index 0000000..73adbf2 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/request/class-use/CreateRequestTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.request.CreateRequestTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.request.CreateRequestTest

      +
      +
      No usage of com.rallydev.rest.request.CreateRequestTest
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/DeleteRequest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/DeleteRequest.html index 782db6f..77bd178 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/DeleteRequest.html +++ b/src/main/resources/doc/com/rallydev/rest/request/class-use/DeleteRequest.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.request.DeleteRequest (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.request.DeleteRequest (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/DeleteRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/DeleteRequestTest.html new file mode 100644 index 0000000..7b46d2b --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/request/class-use/DeleteRequestTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.request.DeleteRequestTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.request.DeleteRequestTest

      +
      +
      No usage of com.rallydev.rest.request.DeleteRequestTest
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/GetRequest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/GetRequest.html index 7c82c17..6995415 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/GetRequest.html +++ b/src/main/resources/doc/com/rallydev/rest/request/class-use/GetRequest.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.request.GetRequest (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.request.GetRequest (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/GetRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/GetRequestTest.html new file mode 100644 index 0000000..de16a8e --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/request/class-use/GetRequestTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.request.GetRequestTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.request.GetRequestTest

      +
      +
      No usage of com.rallydev.rest.request.GetRequestTest
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/QueryRequest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/QueryRequest.html index 550cb87..0b8b28c 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/QueryRequest.html +++ b/src/main/resources/doc/com/rallydev/rest/request/class-use/QueryRequest.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.request.QueryRequest (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.request.QueryRequest (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/QueryRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/QueryRequestTest.html new file mode 100644 index 0000000..042b2a5 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/request/class-use/QueryRequestTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.request.QueryRequestTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.request.QueryRequestTest

      +
      +
      No usage of com.rallydev.rest.request.QueryRequestTest
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/Request.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/Request.html index 3ce354c..15da546 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/Request.html +++ b/src/main/resources/doc/com/rallydev/rest/request/class-use/Request.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.request.Request (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.request.Request (Rally Rest API for Java 2.2) + @@ -99,29 +99,35 @@

      Uses of class  +CollectionUpdateRequest +
      Represents a WSAPI request to update a collection.
      + + + +class  CreateRequest
      Represents a WSAPI request to create an object.
      - + class  DeleteRequest
      Represents a WSAPI request to delete an object.
      - + class  GetRequest
      Represents a WSAPI request to retrieve a specific object.
      - + class  QueryRequest
      Represents a WSAPI request to retrieve all objects matching specified criteria.
      - + class  UpdateRequest
      Represents a WSAPI request to update an object.
      diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/RequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/RequestTest.html new file mode 100644 index 0000000..a15c491 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/request/class-use/RequestTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.request.RequestTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.request.RequestTest

      +
      +
      No usage of com.rallydev.rest.request.RequestTest
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/UpdateRequest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/UpdateRequest.html index d6b4897..34c4fae 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/UpdateRequest.html +++ b/src/main/resources/doc/com/rallydev/rest/request/class-use/UpdateRequest.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.request.UpdateRequest (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.request.UpdateRequest (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/UpdateRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/UpdateRequestTest.html new file mode 100644 index 0000000..6098124 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/request/class-use/UpdateRequestTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.request.UpdateRequestTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.request.UpdateRequestTest

      +
      +
      No usage of com.rallydev.rest.request.UpdateRequestTest
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/request/package-frame.html b/src/main/resources/doc/com/rallydev/rest/request/package-frame.html index 8900f0e..777b7a3 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/package-frame.html +++ b/src/main/resources/doc/com/rallydev/rest/request/package-frame.html @@ -2,9 +2,9 @@ - -com.rallydev.rest.request (Rally Rest API for Java 2.0) - + +com.rallydev.rest.request (Rally Rest API for Java 2.2) + @@ -12,6 +12,7 @@

      Classes

        +
      • CollectionUpdateRequest
      • CreateRequest
      • DeleteRequest
      • GetRequest
        • diff --git a/src/main/resources/doc/com/rallydev/rest/request/package-summary.html b/src/main/resources/doc/com/rallydev/rest/request/package-summary.html index 6ed0dbc..13d0548 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/package-summary.html +++ b/src/main/resources/doc/com/rallydev/rest/request/package-summary.html @@ -2,15 +2,15 @@ - -com.rallydev.rest.request (Rally Rest API for Java 2.0) - + +com.rallydev.rest.request (Rally Rest API for Java 2.2) + @@ -36,7 +36,7 @@

      • @@ -80,36 +80,42 @@

      Package com.rallydev.rest.request

      +CollectionUpdateRequest + +
      Represents a WSAPI request to update a collection.
      + + + CreateRequest
      Represents a WSAPI request to create an object.
      - + DeleteRequest
      Represents a WSAPI request to delete an object.
      - + GetRequest
      Represents a WSAPI request to retrieve a specific object.
      - + QueryRequest
      Represents a WSAPI request to retrieve all objects matching specified criteria.
      - + Request
      Base class for all WSAPI requests.
      - + UpdateRequest
      Represents a WSAPI request to update an object.
      @@ -144,7 +150,7 @@

      Package com.rallydev.r

      diff --git a/src/main/resources/doc/com/rallydev/rest/request/package-tree.html b/src/main/resources/doc/com/rallydev/rest/request/package-tree.html index 69c1718..ab9fd00 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/package-tree.html +++ b/src/main/resources/doc/com/rallydev/rest/request/package-tree.html @@ -2,15 +2,15 @@ - -com.rallydev.rest.request Class Hierarchy (Rally Rest API for Java 2.0) - + +com.rallydev.rest.request Class Hierarchy (Rally Rest API for Java 2.2) + @@ -36,7 +36,7 @@
      diff --git a/src/main/resources/doc/com/rallydev/rest/request/package-use.html b/src/main/resources/doc/com/rallydev/rest/request/package-use.html index 2fda0d1..0c7d0f0 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/package-use.html +++ b/src/main/resources/doc/com/rallydev/rest/request/package-use.html @@ -2,15 +2,15 @@ - -Uses of Package com.rallydev.rest.request (Rally Rest API for Java 2.0) - + +Uses of Package com.rallydev.rest.request (Rally Rest API for Java 2.2) + @@ -100,26 +100,31 @@

      Uses of Pack +CollectionUpdateRequest +
      Represents a WSAPI request to update a collection.
      + + + CreateRequest
      Represents a WSAPI request to create an object.
      - + DeleteRequest
      Represents a WSAPI request to delete an object.
      - + GetRequest
      Represents a WSAPI request to retrieve a specific object.
      - + QueryRequest
      Represents a WSAPI request to retrieve all objects matching specified criteria.
      - + UpdateRequest
      Represents a WSAPI request to update an object.
      diff --git a/src/main/resources/doc/com/rallydev/rest/response/CollectionUpdateResponse.html b/src/main/resources/doc/com/rallydev/rest/response/CollectionUpdateResponse.html new file mode 100644 index 0000000..43bc7e4 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/CollectionUpdateResponse.html @@ -0,0 +1,278 @@ + + + + + +CollectionUpdateResponse (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest.response
      +

      Class CollectionUpdateResponse

      +
      +
      + +
      +
        +
      • +
        +
        +
        public class CollectionUpdateResponse
+extends Response
        +
        Represents a WSAPI response from updating a collection.
        +
        • +
      +
      +
      + +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Detail

          + + + +
            +
          • +

            CollectionUpdateResponse

            +
            public CollectionUpdateResponse(String updateResponse)
            +
            Create a new collection update response from the specified JSON encoded string. + Note that this class is only usable with WSAPI versions 2.0 and above.
            +
            Parameters:
            updateResponse - the JSON encoded string
            +
            • +
          +
          • +
        + +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            getResults

            +
            public JsonArray getResults()
            +
            Get the results of the collection update
            +
            Returns:
            the results
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/CollectionUpdateResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/CollectionUpdateResponseTest.html new file mode 100644 index 0000000..b8ad46c --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/CollectionUpdateResponseTest.html @@ -0,0 +1,269 @@ + + + + + +CollectionUpdateResponseTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest.response
      +

      Class CollectionUpdateResponseTest

      +
      +
      +
        +
      • java.lang.Object
        • +
      • +
          +
        • com.rallydev.rest.response.CollectionUpdateResponseTest
          • +
        +
        • +
      +
      +
        +
      • +
        +
        +
        public class CollectionUpdateResponseTest
+extends Object
        +
        • +
      +
      +
      + +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Detail

          + + + +
            +
          • +

            CollectionUpdateResponseTest

            +
            public CollectionUpdateResponseTest()
            +
            • +
          +
          • +
        + +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            shouldReturnResults

            +
            public void shouldReturnResults()
            +
            • +
          + + + +
            +
          • +

            shouldReturnNoErrors

            +
            public void shouldReturnNoErrors()
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/CreateResponse.html b/src/main/resources/doc/com/rallydev/rest/response/CreateResponse.html index 67474a3..c8d3bf0 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/CreateResponse.html +++ b/src/main/resources/doc/com/rallydev/rest/response/CreateResponse.html @@ -2,15 +2,15 @@ - -CreateResponse (Rally Rest API for Java 2.0) - + +CreateResponse (Rally Rest API for Java 2.2) + @@ -36,7 +36,7 @@

      @@ -233,7 +233,7 @@

      getObject

      diff --git a/src/main/resources/doc/com/rallydev/rest/response/CreateResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/CreateResponseTest.html new file mode 100644 index 0000000..1ba7a2c --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/CreateResponseTest.html @@ -0,0 +1,269 @@ + + + + + +CreateResponseTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest.response
      +

      Class CreateResponseTest

      +
      +
      + +
      +
        +
      • +
        +
        +
        public class CreateResponseTest
+extends Object
        +
        • +
      +
      +
      + +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Detail

          + + + +
            +
          • +

            CreateResponseTest

            +
            public CreateResponseTest()
            +
            • +
          +
          • +
        + +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            shouldReturnCreatedObject

            +
            public void shouldReturnCreatedObject()
            +
            • +
          + + + +
            +
          • +

            shouldReturnErrors

            +
            public void shouldReturnErrors()
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/DeleteResponse.html b/src/main/resources/doc/com/rallydev/rest/response/DeleteResponse.html index 617bbc8..e01c4c7 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/DeleteResponse.html +++ b/src/main/resources/doc/com/rallydev/rest/response/DeleteResponse.html @@ -2,15 +2,15 @@ - -DeleteResponse (Rally Rest API for Java 2.0) - + +DeleteResponse (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/response/DeleteResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/DeleteResponseTest.html new file mode 100644 index 0000000..6f1d878 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/DeleteResponseTest.html @@ -0,0 +1,269 @@ + + + + + +DeleteResponseTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest.response
      +

      Class DeleteResponseTest

      +
      +
      + +
      +
        +
      • +
        +
        +
        public class DeleteResponseTest
+extends Object
        +
        • +
      +
      +
      + +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Detail

          + + + +
            +
          • +

            DeleteResponseTest

            +
            public DeleteResponseTest()
            +
            • +
          +
          • +
        + +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            shouldReturnErrors

            +
            public void shouldReturnErrors()
            +
            • +
          + + + +
            +
          • +

            shouldReturnNoErrors

            +
            public void shouldReturnNoErrors()
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/GetResponse.html b/src/main/resources/doc/com/rallydev/rest/response/GetResponse.html index 5e74535..19787b5 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/GetResponse.html +++ b/src/main/resources/doc/com/rallydev/rest/response/GetResponse.html @@ -2,15 +2,15 @@ - -GetResponse (Rally Rest API for Java 2.0) - + +GetResponse (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/response/GetResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/GetResponseTest.html new file mode 100644 index 0000000..a871147 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/GetResponseTest.html @@ -0,0 +1,269 @@ + + + + + +GetResponseTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest.response
      +

      Class GetResponseTest

      +
      +
      + +
      +
        +
      • +
        +
        +
        public class GetResponseTest
+extends Object
        +
        • +
      +
      +
      + +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Detail

          + + + +
            +
          • +

            GetResponseTest

            +
            public GetResponseTest()
            +
            • +
          +
          • +
        + +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            shouldReturnErrors

            +
            public void shouldReturnErrors()
            +
            • +
          + + + +
            +
          • +

            shouldReturnNoErrors

            +
            public void shouldReturnNoErrors()
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/QueryResponse.html b/src/main/resources/doc/com/rallydev/rest/response/QueryResponse.html index d551826..135ebf4 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/QueryResponse.html +++ b/src/main/resources/doc/com/rallydev/rest/response/QueryResponse.html @@ -2,15 +2,15 @@ - -QueryResponse (Rally Rest API for Java 2.0) - + +QueryResponse (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/response/QueryResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/QueryResponseTest.html new file mode 100644 index 0000000..5044d45 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/QueryResponseTest.html @@ -0,0 +1,269 @@ + + + + + +QueryResponseTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest.response
      +

      Class QueryResponseTest

      +
      +
      + +
      +
        +
      • +
        +
        +
        public class QueryResponseTest
+extends Object
        +
        • +
      +
      +
      + +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Detail

          + + + +
            +
          • +

            QueryResponseTest

            +
            public QueryResponseTest()
            +
            • +
          +
          • +
        + +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            shouldReturnResults

            +
            public void shouldReturnResults()
            +
            • +
          + + + +
            +
          • +

            shouldReturnNoErrors

            +
            public void shouldReturnNoErrors()
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/Response.html b/src/main/resources/doc/com/rallydev/rest/response/Response.html index 977eef0..5a0ac38 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/Response.html +++ b/src/main/resources/doc/com/rallydev/rest/response/Response.html @@ -2,15 +2,15 @@ - -Response (Rally Rest API for Java 2.0) - + +Response (Rally Rest API for Java 2.2) + @@ -96,7 +96,7 @@

      Class Response

    • Direct Known Subclasses:
      -
      CreateResponse, DeleteResponse, GetResponse, QueryResponse, UpdateResponse
      +
      CollectionUpdateResponse, CreateResponse, DeleteResponse, GetResponse, QueryResponse, UpdateResponse

      diff --git a/src/main/resources/doc/com/rallydev/rest/response/ResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/ResponseTest.html new file mode 100644 index 0000000..d0be7b3 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/ResponseTest.html @@ -0,0 +1,295 @@ + + + + + +ResponseTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest.response
      +

      Class ResponseTest

      +
      +
      + +
      +
        +
      • +
        +
        +
        public class ResponseTest
+extends Object
        +
        • +
      +
      +
      + +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Detail

          + + + +
            +
          • +

            ResponseTest

            +
            public ResponseTest()
            +
            • +
          +
          • +
        + +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            shouldReturnErrors

            +
            public void shouldReturnErrors()
            +
            • +
          + + + +
            +
          • +

            shouldReturnNoErrors

            +
            public void shouldReturnNoErrors()
            +
            • +
          + + + +
            +
          • +

            shouldReturnWarnings

            +
            public void shouldReturnWarnings()
            +
            • +
          + + + +
            +
          • +

            shouldReturnNoWarnings

            +
            public void shouldReturnNoWarnings()
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/UpdateResponse.html b/src/main/resources/doc/com/rallydev/rest/response/UpdateResponse.html index 3dea70c..6650fc1 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/UpdateResponse.html +++ b/src/main/resources/doc/com/rallydev/rest/response/UpdateResponse.html @@ -2,15 +2,15 @@ - -UpdateResponse (Rally Rest API for Java 2.0) - + +UpdateResponse (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/response/UpdateResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/UpdateResponseTest.html new file mode 100644 index 0000000..e215bc8 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/UpdateResponseTest.html @@ -0,0 +1,269 @@ + + + + + +UpdateResponseTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.rallydev.rest.response
      +

      Class UpdateResponseTest

      +
      +
      + +
      +
        +
      • +
        +
        +
        public class UpdateResponseTest
+extends Object
        +
        • +
      +
      +
      + +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Detail

          + + + +
            +
          • +

            UpdateResponseTest

            +
            public UpdateResponseTest()
            +
            • +
          +
          • +
        + +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            shouldReturnUpdatedObject

            +
            public void shouldReturnUpdatedObject()
            +
            • +
          + + + +
            +
          • +

            shouldReturnErrors

            +
            public void shouldReturnErrors()
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/CollectionUpdateResponse.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/CollectionUpdateResponse.html new file mode 100644 index 0000000..197da83 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/class-use/CollectionUpdateResponse.html @@ -0,0 +1,159 @@ + + + + + +Uses of Class com.rallydev.rest.response.CollectionUpdateResponse (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.response.CollectionUpdateResponse

      +
      +
      + +
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/CollectionUpdateResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/CollectionUpdateResponseTest.html new file mode 100644 index 0000000..4d94984 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/class-use/CollectionUpdateResponseTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.response.CollectionUpdateResponseTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.response.CollectionUpdateResponseTest

      +
      +
      No usage of com.rallydev.rest.response.CollectionUpdateResponseTest
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/CreateResponse.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/CreateResponse.html index f3fb7a2..0d21e67 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/CreateResponse.html +++ b/src/main/resources/doc/com/rallydev/rest/response/class-use/CreateResponse.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.response.CreateResponse (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.response.CreateResponse (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/CreateResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/CreateResponseTest.html new file mode 100644 index 0000000..af0035f --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/class-use/CreateResponseTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.response.CreateResponseTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.response.CreateResponseTest

      +
      +
      No usage of com.rallydev.rest.response.CreateResponseTest
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/DeleteResponse.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/DeleteResponse.html index 451ad02..ef543d8 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/DeleteResponse.html +++ b/src/main/resources/doc/com/rallydev/rest/response/class-use/DeleteResponse.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.response.DeleteResponse (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.response.DeleteResponse (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/DeleteResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/DeleteResponseTest.html new file mode 100644 index 0000000..9f4b573 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/class-use/DeleteResponseTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.response.DeleteResponseTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.response.DeleteResponseTest

      +
      +
      No usage of com.rallydev.rest.response.DeleteResponseTest
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/GetResponse.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/GetResponse.html index 5bb02fe..15d3ed5 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/GetResponse.html +++ b/src/main/resources/doc/com/rallydev/rest/response/class-use/GetResponse.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.response.GetResponse (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.response.GetResponse (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/GetResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/GetResponseTest.html new file mode 100644 index 0000000..92a4655 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/class-use/GetResponseTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.response.GetResponseTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.response.GetResponseTest

      +
      +
      No usage of com.rallydev.rest.response.GetResponseTest
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/QueryResponse.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/QueryResponse.html index 46abbf1..990ba64 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/QueryResponse.html +++ b/src/main/resources/doc/com/rallydev/rest/response/class-use/QueryResponse.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.response.QueryResponse (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.response.QueryResponse (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/QueryResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/QueryResponseTest.html new file mode 100644 index 0000000..a540259 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/class-use/QueryResponseTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.response.QueryResponseTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.response.QueryResponseTest

      +
      +
      No usage of com.rallydev.rest.response.QueryResponseTest
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/Response.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/Response.html index cecc852..d4a863a 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/Response.html +++ b/src/main/resources/doc/com/rallydev/rest/response/class-use/Response.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.response.Response (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.response.Response (Rally Rest API for Java 2.2) + @@ -99,29 +99,35 @@

      Uses of class  +CollectionUpdateResponse +
      Represents a WSAPI response from updating a collection.
      + + + +class  CreateResponse
      Represents a WSAPI response from creating an object
      - + class  DeleteResponse
      Represents a WSAPI response from deleting an object
      - + class  GetResponse
      Represents a WSAPI response from retrieving a single object.
      - + class  QueryResponse
      Represents a WSAPI response from querying for objects.
      - + class  UpdateResponse
      Represents a WSAPI response from updating an object.
      diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/ResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/ResponseTest.html new file mode 100644 index 0000000..eec3088 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/class-use/ResponseTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.response.ResponseTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.response.ResponseTest

      +
      +
      No usage of com.rallydev.rest.response.ResponseTest
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/UpdateResponse.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/UpdateResponse.html index 84e4756..9bbd953 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/UpdateResponse.html +++ b/src/main/resources/doc/com/rallydev/rest/response/class-use/UpdateResponse.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.response.UpdateResponse (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.response.UpdateResponse (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/UpdateResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/UpdateResponseTest.html new file mode 100644 index 0000000..1efc3e7 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/response/class-use/UpdateResponseTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.response.UpdateResponseTest (Rally Rest API for Java 2.2) + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      com.rallydev.rest.response.UpdateResponseTest

      +
      +
      No usage of com.rallydev.rest.response.UpdateResponseTest
      + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + + + diff --git a/src/main/resources/doc/com/rallydev/rest/response/package-frame.html b/src/main/resources/doc/com/rallydev/rest/response/package-frame.html index 6c0d3f3..31296d9 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/package-frame.html +++ b/src/main/resources/doc/com/rallydev/rest/response/package-frame.html @@ -2,9 +2,9 @@ - -com.rallydev.rest.response (Rally Rest API for Java 2.0) - + +com.rallydev.rest.response (Rally Rest API for Java 2.2) + @@ -12,6 +12,7 @@

      Classes

        +
      • CollectionUpdateResponse
      • CreateResponse
      • DeleteResponse
      • GetResponse
        • diff --git a/src/main/resources/doc/com/rallydev/rest/response/package-summary.html b/src/main/resources/doc/com/rallydev/rest/response/package-summary.html index c2fb236..50f57e9 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/package-summary.html +++ b/src/main/resources/doc/com/rallydev/rest/response/package-summary.html @@ -2,15 +2,15 @@ - -com.rallydev.rest.response (Rally Rest API for Java 2.0) - + +com.rallydev.rest.response (Rally Rest API for Java 2.2) + @@ -80,36 +80,42 @@

        Package com.rallydev.rest.response

        +CollectionUpdateResponse + +
        Represents a WSAPI response from updating a collection.
        + + + CreateResponse
        Represents a WSAPI response from creating an object
        - + DeleteResponse
        Represents a WSAPI response from deleting an object
        - + GetResponse
        Represents a WSAPI response from retrieving a single object.
        - + QueryResponse
        Represents a WSAPI response from querying for objects.
        - + Response
        Represents a WSAPI response.
        - + UpdateResponse
        Represents a WSAPI response from updating an object.
        diff --git a/src/main/resources/doc/com/rallydev/rest/response/package-tree.html b/src/main/resources/doc/com/rallydev/rest/response/package-tree.html index ddc79e4..90ba57d 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/package-tree.html +++ b/src/main/resources/doc/com/rallydev/rest/response/package-tree.html @@ -2,15 +2,15 @@ - -com.rallydev.rest.response Class Hierarchy (Rally Rest API for Java 2.0) - + +com.rallydev.rest.response Class Hierarchy (Rally Rest API for Java 2.2) + @@ -76,6 +76,7 @@

        Class Hierarchy

        • com.rallydev.rest.response.Response
            +
          • com.rallydev.rest.response.CollectionUpdateResponse
          • com.rallydev.rest.response.CreateResponse
          • com.rallydev.rest.response.DeleteResponse
          • com.rallydev.rest.response.GetResponse
            • diff --git a/src/main/resources/doc/com/rallydev/rest/response/package-use.html b/src/main/resources/doc/com/rallydev/rest/response/package-use.html index 0326d99..7cc755b 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/package-use.html +++ b/src/main/resources/doc/com/rallydev/rest/response/package-use.html @@ -2,15 +2,15 @@ - -Uses of Package com.rallydev.rest.response (Rally Rest API for Java 2.0) - + +Uses of Package com.rallydev.rest.response (Rally Rest API for Java 2.2) + @@ -100,26 +100,31 @@

            Uses of Pac +CollectionUpdateResponse +
            Represents a WSAPI response from updating a collection.
            + + + CreateResponse
            Represents a WSAPI response from creating an object
            - + DeleteResponse
            Represents a WSAPI response from deleting an object
            - + GetResponse
            Represents a WSAPI response from retrieving a single object.
            - + QueryResponse
            Represents a WSAPI response from querying for objects.
            - + UpdateResponse
            Represents a WSAPI response from updating an object.
            diff --git a/src/main/resources/doc/com/rallydev/rest/util/Fetch.html b/src/main/resources/doc/com/rallydev/rest/util/Fetch.html index c891828..663f2cf 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/Fetch.html +++ b/src/main/resources/doc/com/rallydev/rest/util/Fetch.html @@ -2,15 +2,15 @@ - -Fetch (Rally Rest API for Java 2.0) - + +Fetch (Rally Rest API for Java 2.2) + @@ -37,7 +37,7 @@
            • Frames
              • @@ -273,7 +273,7 @@

              toString

              • Frames
                • diff --git a/src/main/resources/doc/com/rallydev/rest/util/FetchTest.html b/src/main/resources/doc/com/rallydev/rest/util/FetchTest.html new file mode 100644 index 0000000..7e4f516 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/util/FetchTest.html @@ -0,0 +1,282 @@ + + + + + +FetchTest (Rally Rest API for Java 2.2) + + + + + + + +
                + + + + + +
                +
                + + + +
                + +
                +
                +
                  +
                • Summary: 
                  • +
                • Nested | 
                  • +
                • Field | 
                  • +
                • Constr | 
                  • +
                • Method
                  • +
                + +
                + + +
                + + +
                +
                com.rallydev.rest.util
                +

                Class FetchTest

                +
                +
                + +
                +
                  +
                • +
                  +
                  +
                  public class FetchTest
+extends Object
                  +
                  • +
                +
                +
                + +
                +
                +
                  +
                • + +
                    +
                  • + + +

                    Constructor Detail

                    + + + +
                      +
                    • +

                      FetchTest

                      +
                      public FetchTest()
                      +
                      • +
                    +
                    • +
                  + +
                    +
                  • + + +

                    Method Detail

                    + + + +
                      +
                    • +

                      shouldProvideCorrectDefaultFetch

                      +
                      public void shouldProvideCorrectDefaultFetch()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldProvideCorrectFetch

                      +
                      public void shouldProvideCorrectFetch()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldBeAbleToAddRemoveFetch

                      +
                      public void shouldBeAbleToAddRemoveFetch()
                      +
                      • +
                    +
                    • +
                  +
                  • +
                +
                +
                + + +
                + + + + + +
                +
                + + + +
                + +
                +
                +
                  +
                • Summary: 
                  • +
                • Nested | 
                  • +
                • Field | 
                  • +
                • Constr | 
                  • +
                • Method
                  • +
                + +
                + + +
                + + + diff --git a/src/main/resources/doc/com/rallydev/rest/util/InvalidURLException.html b/src/main/resources/doc/com/rallydev/rest/util/InvalidURLException.html index b1f3fb4..66a585b 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/InvalidURLException.html +++ b/src/main/resources/doc/com/rallydev/rest/util/InvalidURLException.html @@ -2,9 +2,9 @@ - + InvalidURLException (Rally Rest API for Java 2.0) - + diff --git a/src/main/resources/doc/com/rallydev/rest/util/QueryFilter.html b/src/main/resources/doc/com/rallydev/rest/util/QueryFilter.html index 3f18ce9..8105a65 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/QueryFilter.html +++ b/src/main/resources/doc/com/rallydev/rest/util/QueryFilter.html @@ -2,15 +2,15 @@ - -QueryFilter (Rally Rest API for Java 2.0) - + +QueryFilter (Rally Rest API for Java 2.2) + @@ -36,7 +36,7 @@
                @@ -310,7 +310,7 @@

                or

                diff --git a/src/main/resources/doc/com/rallydev/rest/util/QueryFilterTest.html b/src/main/resources/doc/com/rallydev/rest/util/QueryFilterTest.html new file mode 100644 index 0000000..298197c --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/util/QueryFilterTest.html @@ -0,0 +1,360 @@ + + + + + +QueryFilterTest (Rally Rest API for Java 2.2) + + + + + + + +
                + + + + + +
                +
                + + + +
                + +
                +
                +
                  +
                • Summary: 
                  • +
                • Nested | 
                  • +
                • Field | 
                  • +
                • Constr | 
                  • +
                • Method
                  • +
                + +
                + + +
                + + +
                +
                com.rallydev.rest.util
                +

                Class QueryFilterTest

                +
                +
                + +
                +
                  +
                • +
                  +
                  +
                  public class QueryFilterTest
+extends Object
                  +
                  • +
                +
                +
                + +
                +
                +
                  +
                • + +
                    +
                  • + + +

                    Constructor Detail

                    + + + +
                      +
                    • +

                      QueryFilterTest

                      +
                      public QueryFilterTest()
                      +
                      • +
                    +
                    • +
                  + +
                    +
                  • + + +

                    Method Detail

                    + + + +
                      +
                    • +

                      shouldCreateCorrectQueryForString

                      +
                      public void shouldCreateCorrectQueryForString()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldCreateCorrectQueryForNull

                      +
                      public void shouldCreateCorrectQueryForNull()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldCreateQuotedQueryForStringWithSpaces

                      +
                      public void shouldCreateQuotedQueryForStringWithSpaces()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldCreateCorrectQueryForRef

                      +
                      public void shouldCreateCorrectQueryForRef()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldCreateCorrectQueryForNumber

                      +
                      public void shouldCreateCorrectQueryForNumber()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldCreateCorrectAndedQuery

                      +
                      public void shouldCreateCorrectAndedQuery()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldCreateCorrectStaticAndedQuery

                      +
                      public void shouldCreateCorrectStaticAndedQuery()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldCreateCorrectOredQuery

                      +
                      public void shouldCreateCorrectOredQuery()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldCreateCorrectStaticOredQuery

                      +
                      public void shouldCreateCorrectStaticOredQuery()
                      +
                      • +
                    +
                    • +
                  +
                  • +
                +
                +
                + + +
                + + + + + +
                +
                + + + +
                + +
                +
                +
                  +
                • Summary: 
                  • +
                • Nested | 
                  • +
                • Field | 
                  • +
                • Constr | 
                  • +
                • Method
                  • +
                + +
                + + +
                + + + diff --git a/src/main/resources/doc/com/rallydev/rest/util/Ref.html b/src/main/resources/doc/com/rallydev/rest/util/Ref.html index cb48c73..8af4b78 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/Ref.html +++ b/src/main/resources/doc/com/rallydev/rest/util/Ref.html @@ -2,15 +2,15 @@ - -Ref (Rally Rest API for Java 2.0) - + +Ref (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/util/RefTest.html b/src/main/resources/doc/com/rallydev/rest/util/RefTest.html new file mode 100644 index 0000000..b92af81 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/util/RefTest.html @@ -0,0 +1,451 @@ + + + + + +RefTest (Rally Rest API for Java 2.2) + + + + + + + +
                + + + + + +
                +
                + + + +
                + +
                +
                +
                  +
                • Summary: 
                  • +
                • Nested | 
                  • +
                • Field | 
                  • +
                • Constr | 
                  • +
                • Method
                  • +
                + +
                + + +
                + + +
                +
                com.rallydev.rest.util
                +

                Class RefTest

                +
                +
                + +
                +
                  +
                • +
                  +
                  +
                  public class RefTest
+extends Object
                  +
                  • +
                +
                +
                + +
                +
                +
                  +
                • + +
                    +
                  • + + +

                    Constructor Detail

                    + + + +
                      +
                    • +

                      RefTest

                      +
                      public RefTest()
                      +
                      • +
                    +
                    • +
                  + +
                    +
                  • + + +

                    Method Detail

                    + + + +
                      +
                    • +

                      shouldDetectValidRefs

                      +
                      public void shouldDetectValidRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldDetectValidDynatypeRefs

                      +
                      public void shouldDetectValidDynatypeRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldDetectInvalidRefs

                      +
                      public void shouldDetectInvalidRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldReturnValidRelativeRefs

                      +
                      public void shouldReturnValidRelativeRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldReturnValidDynatypeRelativeRefs

                      +
                      public void shouldReturnValidDynatypeRelativeRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldReturnNullRelativeRefs

                      +
                      public void shouldReturnNullRelativeRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldReturnTypesFromRefs

                      +
                      public void shouldReturnTypesFromRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldReturnTypesFromDynatypeRefs

                      +
                      public void shouldReturnTypesFromDynatypeRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldReturnNullTypesFromRefs

                      +
                      public void shouldReturnNullTypesFromRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldReturnOidsFromRefs

                      +
                      public void shouldReturnOidsFromRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldReturnOidsFromDynatypeRefs

                      +
                      public void shouldReturnOidsFromDynatypeRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldReturnNullOidsFromRefs

                      +
                      public void shouldReturnNullOidsFromRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldSupportWsapiVersionXinRefs

                      +
                      public void shouldSupportWsapiVersionXinRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldSupportWorkspacePermissionRefs

                      +
                      public void shouldSupportWorkspacePermissionRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldSupportProjectPermissionRefs

                      +
                      public void shouldSupportProjectPermissionRefs()
                      +
                      • +
                    + + + +
                      +
                    • +

                      shouldSupportCollectionRefs

                      +
                      public void shouldSupportCollectionRefs()
                      +
                      • +
                    +
                    • +
                  +
                  • +
                +
                +
                + + +
                + + + + + +
                +
                + + + +
                + +
                +
                +
                  +
                • Summary: 
                  • +
                • Nested | 
                  • +
                • Field | 
                  • +
                • Constr | 
                  • +
                • Method
                  • +
                + +
                + + +
                + + + diff --git a/src/main/resources/doc/com/rallydev/rest/util/class-use/Fetch.html b/src/main/resources/doc/com/rallydev/rest/util/class-use/Fetch.html index 89e50a3..b6f4e27 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/class-use/Fetch.html +++ b/src/main/resources/doc/com/rallydev/rest/util/class-use/Fetch.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.util.Fetch (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.util.Fetch (Rally Rest API for Java 2.2) + @@ -99,24 +99,30 @@

                Uses of Fetch -CreateRequest.getFetch() -
                Get the current list of fields to be returned on the created object.
                +CollectionUpdateRequest.getFetch() +
                Get the current list of fields to be returned on the updated object.
                Fetch -UpdateRequest.getFetch() -
                Get the current list of fields to be returned on the updated object.
                +GetRequest.getFetch() +
                Get the current list of fields to be returned on the retrieved object.
                Fetch -GetRequest.getFetch() -
                Get the current list of fields to be returned on the retrieved object.
                +UpdateRequest.getFetch() +
                Get the current list of fields to be returned on the updated object.
                Fetch +CreateRequest.getFetch() +
                Get the current list of fields to be returned on the created object.
                + + + +Fetch QueryRequest.getFetch()
                Get the current list of fields to be returned on the matching objects.
                @@ -132,24 +138,30 @@

                Uses of void -CreateRequest.setFetch(Fetch fetch) -
                Set the current list of fields to be returned on the created object.
                +CollectionUpdateRequest.setFetch(Fetch fetch) +
                Set the current list of fields to be returned on the updated object.
                void -UpdateRequest.setFetch(Fetch fetch) -
                Set the current list of fields to be returned on the updated object.
                +GetRequest.setFetch(Fetch fetch) +
                Set the current list of fields to be returned on the retrieved object.
                void -GetRequest.setFetch(Fetch fetch) -
                Set the current list of fields to be returned on the retrieved object.
                +UpdateRequest.setFetch(Fetch fetch) +
                Set the current list of fields to be returned on the updated object.
                void +CreateRequest.setFetch(Fetch fetch) +
                Set the current list of fields to be returned on the created object.
                + + + +void QueryRequest.setFetch(Fetch fetch)
                Set the current list of fields to be returned on the matching objects.
                diff --git a/src/main/resources/doc/com/rallydev/rest/util/class-use/FetchTest.html b/src/main/resources/doc/com/rallydev/rest/util/class-use/FetchTest.html new file mode 100644 index 0000000..a2e9385 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/util/class-use/FetchTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.util.FetchTest (Rally Rest API for Java 2.2) + + + + + + + +
                + + + + + +
                +
                +
                  +
                • Prev
                  • +
                • Next
                  • +
                + + +
                + +
                + + +
                + +
                +

                Uses of Class
                com.rallydev.rest.util.FetchTest

                +
                +
                No usage of com.rallydev.rest.util.FetchTest
                + +
                + + + + + +
                +
                +
                  +
                • Prev
                  • +
                • Next
                  • +
                + + +
                + +
                + + +
                + + + diff --git a/src/main/resources/doc/com/rallydev/rest/util/class-use/InvalidURLException.html b/src/main/resources/doc/com/rallydev/rest/util/class-use/InvalidURLException.html index 2cdb939..a535b87 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/class-use/InvalidURLException.html +++ b/src/main/resources/doc/com/rallydev/rest/util/class-use/InvalidURLException.html @@ -2,9 +2,9 @@ - + Uses of Class com.rallydev.rest.util.InvalidURLException (Rally Rest API for Java 2.0) - + diff --git a/src/main/resources/doc/com/rallydev/rest/util/class-use/QueryFilter.html b/src/main/resources/doc/com/rallydev/rest/util/class-use/QueryFilter.html index 17041b1..beba820 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/class-use/QueryFilter.html +++ b/src/main/resources/doc/com/rallydev/rest/util/class-use/QueryFilter.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.util.QueryFilter (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.util.QueryFilter (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/util/class-use/QueryFilterTest.html b/src/main/resources/doc/com/rallydev/rest/util/class-use/QueryFilterTest.html new file mode 100644 index 0000000..81cbeaf --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/util/class-use/QueryFilterTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.util.QueryFilterTest (Rally Rest API for Java 2.2) + + + + + + + +
                + + + + + +
                +
                +
                  +
                • Prev
                  • +
                • Next
                  • +
                + + +
                + +
                + + +
                + +
                +

                Uses of Class
                com.rallydev.rest.util.QueryFilterTest

                +
                +
                No usage of com.rallydev.rest.util.QueryFilterTest
                + +
                + + + + + +
                +
                +
                  +
                • Prev
                  • +
                • Next
                  • +
                + + +
                + +
                + + +
                + + + diff --git a/src/main/resources/doc/com/rallydev/rest/util/class-use/Ref.html b/src/main/resources/doc/com/rallydev/rest/util/class-use/Ref.html index 481b5f1..d0449d2 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/class-use/Ref.html +++ b/src/main/resources/doc/com/rallydev/rest/util/class-use/Ref.html @@ -2,15 +2,15 @@ - -Uses of Class com.rallydev.rest.util.Ref (Rally Rest API for Java 2.0) - + +Uses of Class com.rallydev.rest.util.Ref (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/com/rallydev/rest/util/class-use/RefTest.html b/src/main/resources/doc/com/rallydev/rest/util/class-use/RefTest.html new file mode 100644 index 0000000..0fa1f85 --- /dev/null +++ b/src/main/resources/doc/com/rallydev/rest/util/class-use/RefTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.rallydev.rest.util.RefTest (Rally Rest API for Java 2.2) + + + + + + + +
                + + + + + +
                +
                +
                  +
                • Prev
                  • +
                • Next
                  • +
                + + +
                + +
                + + +
                + +
                +

                Uses of Class
                com.rallydev.rest.util.RefTest

                +
                +
                No usage of com.rallydev.rest.util.RefTest
                + +
                + + + + + +
                +
                +
                  +
                • Prev
                  • +
                • Next
                  • +
                + + +
                + +
                + + +
                + + + diff --git a/src/main/resources/doc/com/rallydev/rest/util/package-frame.html b/src/main/resources/doc/com/rallydev/rest/util/package-frame.html index a8d8c26..495d866 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/package-frame.html +++ b/src/main/resources/doc/com/rallydev/rest/util/package-frame.html @@ -2,9 +2,9 @@ - -com.rallydev.rest.util (Rally Rest API for Java 2.0) - + +com.rallydev.rest.util (Rally Rest API for Java 2.2) + @@ -16,10 +16,6 @@

                Classes

              • QueryFilter
              • Ref
              -

              Exceptions

              -
              diff --git a/src/main/resources/doc/com/rallydev/rest/util/package-summary.html b/src/main/resources/doc/com/rallydev/rest/util/package-summary.html index 62394f8..886484b 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/package-summary.html +++ b/src/main/resources/doc/com/rallydev/rest/util/package-summary.html @@ -2,15 +2,15 @@ - -com.rallydev.rest.util (Rally Rest API for Java 2.0) - + +com.rallydev.rest.util (Rally Rest API for Java 2.2) + @@ -100,21 +100,6 @@

              Package com.rallydev.rest.util

              -
            • - - - - - - - - - - - - -
              Exception Summary 
              ExceptionDescription
              InvalidURLException 
              -
            diff --git a/src/main/resources/doc/com/rallydev/rest/util/package-tree.html b/src/main/resources/doc/com/rallydev/rest/util/package-tree.html index fa351e5..d42ce88 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/package-tree.html +++ b/src/main/resources/doc/com/rallydev/rest/util/package-tree.html @@ -2,15 +2,15 @@ - -com.rallydev.rest.util Class Hierarchy (Rally Rest API for Java 2.0) - + +com.rallydev.rest.util Class Hierarchy (Rally Rest API for Java 2.2) + @@ -89,19 +89,6 @@

            Class Hierarchy

          • com.rallydev.rest.util.QueryFilter (implements java.lang.Cloneable)
          • com.rallydev.rest.util.Ref
            • -
          • java.lang.Throwable (implements java.io.Serializable) - -

        diff --git a/src/main/resources/doc/com/rallydev/rest/util/package-use.html b/src/main/resources/doc/com/rallydev/rest/util/package-use.html index 54d62f2..4b66a80 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/package-use.html +++ b/src/main/resources/doc/com/rallydev/rest/util/package-use.html @@ -2,15 +2,15 @@ - -Uses of Package com.rallydev.rest.util (Rally Rest API for Java 2.0) - + +Uses of Package com.rallydev.rest.util (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/constant-values.html b/src/main/resources/doc/constant-values.html index f7610d9..7cea976 100644 --- a/src/main/resources/doc/constant-values.html +++ b/src/main/resources/doc/constant-values.html @@ -2,15 +2,15 @@ - -Constant Field Values (Rally Rest API for Java 2.0) - + +Constant Field Values (Rally Rest API for Java 2.2) + @@ -65,56 +65,6 @@

        Constant Field Values

        Contents

        - -
        -
        - - -

        com.rallydev.*

        -
        diff --git a/src/main/resources/doc/deprecated-list.html b/src/main/resources/doc/deprecated-list.html index fea1465..8e84859 100644 --- a/src/main/resources/doc/deprecated-list.html +++ b/src/main/resources/doc/deprecated-list.html @@ -2,15 +2,15 @@ - -Deprecated List (Rally Rest API for Java 2.0) - + +Deprecated List (Rally Rest API for Java 2.2) + @@ -65,6 +65,30 @@

        Deprecated API

        Contents

        +         +
        +
        + + +
        diff --git a/src/main/resources/doc/help-doc.html b/src/main/resources/doc/help-doc.html index 0a18c41..323f84c 100644 --- a/src/main/resources/doc/help-doc.html +++ b/src/main/resources/doc/help-doc.html @@ -2,15 +2,15 @@ - -API Help (Rally Rest API for Java 2.0) - + +API Help (Rally Rest API for Java 2.2) + diff --git a/src/main/resources/doc/index-files/index-1.html b/src/main/resources/doc/index-files/index-1.html index 7a1f06a..91295ea 100644 --- a/src/main/resources/doc/index-files/index-1.html +++ b/src/main/resources/doc/index-files/index-1.html @@ -2,15 +2,15 @@ - -A-Index (Rally Rest API for Java 2.0) - + +A-Index (Rally Rest API for Java 2.2) + @@ -62,7 +62,7 @@
        -
        A C D F G I O Q R S T U W  +
        A B C D F G H I O Q R S T U W 

        A

        @@ -79,8 +79,16 @@

        A

        Get a query filter that is the ANDed combination of the specified filters.
        +
        ApiKeyClient - Class in com.rallydev.rest.client
        +
        +
        A HttpClient which authenticates using an API Key.
        +
        +
        ApiKeyClient(URI, String) - Constructor for class com.rallydev.rest.client.ApiKeyClient
        +
        +
        Construct a new client.
        +
        -A C D F G I O Q R S T U W 
        +A B C D F G H I O Q R S T U W 
        diff --git a/src/main/resources/doc/index-files/index-10.html b/src/main/resources/doc/index-files/index-10.html index bca4850..1e2159a 100644 --- a/src/main/resources/doc/index-files/index-10.html +++ b/src/main/resources/doc/index-files/index-10.html @@ -2,15 +2,15 @@ - -S-Index (Rally Rest API for Java 2.0) - + +Q-Index (Rally Rest API for Java 2.2) + @@ -62,95 +62,45 @@
        -
        A C D F G I O Q R S T U W  +
        A B C D F G H I O Q R S T U W  -

        S

        +

        Q

        -
        setApplicationName(String) - Method in class com.rallydev.rest.RallyRestApi
        +
        query(QueryRequest) - Method in class com.rallydev.rest.RallyRestApi
        -
        Set the value of the X-RallyIntegrationName header included on all requests.
        +
        Query for objects matching the specified request.
        -
        setApplicationVendor(String) - Method in class com.rallydev.rest.RallyRestApi
        +
        QueryFilter - Class in com.rallydev.rest.util
        -
        Set the value of the X-RallyIntegrationVendor header included on all requests.
        +
        Represents a query filter to be applied to query requests.
        -
        setApplicationVersion(String) - Method in class com.rallydev.rest.RallyRestApi
        +
        QueryFilter(String, String, String) - Constructor for class com.rallydev.rest.util.QueryFilter
        -
        Set the value of the X-RallyIntegrationVersion header included on all requests.
        +
        Create a new query filter with the specified options.
        -
        setFetch(Fetch) - Method in class com.rallydev.rest.request.CreateRequest
        +
        QueryRequest - Class in com.rallydev.rest.request
        -
        Set the current list of fields to be returned on the created object.
        +
        Represents a WSAPI request to retrieve all objects matching specified criteria.
        -
        setFetch(Fetch) - Method in class com.rallydev.rest.request.GetRequest
        +
        QueryRequest(String) - Constructor for class com.rallydev.rest.request.QueryRequest
        -
        Set the current list of fields to be returned on the retrieved object.
        +
        Create a new query request for the specified type.
        -
        setFetch(Fetch) - Method in class com.rallydev.rest.request.QueryRequest
        +
        QueryRequest(JsonObject) - Constructor for class com.rallydev.rest.request.QueryRequest
        -
        Set the current list of fields to be returned on the matching objects.
        +
        Create a new query request for the specified collection.
        -
        setFetch(Fetch) - Method in class com.rallydev.rest.request.UpdateRequest
        +
        QueryResponse - Class in com.rallydev.rest.response
        -
        Set the current list of fields to be returned on the updated object.
        +
        Represents a WSAPI response from querying for objects.
        -
        setLimit(int) - Method in class com.rallydev.rest.request.QueryRequest
        +
        QueryResponse(String) - Constructor for class com.rallydev.rest.response.QueryResponse
        -
        Set the maximum number of records to be returned from the query.
        -
        -
        setOrder(String) - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        Get the order by which the result set will be sorted.
        -
        -
        setPageSize(int) - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        Set the page size of the result set.
        -
        -
        setParams(List<NameValuePair>) - Method in class com.rallydev.rest.request.Request
        -
        -
        Set the list of additional parameters included in this request.
        -
        -
        setProject(String) - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        Specify the project which the result set should be scoped to.

        - The default is the user's default project.

        -
        -
        setProxy(URI) - Method in class com.rallydev.rest.RallyRestApi
        -
        -
        Set the unauthenticated proxy server to use.
        -
        -
        setProxy(URI, String, String) - Method in class com.rallydev.rest.RallyRestApi
        -
        -
        Set the authenticated proxy server to use.
        -
        -
        setQueryFilter(QueryFilter) - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        Set a filter by which the result set will be narrowed down.
        -
        -
        setScopedDown(boolean) - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        If a project has been specified, set whether to include matching objects in child projects in the result set.
        -
        -
        setScopedUp(boolean) - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        If a project has been specified, set whether to include matching objects in parent projects in the result set.
        -
        -
        setStart(int) - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        Set the 1-based start index of the result set.
        -
        -
        setWorkspace(String) - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        Specify the workspace which the result set should be scoped to.

        - The default is the user's default workspace.

        -
        -
        setWsapiVersion(String) - Method in class com.rallydev.rest.RallyRestApi
        -
        -
        Set the current version of the WSAPI being targeted.
        +
        Create a new query response from the specified JSON encoded string.
        -A C D F G I O Q R S T U W 
        +A B C D F G H I O Q R S T U W 
        diff --git a/src/main/resources/doc/index-files/index-11.html b/src/main/resources/doc/index-files/index-11.html index 9206240..8da52d0 100644 --- a/src/main/resources/doc/index-files/index-11.html +++ b/src/main/resources/doc/index-files/index-11.html @@ -2,15 +2,15 @@ - -T-Index (Rally Rest API for Java 2.0) - + +R-Index (Rally Rest API for Java 2.2) + @@ -62,45 +62,49 @@
        -
        A C D F G I O Q R S T U W  +
        A B C D F G H I O Q R S T U W  -

        T

        +

        R

        -
        toString() - Method in class com.rallydev.rest.util.Fetch
        +
        RallyRestApi - Class in com.rallydev.rest
        -
        Get the comma separated list of fields to be returned.
        +
        The main interface to the Rest API.
        -
        toString() - Method in class com.rallydev.rest.util.QueryFilter
        +
        RallyRestApi(URI, String, String) - Constructor for class com.rallydev.rest.RallyRestApi
        -
        Get the string representation of this query filter.
        +
        Deprecated. +
        Use the api key constructor instead.
        +
        -
        toUrl() - Method in class com.rallydev.rest.request.CreateRequest
        +
        RallyRestApi(URI, String) - Constructor for class com.rallydev.rest.RallyRestApi
        -
        Convert this request into a url compatible with the WSAPI.
        +
        Creates a new instance for the specified server using the specified API Key.
        -
        toUrl() - Method in class com.rallydev.rest.request.DeleteRequest
        +
        Ref - Class in com.rallydev.rest.util
        -
        Convert this request into a url compatible with the WSAPI.
        +
        Provides utility methods for working with ref URLs.
        -
        toUrl() - Method in class com.rallydev.rest.request.GetRequest
        +
        Ref() - Constructor for class com.rallydev.rest.util.Ref
        +
         
        +
        Request - Class in com.rallydev.rest.request
        -
        Convert this request into a url compatible with the WSAPI.
        +
        Base class for all WSAPI requests.
        -
        toUrl() - Method in class com.rallydev.rest.request.QueryRequest
        +
        Request() - Constructor for class com.rallydev.rest.request.Request
        -
        Convert this request into a url compatible with the WSAPI.
        +
        Create a new request.
        -
        toUrl() - Method in class com.rallydev.rest.request.Request
        +
        Response - Class in com.rallydev.rest.response
        -
        Convert this request into a url compatible with the WSAPI.
        +
        Represents a WSAPI response.
        -
        toUrl() - Method in class com.rallydev.rest.request.UpdateRequest
        +
        Response(String) - Constructor for class com.rallydev.rest.response.Response
        -
        Convert this request into a url compatible with the WSAPI.
        +
        Create a new response from the specified JSON encoded string.
        -A C D F G I O Q R S T U W 
        +A B C D F G H I O Q R S T U W 
        diff --git a/src/main/resources/doc/index-files/index-12.html b/src/main/resources/doc/index-files/index-12.html index 68a0ec6..0b6de81 100644 --- a/src/main/resources/doc/index-files/index-12.html +++ b/src/main/resources/doc/index-files/index-12.html @@ -2,15 +2,15 @@ - -U-Index (Rally Rest API for Java 2.0) - + +S-Index (Rally Rest API for Java 2.2) + @@ -62,33 +62,125 @@
        -
        A C D F G I O Q R S T U W  +
        A B C D F G H I O Q R S T U W  -

        U

        +

        S

        -
        update(UpdateRequest) - Method in class com.rallydev.rest.RallyRestApi
        +
        setApplicationName(String) - Method in class com.rallydev.rest.client.HttpClient
        -
        Update the specified object.
        +
        Set the value of the X-RallyIntegrationName header included on all requests.
        -
        UpdateRequest - Class in com.rallydev.rest.request
        +
        setApplicationName(String) - Method in class com.rallydev.rest.RallyRestApi
        -
        Represents a WSAPI request to update an object.
        +
        Set the value of the X-RallyIntegrationName header included on all requests.
        -
        UpdateRequest(String, JsonObject) - Constructor for class com.rallydev.rest.request.UpdateRequest
        +
        setApplicationVendor(String) - Method in class com.rallydev.rest.client.HttpClient
        -
        Create a new update request for the specified object and values.
        +
        Set the value of the X-RallyIntegrationVendor header included on all requests.
        -
        UpdateResponse - Class in com.rallydev.rest.response
        +
        setApplicationVendor(String) - Method in class com.rallydev.rest.RallyRestApi
        -
        Represents a WSAPI response from updating an object.
        +
        Set the value of the X-RallyIntegrationVendor header included on all requests.
        -
        UpdateResponse(String) - Constructor for class com.rallydev.rest.response.UpdateResponse
        +
        setApplicationVersion(String) - Method in class com.rallydev.rest.client.HttpClient
        -
        Create a new update response from the specified JSON encoded string.
        +
        Set the value of the X-RallyIntegrationVersion header included on all requests.
        +
        +
        setApplicationVersion(String) - Method in class com.rallydev.rest.RallyRestApi
        +
        +
        Set the value of the X-RallyIntegrationVersion header included on all requests.
        +
        +
        setFetch(Fetch) - Method in class com.rallydev.rest.request.CollectionUpdateRequest
        +
        +
        Set the current list of fields to be returned on the updated object.
        +
        +
        setFetch(Fetch) - Method in class com.rallydev.rest.request.CreateRequest
        +
        +
        Set the current list of fields to be returned on the created object.
        +
        +
        setFetch(Fetch) - Method in class com.rallydev.rest.request.GetRequest
        +
        +
        Set the current list of fields to be returned on the retrieved object.
        +
        +
        setFetch(Fetch) - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Set the current list of fields to be returned on the matching objects.
        +
        +
        setFetch(Fetch) - Method in class com.rallydev.rest.request.UpdateRequest
        +
        +
        Set the current list of fields to be returned on the updated object.
        +
        +
        setGsonBuilder(GsonBuilder) - Method in class com.rallydev.rest.request.Request
        +
        +
        Set the Gson Builder used for JSON serialization in this request.
        +
        +
        setLimit(int) - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Set the maximum number of records to be returned from the query.
        +
        +
        setOrder(String) - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Get the order by which the result set will be sorted.
        +
        +
        setPageSize(int) - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Set the page size of the result set.
        +
        +
        setParams(List<NameValuePair>) - Method in class com.rallydev.rest.request.Request
        +
        +
        Set the list of additional parameters included in this request.
        +
        +
        setProject(String) - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Specify the project which the result set should be scoped to.
        +
        +
        setProxy(URI) - Method in class com.rallydev.rest.client.HttpClient
        +
        +
        Set the unauthenticated proxy server to use.
        +
        +
        setProxy(URI, String, String) - Method in class com.rallydev.rest.client.HttpClient
        +
        +
        Set the authenticated proxy server to use.
        +
        +
        setProxy(URI) - Method in class com.rallydev.rest.RallyRestApi
        +
        +
        Set the unauthenticated proxy server to use.
        +
        +
        setProxy(URI, String, String) - Method in class com.rallydev.rest.RallyRestApi
        +
        +
        Set the authenticated proxy server to use.
        +
        +
        setQueryFilter(QueryFilter) - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Set a filter by which the result set will be narrowed down.
        +
        +
        setScopedDown(boolean) - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        If a project has been specified, set whether to include matching objects in child projects in the result set.
        +
        +
        setScopedUp(boolean) - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        If a project has been specified, set whether to include matching objects in parent projects in the result set.
        +
        +
        setStart(int) - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Set the 1-based start index of the result set.
        +
        +
        setWorkspace(String) - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Specify the workspace which the result set should be scoped to.
        +
        +
        setWsapiVersion(String) - Method in class com.rallydev.rest.client.HttpClient
        +
        +
        Set the current version of the WSAPI being targeted.
        +
        +
        setWsapiVersion(String) - Method in class com.rallydev.rest.RallyRestApi
        +
        +
        Set the current version of the WSAPI being targeted.
        -A C D F G I O Q R S T U W 
        +A B C D F G H I O Q R S T U W 
        diff --git a/src/main/resources/doc/index-files/index-13.html b/src/main/resources/doc/index-files/index-13.html index fb0dafd..4b55239 100644 --- a/src/main/resources/doc/index-files/index-13.html +++ b/src/main/resources/doc/index-files/index-13.html @@ -2,15 +2,15 @@ - -W-Index (Rally Rest API for Java 2.0) - + +T-Index (Rally Rest API for Java 2.2) + @@ -37,7 +37,7 @@
        -
        A C D F G I O Q R S T U W  +
        A B C D F G H I O Q R S T U W  -

        W

        +

        T

        -
        wasSuccessful() - Method in class com.rallydev.rest.response.Response
        +
        toString() - Method in class com.rallydev.rest.util.Fetch
        -
        Returns whether the response was successful (no errors)
        +
        Get the comma separated list of fields to be returned.
        +
        +
        toString() - Method in class com.rallydev.rest.util.QueryFilter
        +
        +
        Get the string representation of this query filter.
        +
        +
        toUrl() - Method in class com.rallydev.rest.request.CollectionUpdateRequest
        +
        +
        Convert this request into a url compatible with the WSAPI.
        +
        +
        toUrl() - Method in class com.rallydev.rest.request.CreateRequest
        +
        +
        Convert this request into a url compatible with the WSAPI.
        +
        +
        toUrl() - Method in class com.rallydev.rest.request.DeleteRequest
        +
        +
        Convert this request into a url compatible with the WSAPI.
        +
        +
        toUrl() - Method in class com.rallydev.rest.request.GetRequest
        +
        +
        Convert this request into a url compatible with the WSAPI.
        +
        +
        toUrl() - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Convert this request into a url compatible with the WSAPI.
        +
        +
        toUrl() - Method in class com.rallydev.rest.request.Request
        +
        +
        Convert this request into a url compatible with the WSAPI.
        +
        +
        toUrl() - Method in class com.rallydev.rest.request.UpdateRequest
        +
        +
        Convert this request into a url compatible with the WSAPI.
        -A C D F G I O Q R S T U W 
        +A B C D F G H I O Q R S T U W 
        @@ -93,7 +125,7 @@

        W

        • Frames
          • diff --git a/src/main/resources/doc/index-files/index-14.html b/src/main/resources/doc/index-files/index-14.html new file mode 100644 index 0000000..f6fa8aa --- /dev/null +++ b/src/main/resources/doc/index-files/index-14.html @@ -0,0 +1,142 @@ + + + + + +U-Index (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          + + +
          + +
          A B C D F G H I O Q R S T U W  + + +

          U

          +
          +
          update(UpdateRequest) - Method in class com.rallydev.rest.RallyRestApi
          +
          +
          Update the specified object.
          +
          +
          updateCollection(CollectionUpdateRequest) - Method in class com.rallydev.rest.RallyRestApi
          +
          +
          Update the specified collection.
          +
          +
          UpdateRequest - Class in com.rallydev.rest.request
          +
          +
          Represents a WSAPI request to update an object.
          +
          +
          UpdateRequest(String, JsonObject) - Constructor for class com.rallydev.rest.request.UpdateRequest
          +
          +
          Create a new update request for the specified object and values.
          +
          +
          UpdateResponse - Class in com.rallydev.rest.response
          +
          +
          Represents a WSAPI response from updating an object.
          +
          +
          UpdateResponse(String) - Constructor for class com.rallydev.rest.response.UpdateResponse
          +
          +
          Create a new update response from the specified JSON encoded string.
          +
          +
          +A B C D F G H I O Q R S T U W 
          + +
          + + + + + +
          +
          + + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/index-files/index-15.html b/src/main/resources/doc/index-files/index-15.html new file mode 100644 index 0000000..199a2f1 --- /dev/null +++ b/src/main/resources/doc/index-files/index-15.html @@ -0,0 +1,122 @@ + + + + + +W-Index (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          + + +
          + +
          A B C D F G H I O Q R S T U W  + + +

          W

          +
          +
          wasSuccessful() - Method in class com.rallydev.rest.response.Response
          +
          +
          Returns whether the response was successful (no errors)
          +
          +
          +A B C D F G H I O Q R S T U W 
          + +
          + + + + + +
          +
          + + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/index-files/index-16.html b/src/main/resources/doc/index-files/index-16.html new file mode 100644 index 0000000..394260d --- /dev/null +++ b/src/main/resources/doc/index-files/index-16.html @@ -0,0 +1,122 @@ + + + + + +W-Index (Rally Rest API for Java 2.2) + + + + + + + +
          + + + + + +
          +
          + + + +
          + +
          + + +
          + +
          A B C D F G H I M O Q R S T U W  + + +

          W

          +
          +
          wasSuccessful() - Method in class com.rallydev.rest.response.Response
          +
          +
          Returns whether the response was successful (no errors)
          +
          +
          +A B C D F G H I M O Q R S T U W 
          + +
          + + + + + +
          +
          + + + +
          + +
          + + +
          + + + diff --git a/src/main/resources/doc/index-files/index-2.html b/src/main/resources/doc/index-files/index-2.html index de3ec2b..db6ee4e 100644 --- a/src/main/resources/doc/index-files/index-2.html +++ b/src/main/resources/doc/index-files/index-2.html @@ -2,15 +2,15 @@ - -C-Index (Rally Rest API for Java 2.0) - + +B-Index (Rally Rest API for Java 2.2) + @@ -62,59 +62,21 @@
        -
        A C D F G I O Q R S T U W  +
        A B C D F G H I O Q R S T U W  -

        C

        +

        B

        -
        clone() - Method in class com.rallydev.rest.request.QueryRequest
        +
        BasicAuthClient - Class in com.rallydev.rest.client
        -
        Clone this request.
        +
        A HttpClient which authenticates using basic authentication (username/password).
        -
        close() - Method in class com.rallydev.rest.RallyRestApi
        +
        BasicAuthClient(URI, String, String) - Constructor for class com.rallydev.rest.client.BasicAuthClient
        -
        Release all resources associated with this instance.
        -
        -
        com.rallydev.rest - package com.rallydev.rest
        -
        -
        Provides the main interface to the Rest API.
        -
        -
        com.rallydev.rest.request - package com.rallydev.rest.request
        -
        -
        Provides objects for encoding requests to the Rest API.
        -
        -
        com.rallydev.rest.response - package com.rallydev.rest.response
        -
        -
        Provides objects for parsing responses from the Rest API.
        -
        -
        com.rallydev.rest.util - package com.rallydev.rest.util
        -
        -
        Provides utilities for working with the Rest API.
        -
        -
        create(CreateRequest) - Method in class com.rallydev.rest.RallyRestApi
        -
        -
        Create the specified object.
        -
        -
        CREATE_RESULT_KEY - Static variable in class com.rallydev.rest.RallyRestApi
        -
         
        -
        CreateRequest - Class in com.rallydev.rest.request
        -
        -
        Represents a WSAPI request to create an object.
        -
        -
        CreateRequest(String, JsonObject) - Constructor for class com.rallydev.rest.request.CreateRequest
        -
        -
        Create a new create request with the specified type and values.
        -
        -
        CreateResponse - Class in com.rallydev.rest.response
        -
        -
        Represents a WSAPI response from creating an object
        -
        -
        CreateResponse(String) - Constructor for class com.rallydev.rest.response.CreateResponse
        -
        -
        Create a new create response from the specified JSON encoded string.
        +
        Construct a new client.
        -A C D F G I O Q R S T U W 
        +A B C D F G H I O Q R S T U W 
        diff --git a/src/main/resources/doc/index-files/index-3.html b/src/main/resources/doc/index-files/index-3.html index 5904402..a646ab9 100644 --- a/src/main/resources/doc/index-files/index-3.html +++ b/src/main/resources/doc/index-files/index-3.html @@ -2,15 +2,15 @@ - -D-Index (Rally Rest API for Java 2.0) - + +C-Index (Rally Rest API for Java 2.2) + @@ -62,37 +62,85 @@
        -
        A C D F G I O Q R S T U W  +
        A B C D F G H I O Q R S T U W  -

        D

        +

        C

        -
        DEFAULT_WSAPI_VERSION - Static variable in class com.rallydev.rest.RallyRestApi
        +
        clone() - Method in class com.rallydev.rest.request.QueryRequest
        -
        The default version of the WSAPI to target.
        +
        Clone this request.
        -
        delete(DeleteRequest) - Method in class com.rallydev.rest.RallyRestApi
        +
        close() - Method in class com.rallydev.rest.client.HttpClient
        -
        Delete the specified object.
        +
        Release all resources associated with this instance.
        -
        DeleteRequest - Class in com.rallydev.rest.request
        +
        close() - Method in class com.rallydev.rest.RallyRestApi
        -
        Represents a WSAPI request to delete an object.
        +
        Release all resources associated with this instance.
        -
        DeleteRequest(String) - Constructor for class com.rallydev.rest.request.DeleteRequest
        +
        CollectionUpdateRequest - Class in com.rallydev.rest.request
        -
        Createa new delete request for the specified object.
        +
        Represents a WSAPI request to update a collection.
        -
        DeleteResponse - Class in com.rallydev.rest.response
        +
        CollectionUpdateRequest(JsonObject, JsonArray, boolean) - Constructor for class com.rallydev.rest.request.CollectionUpdateRequest
        -
        Represents a WSAPI response from deleting an object
        +
        Create a new update request for the specified collection and values.
        -
        DeleteResponse(String) - Constructor for class com.rallydev.rest.response.DeleteResponse
        +
        CollectionUpdateRequest(String, JsonArray, boolean) - Constructor for class com.rallydev.rest.request.CollectionUpdateRequest
        -
        Create a new delete response from the specified JSON encoded string.
        +
        Create a new update request for the specified collection and values.
        +
        +
        CollectionUpdateResponse - Class in com.rallydev.rest.response
        +
        +
        Represents a WSAPI response from updating a collection.
        +
        +
        CollectionUpdateResponse(String) - Constructor for class com.rallydev.rest.response.CollectionUpdateResponse
        +
        +
        Create a new collection update response from the specified JSON encoded string.
        +
        +
        com.rallydev.rest - package com.rallydev.rest
        +
        +
        Provides the main interface to the Rest API.
        +
        +
        com.rallydev.rest.client - package com.rallydev.rest.client
        +
        +
        Provides the underlying http client implementations.
        +
        +
        com.rallydev.rest.request - package com.rallydev.rest.request
        +
        +
        Provides objects for encoding requests to the Rest API.
        +
        +
        com.rallydev.rest.response - package com.rallydev.rest.response
        +
        +
        Provides objects for parsing responses from the Rest API.
        +
        +
        com.rallydev.rest.util - package com.rallydev.rest.util
        +
        +
        Provides utilities for working with the Rest API.
        +
        +
        create(CreateRequest) - Method in class com.rallydev.rest.RallyRestApi
        +
        +
        Create the specified object.
        +
        +
        CreateRequest - Class in com.rallydev.rest.request
        +
        +
        Represents a WSAPI request to create an object.
        +
        +
        CreateRequest(String, JsonObject) - Constructor for class com.rallydev.rest.request.CreateRequest
        +
        +
        Create a new create request with the specified type and values.
        +
        +
        CreateResponse - Class in com.rallydev.rest.response
        +
        +
        Represents a WSAPI response from creating an object
        +
        +
        CreateResponse(String) - Constructor for class com.rallydev.rest.response.CreateResponse
        +
        +
        Create a new create response from the specified JSON encoded string.
        -A C D F G I O Q R S T U W 
        +A B C D F G H I O Q R S T U W 
        diff --git a/src/main/resources/doc/index-files/index-4.html b/src/main/resources/doc/index-files/index-4.html index 6fd0dc4..240383b 100644 --- a/src/main/resources/doc/index-files/index-4.html +++ b/src/main/resources/doc/index-files/index-4.html @@ -2,15 +2,15 @@ - -F-Index (Rally Rest API for Java 2.0) - + +D-Index (Rally Rest API for Java 2.2) + @@ -62,21 +62,49 @@
        -
        A C D F G I O Q R S T U W  +
        A B C D F G H I O Q R S T U W  -

        F

        +

        D

        -
        Fetch - Class in com.rallydev.rest.util
        +
        delete(DeleteRequest) - Method in class com.rallydev.rest.RallyRestApi
        -
        Represents a list of fields to be returned in responses from the WSAPI.
        +
        Delete the specified object.
        -
        Fetch(String...) - Constructor for class com.rallydev.rest.util.Fetch
        +
        DeleteRequest - Class in com.rallydev.rest.request
        -
        Create a new fetch with the specified fields.
        +
        Represents a WSAPI request to delete an object.
        +
        +
        DeleteRequest(String) - Constructor for class com.rallydev.rest.request.DeleteRequest
        +
        +
        Createa new delete request for the specified object.
        +
        +
        DeleteResponse - Class in com.rallydev.rest.response
        +
        +
        Represents a WSAPI response from deleting an object
        +
        +
        DeleteResponse(String) - Constructor for class com.rallydev.rest.response.DeleteResponse
        +
        +
        Create a new delete response from the specified JSON encoded string.
        +
        +
        doDelete(String) - Method in class com.rallydev.rest.client.HttpClient
        +
        +
        Perform a delete against the WSAPI
        +
        +
        doGet(String) - Method in class com.rallydev.rest.client.HttpClient
        +
        +
        Perform a get against the WSAPI
        +
        +
        doPost(String, String) - Method in class com.rallydev.rest.client.HttpClient
        +
        +
        Perform a post against the WSAPI
        +
        +
        doPut(String, String) - Method in class com.rallydev.rest.client.HttpClient
        +
        +
        Perform a put against the WSAPI
        -A C D F G I O Q R S T U W 
        +A B C D F G H I O Q R S T U W 
        diff --git a/src/main/resources/doc/index-files/index-5.html b/src/main/resources/doc/index-files/index-5.html index 0f3bbcc..8bb31b2 100644 --- a/src/main/resources/doc/index-files/index-5.html +++ b/src/main/resources/doc/index-files/index-5.html @@ -2,15 +2,15 @@ - -G-Index (Rally Rest API for Java 2.0) - + +F-Index (Rally Rest API for Java 2.2) + @@ -62,141 +62,21 @@
        -
        A C D F G I O Q R S T U W  +
        A B C D F G H I O Q R S T U W  -

        G

        +

        F

        -
        get(GetRequest) - Method in class com.rallydev.rest.RallyRestApi
        +
        Fetch - Class in com.rallydev.rest.util
        -
        Get the specified object.
        +
        Represents a list of fields to be returned in responses from the WSAPI.
        -
        getBody() - Method in class com.rallydev.rest.request.CreateRequest
        +
        Fetch(String...) - Constructor for class com.rallydev.rest.util.Fetch
        -
        Get the JSON encoded string representation of the object to be created.
        -
        -
        getBody() - Method in class com.rallydev.rest.request.UpdateRequest
        -
        -
        Get the JSON encoded string representation of the object to be updated.
        -
        -
        getErrors() - Method in class com.rallydev.rest.response.Response
        -
        -
        Get any errors returned in the response.
        -
        -
        getFetch() - Method in class com.rallydev.rest.request.CreateRequest
        -
        -
        Get the current list of fields to be returned on the created object.
        -
        -
        getFetch() - Method in class com.rallydev.rest.request.GetRequest
        -
        -
        Get the current list of fields to be returned on the retrieved object.
        -
        -
        getFetch() - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        Get the current list of fields to be returned on the matching objects.
        -
        -
        getFetch() - Method in class com.rallydev.rest.request.UpdateRequest
        -
        -
        Get the current list of fields to be returned on the updated object.
        -
        -
        getLimit() - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        Get the maximum number of records to be returned from the query.
        -
        -
        getObject() - Method in class com.rallydev.rest.response.CreateResponse
        -
        -
        Get the created object.
        -
        -
        getObject() - Method in class com.rallydev.rest.response.GetResponse
        -
        -
        Get the retrieved object.
        -
        -
        getObject() - Method in class com.rallydev.rest.response.UpdateResponse
        -
        -
        Get the updated object.
        -
        -
        getOidFromRef(String) - Static method in class com.rallydev.rest.util.Ref
        -
        -
        Get the ObjectID from the specified ref url
        -
        -
        getOrder() - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        Set the order by which the result set will be sorted.
        -
        -
        getPageSize() - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        Get the page size of the result set.
        -
        -
        getPageSize() - Method in class com.rallydev.rest.response.QueryResponse
        -
        -
        Get the page size of the results
        -
        -
        getParams() - Method in class com.rallydev.rest.request.Request
        -
        -
        Get the list of additional parameters included in this request.
        -
        -
        getProject() - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        Get the project which the result set should be scoped to.
        -
        -
        getQueryFilter() - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        Get the filter by which the result set will be narrowed down.
        -
        -
        getRelativeRef(String) - Static method in class com.rallydev.rest.util.Ref
        -
        -
        Create a relative ref url from the specified ref
        -
        -
        GetRequest - Class in com.rallydev.rest.request
        -
        -
        Represents a WSAPI request to retrieve a specific object.
        -
        -
        GetRequest(String) - Constructor for class com.rallydev.rest.request.GetRequest
        -
        -
        Create a new get request for the specified object.
        -
        -
        GetResponse - Class in com.rallydev.rest.response
        -
        -
        Represents a WSAPI response from retrieving a single object.
        -
        -
        GetResponse(String) - Constructor for class com.rallydev.rest.response.GetResponse
        -
        -
        Create a new get response from the specified JSON encoded string.
        -
        -
        getResults() - Method in class com.rallydev.rest.response.QueryResponse
        -
        -
        Get the results of the query
        -
        -
        getStart() - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        Get the start index of the result set.
        -
        -
        getStart() - Method in class com.rallydev.rest.response.QueryResponse
        -
        -
        Get the start index of the results
        -
        -
        getTotalResultCount() - Method in class com.rallydev.rest.response.QueryResponse
        -
        -
        Get the total number of objects that matched the query
        -
        -
        getTypeFromRef(String) - Static method in class com.rallydev.rest.util.Ref
        -
        -
        Get the type from the specified ref url
        -
        -
        getWarnings() - Method in class com.rallydev.rest.response.Response
        -
        -
        Get any warnings returned in the response.
        -
        -
        getWorkspace() - Method in class com.rallydev.rest.request.QueryRequest
        -
        -
        Get the workspace which the result set should be scoped to.
        -
        -
        getWsapiVersion() - Method in class com.rallydev.rest.RallyRestApi
        -
        -
        Get the current version of the WSAPI being targeted.
        +
        Create a new fetch with the specified fields.
        -A C D F G I O Q R S T U W 
        +A B C D F G H I O Q R S T U W 
        diff --git a/src/main/resources/doc/index-files/index-6.html b/src/main/resources/doc/index-files/index-6.html index ddd3839..f29e8a1 100644 --- a/src/main/resources/doc/index-files/index-6.html +++ b/src/main/resources/doc/index-files/index-6.html @@ -2,15 +2,15 @@ - -I-Index (Rally Rest API for Java 2.0) - + +G-Index (Rally Rest API for Java 2.2) + @@ -62,29 +62,173 @@
        -
        A C D F G I O Q R S T U W  +
        A B C D F G H I O Q R S T U W  -

        I

        +

        G

        -
        InvalidURLException - Exception in com.rallydev.rest.util
        -
         
        -
        InvalidURLException(String) - Constructor for exception com.rallydev.rest.util.InvalidURLException
        -
         
        -
        isRef(String) - Static method in class com.rallydev.rest.util.Ref
        +
        get(GetRequest) - Method in class com.rallydev.rest.RallyRestApi
        -
        Determine whether the specified string is a valid ref url.
        +
        Get the specified object.
        -
        isScopedDown() - Method in class com.rallydev.rest.request.QueryRequest
        +
        getBody() - Method in class com.rallydev.rest.request.CollectionUpdateRequest
        -
        If a project has been specified, get whether to include matching objects in child projects in the result set.
        +
        Get the JSON encoded string representation of the object to be updated.
        -
        isScopedUp() - Method in class com.rallydev.rest.request.QueryRequest
        +
        getBody() - Method in class com.rallydev.rest.request.CreateRequest
        -
        If a project has been specified, get whether to include matching objects in parent projects in the result set.
        +
        Get the JSON encoded string representation of the object to be created.
        +
        +
        getBody() - Method in class com.rallydev.rest.request.UpdateRequest
        +
        +
        Get the JSON encoded string representation of the object to be updated.
        +
        +
        getClient() - Method in class com.rallydev.rest.RallyRestApi
        +
        +
        Get the underlying http client implementation.
        +
        +
        getErrors() - Method in class com.rallydev.rest.response.Response
        +
        +
        Get any errors returned in the response.
        +
        +
        getFetch() - Method in class com.rallydev.rest.request.CollectionUpdateRequest
        +
        +
        Get the current list of fields to be returned on the updated object.
        +
        +
        getFetch() - Method in class com.rallydev.rest.request.CreateRequest
        +
        +
        Get the current list of fields to be returned on the created object.
        +
        +
        getFetch() - Method in class com.rallydev.rest.request.GetRequest
        +
        +
        Get the current list of fields to be returned on the retrieved object.
        +
        +
        getFetch() - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Get the current list of fields to be returned on the matching objects.
        +
        +
        getFetch() - Method in class com.rallydev.rest.request.UpdateRequest
        +
        +
        Get the current list of fields to be returned on the updated object.
        +
        +
        getGsonBuilder() - Method in class com.rallydev.rest.request.Request
        +
        +
        Get the Gson Builder used for JSON serialization in this request.
        +
        +
        getLimit() - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Get the maximum number of records to be returned from the query.
        +
        +
        getObject() - Method in class com.rallydev.rest.response.CreateResponse
        +
        +
        Get the created object.
        +
        +
        getObject() - Method in class com.rallydev.rest.response.GetResponse
        +
        +
        Get the retrieved object.
        +
        +
        getObject() - Method in class com.rallydev.rest.response.UpdateResponse
        +
        +
        Get the updated object.
        +
        +
        getOidFromRef(String) - Static method in class com.rallydev.rest.util.Ref
        +
        +
        Get the ObjectID from the specified ref url
        +
        +
        getOrder() - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Set the order by which the result set will be sorted.
        +
        +
        getPageSize() - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Get the page size of the result set.
        +
        +
        getPageSize() - Method in class com.rallydev.rest.response.QueryResponse
        +
        +
        Get the page size of the results
        +
        +
        getParams() - Method in class com.rallydev.rest.request.Request
        +
        +
        Get the list of additional parameters included in this request.
        +
        +
        getProject() - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Get the project which the result set should be scoped to.
        +
        +
        getQueryFilter() - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Get the filter by which the result set will be narrowed down.
        +
        +
        getRelativeRef(String) - Static method in class com.rallydev.rest.util.Ref
        +
        +
        Create a relative ref url from the specified ref
        +
        +
        GetRequest - Class in com.rallydev.rest.request
        +
        +
        Represents a WSAPI request to retrieve a specific object.
        +
        +
        GetRequest(String) - Constructor for class com.rallydev.rest.request.GetRequest
        +
        +
        Create a new get request for the specified object.
        +
        +
        GetResponse - Class in com.rallydev.rest.response
        +
        +
        Represents a WSAPI response from retrieving a single object.
        +
        +
        GetResponse(String) - Constructor for class com.rallydev.rest.response.GetResponse
        +
        +
        Create a new get response from the specified JSON encoded string.
        +
        +
        getResults() - Method in class com.rallydev.rest.response.CollectionUpdateResponse
        +
        +
        Get the results of the collection update
        +
        +
        getResults() - Method in class com.rallydev.rest.response.QueryResponse
        +
        +
        Get the results of the query
        +
        +
        getServer() - Method in class com.rallydev.rest.client.HttpClient
        +
        +
        Get the current server being targeted.
        +
        +
        getStart() - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Get the start index of the result set.
        +
        +
        getStart() - Method in class com.rallydev.rest.response.QueryResponse
        +
        +
        Get the start index of the results
        +
        +
        getTotalResultCount() - Method in class com.rallydev.rest.response.QueryResponse
        +
        +
        Get the total number of objects that matched the query
        +
        +
        getTypeFromRef(String) - Static method in class com.rallydev.rest.util.Ref
        +
        +
        Get the type from the specified ref url
        +
        +
        getWarnings() - Method in class com.rallydev.rest.response.Response
        +
        +
        Get any warnings returned in the response.
        +
        +
        getWorkspace() - Method in class com.rallydev.rest.request.QueryRequest
        +
        +
        Get the workspace which the result set should be scoped to.
        +
        +
        getWsapiUrl() - Method in class com.rallydev.rest.client.HttpClient
        +
        +
        Get the WSAPI base url based on the current server and WSAPI version
        +
        +
        getWsapiVersion() - Method in class com.rallydev.rest.client.HttpClient
        +
        +
        Get the current version of the WSAPI being targeted.
        +
        +
        getWsapiVersion() - Method in class com.rallydev.rest.RallyRestApi
        +
        +
        Get the current version of the WSAPI being targeted.
        -A C D F G I O Q R S T U W 
        +A B C D F G H I O Q R S T U W 
        diff --git a/src/main/resources/doc/index-files/index-7.html b/src/main/resources/doc/index-files/index-7.html index 4a18b8b..75d60ce 100644 --- a/src/main/resources/doc/index-files/index-7.html +++ b/src/main/resources/doc/index-files/index-7.html @@ -2,15 +2,15 @@ - -O-Index (Rally Rest API for Java 2.0) - + +H-Index (Rally Rest API for Java 2.2) + @@ -62,23 +62,17 @@
        -
        A C D F G I O Q R S T U W  +
        A B C D F G H I O Q R S T U W  -

        O

        +

        H

        -
        OPERATION_RESULT_KEY - Static variable in class com.rallydev.rest.RallyRestApi
        -
         
        -
        or(QueryFilter) - Method in class com.rallydev.rest.util.QueryFilter
        +
        HttpClient - Class in com.rallydev.rest.client
        -
        Get a query filter that is the ORed combination of this filter and the specified one.
        -
        -
        or(QueryFilter...) - Static method in class com.rallydev.rest.util.QueryFilter
        -
        -
        Get a query filter that is the ORed combination of the specified filters.
        +
        A HttpClient implementation providing connectivity to Rally.
        -A C D F G I O Q R S T U W 
        +A B C D F G H I O Q R S T U W 
        diff --git a/src/main/resources/doc/index-files/index-8.html b/src/main/resources/doc/index-files/index-8.html index b96d190..3d17aef 100644 --- a/src/main/resources/doc/index-files/index-8.html +++ b/src/main/resources/doc/index-files/index-8.html @@ -2,15 +2,15 @@ - -Q-Index (Rally Rest API for Java 2.0) - + +I-Index (Rally Rest API for Java 2.2) + @@ -62,47 +62,25 @@
        -
        A C D F G I O Q R S T U W  +
        A B C D F G H I O Q R S T U W  -

        Q

        +

        I

        -
        query(QueryRequest) - Method in class com.rallydev.rest.RallyRestApi
        +
        isRef(String) - Static method in class com.rallydev.rest.util.Ref
        -
        Query for objects matching the specified request.
        +
        Determine whether the specified string is a valid ref url.
        -
        QUERY_RESULT_KEY - Static variable in class com.rallydev.rest.RallyRestApi
        -
         
        -
        QueryFilter - Class in com.rallydev.rest.util
        +
        isScopedDown() - Method in class com.rallydev.rest.request.QueryRequest
        -
        Represents a query filter to be applied to query requests.
        +
        If a project has been specified, get whether to include matching objects in child projects in the result set.
        -
        QueryFilter(String, String, String) - Constructor for class com.rallydev.rest.util.QueryFilter
        +
        isScopedUp() - Method in class com.rallydev.rest.request.QueryRequest
        -
        Create a new query filter with the specified options.
        -
        -
        QueryRequest - Class in com.rallydev.rest.request
        -
        -
        Represents a WSAPI request to retrieve all objects matching specified criteria.
        -
        -
        QueryRequest(String) - Constructor for class com.rallydev.rest.request.QueryRequest
        -
        -
        Create a new query request for the specified type.
        -
        -
        QueryRequest(JsonObject) - Constructor for class com.rallydev.rest.request.QueryRequest
        -
        -
        Create a new query request for the specified collection.
        -
        -
        QueryResponse - Class in com.rallydev.rest.response
        -
        -
        Represents a WSAPI response from querying for objects.
        -
        -
        QueryResponse(String) - Constructor for class com.rallydev.rest.response.QueryResponse
        -
        -
        Create a new query response from the specified JSON encoded string.
        +
        If a project has been specified, get whether to include matching objects in parent projects in the result set.
        -A C D F G I O Q R S T U W 
        +A B C D F G H I O Q R S T U W 
        diff --git a/src/main/resources/doc/index-files/index-9.html b/src/main/resources/doc/index-files/index-9.html index 50bc6c0..dd6835e 100644 --- a/src/main/resources/doc/index-files/index-9.html +++ b/src/main/resources/doc/index-files/index-9.html @@ -2,15 +2,15 @@ - -R-Index (Rally Rest API for Java 2.0) - + +O-Index (Rally Rest API for Java 2.2) + @@ -62,43 +62,21 @@
        -
        A C D F G I O Q R S T U W  +
        A B C D F G H I O Q R S T U W  -

        R

        +

        O

        -
        RallyRestApi - Class in com.rallydev.rest
        +
        or(QueryFilter) - Method in class com.rallydev.rest.util.QueryFilter
        -
        The main interface to the Rest API.
        +
        Get a query filter that is the ORed combination of this filter and the specified one.
        -
        RallyRestApi(URI, String, String) - Constructor for class com.rallydev.rest.RallyRestApi
        +
        or(QueryFilter...) - Static method in class com.rallydev.rest.util.QueryFilter
        -
        Creates a new instance for the specified server using the specified credentials.
        -
        -
        Ref - Class in com.rallydev.rest.util
        -
        -
        Provides utility methods for working with ref URLs.
        -
        -
        Ref() - Constructor for class com.rallydev.rest.util.Ref
        -
         
        -
        Request - Class in com.rallydev.rest.request
        -
        -
        Base class for all WSAPI requests.
        -
        -
        Request() - Constructor for class com.rallydev.rest.request.Request
        -
        -
        Create a new request.
        -
        -
        Response - Class in com.rallydev.rest.response
        -
        -
        Represents a WSAPI response.
        -
        -
        Response(String) - Constructor for class com.rallydev.rest.response.Response
        -
        -
        Create a new response from the specified JSON encoded string.
        +
        Get a query filter that is the ORed combination of the specified filters.
        -A C D F G I O Q R S T U W 
        +A B C D F G H I O Q R S T U W 
        diff --git a/src/main/resources/doc/index.html b/src/main/resources/doc/index.html index 1f73d13..c9f8896 100644 --- a/src/main/resources/doc/index.html +++ b/src/main/resources/doc/index.html @@ -2,8 +2,8 @@ - -Rally Rest API for Java 2.0 + +Rally Rest API for Java 2.2 @@ -63,7 +63,7 @@
        -

        Rally Rest API for Java 2.0

        +

        Rally Rest API for Java 2.2

        @@ -80,18 +80,24 @@

        Rally Rest API for Java 2.0

        + + + + - + - +
        com.rallydev.rest.client +
        Provides the underlying http client implementations.
        +
        com.rallydev.rest.request
        Provides objects for encoding requests to the Rest API.
        com.rallydev.rest.response
        Provides objects for parsing responses from the Rest API.
        com.rallydev.rest.util
        Provides utilities for working with the Rest API.
        diff --git a/src/main/resources/doc/overview-tree.html b/src/main/resources/doc/overview-tree.html index 0799790..074e018 100644 --- a/src/main/resources/doc/overview-tree.html +++ b/src/main/resources/doc/overview-tree.html @@ -2,15 +2,15 @@ - -Class Hierarchy (Rally Rest API for Java 2.0) - + +Class Hierarchy (Rally Rest API for Java 2.2) + @@ -67,6 +67,7 @@

        Hierarchy For All Packages

        Package Hierarchies: +
      • org.apache.http.impl.client.AbstractHttpClient (implements org.apache.http.client.HttpClient) + +
      • com.rallydev.rest.util.QueryFilter (implements java.lang.Cloneable)
      • com.rallydev.rest.RallyRestApi (implements java.io.Closeable)
      • com.rallydev.rest.util.Ref
      • com.rallydev.rest.request.Request
        • diff --git a/src/main/resources/doc/package-list b/src/main/resources/doc/package-list index 49100f7..b4b74a7 100644 --- a/src/main/resources/doc/package-list +++ b/src/main/resources/doc/package-list @@ -1,4 +1,5 @@ com.rallydev.rest +com.rallydev.rest.client com.rallydev.rest.request com.rallydev.rest.response com.rallydev.rest.util diff --git a/src/main/resources/doc/serialized-form.html b/src/main/resources/doc/serialized-form.html index dd6b095..49ad6f5 100644 --- a/src/main/resources/doc/serialized-form.html +++ b/src/main/resources/doc/serialized-form.html @@ -2,15 +2,15 @@ - -Serialized Form (Rally Rest API for Java 2.0) - + +Serialized Form (Rally Rest API for Java 2.2) + @@ -75,11 +75,6 @@

        Package com.rallydev.rest.util

        Class com.rallydev.rest.util.Fetch extends ArrayList<String> implements Serializable

        -
      • - - -

        Class com.rallydev.rest.util.InvalidURLException extends RuntimeException implements Serializable

        -
        • diff --git a/src/main/resources/examples/com/rallydev/rest/CollectionAddExample.java b/src/main/resources/examples/com/rallydev/rest/CollectionAddExample.java new file mode 100644 index 0000000..70617c4 --- /dev/null +++ b/src/main/resources/examples/com/rallydev/rest/CollectionAddExample.java @@ -0,0 +1,63 @@ +package com.rallydev.rest; + +import com.google.gson.JsonArray; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.rallydev.rest.request.CollectionUpdateRequest; +import com.rallydev.rest.request.QueryRequest; +import com.rallydev.rest.response.CollectionUpdateResponse; +import com.rallydev.rest.response.QueryResponse; +import com.rallydev.rest.util.Fetch; +import com.rallydev.rest.util.QueryFilter; + +import java.io.IOException; +import java.net.URISyntaxException; + +public class CollectionAddExample { + + public static void main(String[] args) throws URISyntaxException, IOException { + + //Create and configure a new instance of RallyRestApi + //(Server, username, password and proxy settings configured in Factory) + RallyRestApi restApi = RestApiFactory.getRestApi(); + + try { + //Get a story without any tags + System.out.println("\nQuerying for stories without tags..."); + QueryRequest storyRequest = new QueryRequest("hierarchicalrequirement"); + storyRequest.setQueryFilter(new QueryFilter("Tags.ObjectID", "=", "null")); + storyRequest.setFetch(new Fetch("FormattedID", "Name", "Tags")); + + QueryResponse storyResponse = restApi.query(storyRequest); + JsonObject story = storyResponse.getResults().get(0).getAsJsonObject(); + System.out.println(String.format("Found: %s - %s", story.get("FormattedID").getAsString(), story.get("Name").getAsString())); + + //Get a tag + System.out.println("\nQuerying for tags..."); + QueryRequest tagsRequest = new QueryRequest("tag"); + tagsRequest.setFetch(new Fetch("Name")); + QueryResponse tagsResponse = restApi.query(tagsRequest); + JsonObject tag = tagsResponse.getResults().get(0).getAsJsonObject(); + System.out.println(String.format("Found: %s - %s", tag.get("Name").getAsString(), tag.get("_ref").getAsString())); + + //Add the tag to the collection + JsonArray tagRefs = new JsonArray(); + JsonObject tagRef = new JsonObject(); + tagRef.addProperty("_ref", tag.get("_ref").getAsString()); + tagRefs.add(tagRef); + + //Update the collection + CollectionUpdateRequest storyTagCollectionAddRequest = new CollectionUpdateRequest(story.getAsJsonObject("Tags"), tagRefs, true); + storyTagCollectionAddRequest.setFetch(new Fetch("Name")); + CollectionUpdateResponse storyTagCollectionAddResponse = restApi.updateCollection(storyTagCollectionAddRequest); + if(storyTagCollectionAddResponse.wasSuccessful()) { + for(JsonElement addedTag : storyTagCollectionAddResponse.getResults()) { + System.out.println(String.format("Added tag: %s - %s", tag.get("Name").getAsString(), addedTag.getAsJsonObject().get("_ref").getAsString())); + } + } + } finally { + //Release resources + restApi.close(); + } + } +} diff --git a/src/main/resources/examples/com/rallydev/rest/CollectionQueryExample.java b/src/main/resources/examples/com/rallydev/rest/CollectionQueryExample.java index 1f0b5aa..91c31df 100644 --- a/src/main/resources/examples/com/rallydev/rest/CollectionQueryExample.java +++ b/src/main/resources/examples/com/rallydev/rest/CollectionQueryExample.java @@ -2,16 +2,13 @@ import com.google.gson.JsonElement; import com.google.gson.JsonObject; -import com.rallydev.rest.request.GetRequest; import com.rallydev.rest.request.QueryRequest; -import com.rallydev.rest.response.GetResponse; import com.rallydev.rest.response.QueryResponse; import com.rallydev.rest.util.Fetch; import com.rallydev.rest.util.QueryFilter; import java.io.IOException; import java.net.URISyntaxException; -import java.util.Map; public class CollectionQueryExample { @@ -22,32 +19,33 @@ public static void main(String[] args) throws URISyntaxException, IOException { RallyRestApi restApi = RestApiFactory.getRestApi(); try { - String ref = "/hierarchicalrequirement/12544729477"; - GetRequest getRequest = new GetRequest(ref); - getRequest.setFetch(new Fetch("Defects")); - - System.out.println(String.format("\nReading defect info for story %s...", ref)); - GetResponse getResponse = restApi.get(getRequest); - JsonObject story = getResponse.getObject(); - + //Get a story with defects + System.out.println("\nQuerying for stories with defects..."); + QueryRequest storiesWithDefects = new QueryRequest("hierarchicalrequirement"); + storiesWithDefects.setQueryFilter(new QueryFilter("Defects.ObjectID", "!=", null)); + storiesWithDefects.setFetch(new Fetch("FormattedID", "Name", "Defects")); + QueryResponse storiesWithDefectsResponse = restApi.query(storiesWithDefects); + JsonObject story = storiesWithDefectsResponse.getResults().get(0).getAsJsonObject(); + System.out.println(String.format("Found: %s - %s", story.get("FormattedID").getAsString(), story.get("Name").getAsString())); + + //Inspect the defects collection JsonObject defectInfo = story.getAsJsonObject("Defects"); int defectCount = defectInfo.get("Count").getAsInt(); System.out.println(String.format("\nTotal defects: %d", defectCount)); - if(defectCount > 0) { - QueryRequest defectRequest = new QueryRequest(defectInfo); - defectRequest.setFetch(new Fetch("FormattedID", "Name", "State", "Priority")); - - QueryResponse queryResponse = restApi.query(defectRequest); - if (queryResponse.wasSuccessful()) { - for (JsonElement result : queryResponse.getResults()) { - JsonObject defect = result.getAsJsonObject(); - System.out.println(String.format("\t%s - %s: Priority=%s, State=%s", - defect.get("FormattedID").getAsString(), - defect.get("Name").getAsString(), - defect.get("Priority").getAsString(), - defect.get("State").getAsString())); - } + //Query the defects collection + QueryRequest defectRequest = new QueryRequest(defectInfo); + defectRequest.setFetch(new Fetch("FormattedID", "Name", "State", "Priority")); + + QueryResponse queryResponse = restApi.query(defectRequest); + if (queryResponse.wasSuccessful()) { + for (JsonElement result : queryResponse.getResults()) { + JsonObject defect = result.getAsJsonObject(); + System.out.println(String.format("\t%s - %s: Priority=%s, State=%s", + defect.get("FormattedID").getAsString(), + defect.get("Name").getAsString(), + defect.get("Priority").getAsString(), + defect.get("State").getAsString())); } } } finally { diff --git a/src/main/resources/examples/com/rallydev/rest/CollectionSummaryExample.java b/src/main/resources/examples/com/rallydev/rest/CollectionSummaryExample.java index 7ece73f..2601e5c 100644 --- a/src/main/resources/examples/com/rallydev/rest/CollectionSummaryExample.java +++ b/src/main/resources/examples/com/rallydev/rest/CollectionSummaryExample.java @@ -2,13 +2,10 @@ import com.google.gson.JsonElement; import com.google.gson.JsonObject; -import com.rallydev.rest.request.GetRequest; import com.rallydev.rest.request.QueryRequest; -import com.rallydev.rest.response.GetResponse; import com.rallydev.rest.response.QueryResponse; import com.rallydev.rest.util.Fetch; import com.rallydev.rest.util.QueryFilter; -import com.rallydev.rest.util.Ref; import java.io.IOException; import java.net.URISyntaxException; @@ -23,21 +20,24 @@ public static void main(String[] args) throws URISyntaxException, IOException { RallyRestApi restApi = RestApiFactory.getRestApi(); try { - String ref = "/hierarchicalrequirement/12544729477"; - GetRequest getRequest = new GetRequest(ref); - getRequest.setFetch(new Fetch("Defects:summary[Priority;State]")); - - System.out.println(String.format("\nSummarizing defects on story %s...", ref)); - GetResponse getResponse = restApi.get(getRequest); - JsonObject story = getResponse.getObject(); + //Get a story with defects + System.out.println("\nQuerying for stories with defects..."); + QueryRequest storiesWithDefects = new QueryRequest("hierarchicalrequirement"); + storiesWithDefects.setQueryFilter(new QueryFilter("Defects.ObjectID", "!=", null)); + storiesWithDefects.setFetch(new Fetch("FormattedID", "Name", "Defects:summary[Priority;State]")); + QueryResponse storiesWithDefectsResponse = restApi.query(storiesWithDefects); + JsonObject story = storiesWithDefectsResponse.getResults().get(0).getAsJsonObject(); + System.out.println(String.format("Found: %s - %s", story.get("FormattedID").getAsString(), story.get("Name").getAsString())); + + System.out.println(String.format("\nSummarizing defects...")); JsonObject defectSummary = story.getAsJsonObject("Summary").getAsJsonObject("Defects"); - + System.out.println(String.format("\nTotal defects: %d", defectSummary.get("Count").getAsInt())); - + System.out.println("\nBy Priority:"); JsonObject prioritySummary = defectSummary.getAsJsonObject("Priority"); for(Map.Entry summaryItem : prioritySummary.entrySet()) { - System.out.println(String.format("\t%s - %d", summaryItem.getKey(), summaryItem.getValue().getAsInt())); + System.out.println(String.format("\t%s - %d", summaryItem.getKey(), summaryItem.getValue().getAsInt())); } System.out.println("\nBy State:"); diff --git a/src/main/resources/examples/com/rallydev/rest/CrudExample.java b/src/main/resources/examples/com/rallydev/rest/CrudExample.java index eff21ac..58d168f 100644 --- a/src/main/resources/examples/com/rallydev/rest/CrudExample.java +++ b/src/main/resources/examples/com/rallydev/rest/CrudExample.java @@ -1,10 +1,7 @@ package com.rallydev.rest; import com.google.gson.JsonObject; -import com.rallydev.rest.request.CreateRequest; -import com.rallydev.rest.request.DeleteRequest; -import com.rallydev.rest.request.GetRequest; -import com.rallydev.rest.request.UpdateRequest; +import com.rallydev.rest.request.*; import com.rallydev.rest.response.CreateResponse; import com.rallydev.rest.response.DeleteResponse; import com.rallydev.rest.response.GetResponse; @@ -21,7 +18,7 @@ public static void main(String[] args) throws URISyntaxException, IOException { //Create and configure a new instance of RallyRestApi //(Server, username, password and proxy settings configured in Factory) RallyRestApi restApi = RestApiFactory.getRestApi(); - + try { //Create a defect diff --git a/src/main/resources/examples/com/rallydev/rest/RestApiFactory.java b/src/main/resources/examples/com/rallydev/rest/RestApiFactory.java index b70ff79..35554ed 100644 --- a/src/main/resources/examples/com/rallydev/rest/RestApiFactory.java +++ b/src/main/resources/examples/com/rallydev/rest/RestApiFactory.java @@ -12,10 +12,13 @@ public class RestApiFactory { private static final String WSAPI_VERSION = "v2.0"; //Specify your Rally username - private static final String USERNAME = "YOUR_USERNAME"; + private static final String USERNAME = ""; //Specify your Rally password - private static final String PASSWORD = "YOUR_PASSWORD"; + private static final String PASSWORD = ""; + + //Specify your Rally api key + private static final String API_KEY = ""; //If using a proxy specify full url, like http://my.proxy.com:8000 private static final String PROXY_SERVER = null; @@ -25,7 +28,12 @@ public class RestApiFactory { private static final String PROXY_PASSWORD = null; public static RallyRestApi getRestApi() throws URISyntaxException { - RallyRestApi restApi = new RallyRestApi(new URI(SERVER), USERNAME, PASSWORD); + RallyRestApi restApi; + if(API_KEY != null && !API_KEY.equals("")) { + restApi = new RallyRestApi(new URI(SERVER), API_KEY); + } else { + restApi = new RallyRestApi(new URI(SERVER), USERNAME, PASSWORD); + } if (PROXY_SERVER != null) { URI uri = new URI(PROXY_SERVER); if (PROXY_USERNAME != null) { diff --git a/src/test/java/com/rallydev/rest/RallyRestApiTest.java b/src/test/java/com/rallydev/rest/RallyRestApiTest.java index 81c233e..eba2d1c 100644 --- a/src/test/java/com/rallydev/rest/RallyRestApiTest.java +++ b/src/test/java/com/rallydev/rest/RallyRestApiTest.java @@ -3,333 +3,294 @@ import com.google.gson.Gson; import com.google.gson.JsonArray; import com.google.gson.JsonObject; -import com.rallydev.rest.request.CreateRequest; -import com.rallydev.rest.request.DeleteRequest; -import com.rallydev.rest.request.GetRequest; -import com.rallydev.rest.request.QueryRequest; -import com.rallydev.rest.request.UpdateRequest; -import com.rallydev.rest.response.CreateResponse; -import com.rallydev.rest.response.DeleteResponse; -import com.rallydev.rest.response.GetResponse; -import com.rallydev.rest.response.QueryResponse; -import com.rallydev.rest.response.UpdateResponse; -import com.rallydev.rest.util.InvalidURLException; -import org.apache.http.Header; -import org.apache.http.NameValuePair; -import org.apache.http.client.methods.HttpEntityEnclosingRequestBase; -import org.apache.http.client.methods.HttpGet; -import org.apache.http.client.methods.HttpRequestBase; -import org.apache.http.client.utils.URIBuilder; -import org.mockito.ArgumentMatcher; +import com.rallydev.rest.client.ApiKeyClient; +import com.rallydev.rest.client.BasicAuthClient; +import com.rallydev.rest.request.*; +import com.rallydev.rest.response.*; import org.testng.Assert; import org.testng.annotations.BeforeMethod; import org.testng.annotations.Test; -import java.io.IOException; import java.net.URI; -import java.util.List; -import java.util.UUID; - -import static com.rallydev.rest.RallyRestApi.OPERATION_RESULT_KEY; -import static com.rallydev.rest.RallyRestApi.QUERY_RESULT_KEY; -import static com.rallydev.rest.RallyRestApi.SECURITY_TOKEN_KEY; -import static com.rallydev.rest.RallyRestApi.SECURITY_TOKEN_PARAM_KEY; -import static org.mockito.Matchers.eq; -import static org.mockito.Mockito.any; + import static org.mockito.Mockito.anyString; -import static org.mockito.Mockito.argThat; import static org.mockito.Mockito.doReturn; -import static org.mockito.Mockito.doThrow; import static org.mockito.Mockito.spy; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertTrue; @Test public class RallyRestApiTest { private RallyRestApi api; - private String securityToken; - private int attachTokenCount; private URI server; @BeforeMethod protected void setUp() throws Exception { - attachTokenCount = 0; server = new URI("https://someServer.rallydev.com"); - api = new RallyRestApi(server, "username", "password") { - @Override - protected void attachSecurityInfo(HttpRequestBase request) throws IOException { - attachTokenCount++; - } - }; - securityToken = UUID.randomUUID().toString(); - api.setSecurityToken(securityToken); - } - - public void shouldHandleInvalidURLIfSecurityEndpointDoesNotExist() throws Exception { - RallyRestApi apiSpy = spy(new RallyRestApi(server, "username", "password")); - - InvalidURLException exception = new InvalidURLException("invalid url"); - doThrow(exception).when(apiSpy).get(any(GetRequest.class), eq(true)); - HttpRequestBase request = new HttpGet(server); - apiSpy.attachSecurityInfo(request); - assertEquals(apiSpy.getSecurityToken(), RallyRestApi.SECURITY_ENDPOINT_DOES_NOT_EXIST); - verify(apiSpy, times(1)).get(any(GetRequest.class), eq(true)); + api = new RallyRestApi(server, "_1adfkj234fjlk"); + api.client = spy(api.client); - apiSpy.attachSecurityInfo(request); - //validate does not get called again once known sec endpoint does not exist - verify(apiSpy, times(1)).get(any(GetRequest.class), eq(true)); } - public void shouldAttachTheSecurityTokenToRequestWithExistingTokenValue() throws Exception { - api = new RallyRestApi(server, "username", "password"); - api.setSecurityToken(securityToken); - - HttpRequestBase request = new HttpGet(server); - api.attachSecurityInfo(request); - validateSecurityTokenParam(request); + public void shouldInitializeBasicAuthClient() { + RallyRestApi basicAuthApi = new RallyRestApi(server, "username", "password"); + Assert.assertTrue(basicAuthApi.getClient() instanceof BasicAuthClient); } - public void shouldAttachTheSecurityTokenToRequestWithoutExistingTokenValue() throws Exception { - RallyRestApi apiSpy = spy(new RallyRestApi(server, "username", "password")); - - JsonObject getResult = new JsonObject(); - getResult.add("Errors", new JsonArray()); - getResult.add("Warnings", new JsonArray()); - getResult.addProperty(SECURITY_TOKEN_KEY, securityToken); - JsonObject response = new JsonObject(); - response.add(OPERATION_RESULT_KEY, getResult); - - GetResponse toBeReturned = new GetResponse(new Gson().toJson(response)); - doReturn(toBeReturned).when(apiSpy).get(any(GetRequest.class), eq(true)); + public void shouldInitializeApiKeyClient() { + RallyRestApi apiKeyApi = new RallyRestApi(server, "apiKey"); + Assert.assertTrue(apiKeyApi.getClient() instanceof ApiKeyClient); + } - HttpRequestBase request = new HttpGet(server); - apiSpy.attachSecurityInfo(request); - verify(apiSpy, times(1)).get(any(GetRequest.class), eq(true)); - validateSecurityTokenParam(request); + public void shouldSetProxy() throws Exception { + URI proxy = new URI("http://my.proxy.com:8000"); + api.setProxy(proxy); + verify(api.client).setProxy(proxy); } - private void validateSecurityTokenParam(HttpRequestBase request) { - List params = new URIBuilder(request.getURI()).getQueryParams(); - boolean foundToken = false; - for (NameValuePair nvp : params) { - if (nvp.getName().equals(SECURITY_TOKEN_PARAM_KEY) && nvp.getValue().equals(securityToken)) { - foundToken = true; - } - } - assertTrue(foundToken); + public void shouldSetProxyWithCredentials() throws Exception { + URI proxy = new URI("http://my.proxy.com:8000"); + api.setProxy(proxy, "username", "password"); + verify(api.client).setProxy(proxy, "username", "password"); } - public void shouldCorrectlyCreateInWsapi1() throws Exception { - api.setWsapiVersion("1.43"); - assertCanCreate(); - assertEquals(attachTokenCount, 0); + public void shouldSetVendor() throws Exception { + api.setApplicationVendor("fooVendor"); + verify(api.client).setApplicationVendor("fooVendor"); } - public void shouldCorrectlyCreateInWsapi2() throws Exception { - api.setWsapiVersion("v2.0"); - assertCanCreate(); - assertEquals(attachTokenCount, 1); + public void shouldSetVersion() throws Exception { + api.setApplicationVersion("fooVersion"); + verify(api.client).setApplicationVersion("fooVersion"); } - public void shouldCorrectlyUpdateInWsapi1() throws Exception { - api.setWsapiVersion("1.43"); - assertCanUpdate(); - assertEquals(attachTokenCount, 0); + public void shouldSetName() throws Exception { + api.setApplicationName("fooName"); + verify(api.client).setApplicationName("fooName"); } - public void shouldCorrectlyUpdateInWsapi2() throws Exception { - api.setWsapiVersion("v2.0"); - assertCanUpdate(); - assertEquals(attachTokenCount, 1); + public void shouldGetWsapiVersion() { + Assert.assertEquals(api.getWsapiVersion(), api.client.getWsapiVersion()); } - public void shouldCorrectlyDeleteInWsapi1() throws Exception { + public void shouldSetWsapiVersion() { api.setWsapiVersion("1.43"); - assertCanDelete(); - assertEquals(attachTokenCount, 0); + Assert.assertEquals(api.getWsapiVersion(), api.client.getWsapiVersion()); + Assert.assertEquals(api.getWsapiVersion(), "1.43"); } - public void shouldCorrectlyDeleteInWsapi2() throws Exception { - api.setWsapiVersion("v2.0"); - assertCanDelete(); - assertEquals(attachTokenCount, 1); + public void shouldCreate() throws Exception { + JsonObject response = new JsonObject(); + JsonObject createResult = new JsonObject(); + response.add("CreateResult", createResult); + createResult.add("Errors", new JsonArray()); + createResult.add("Warnings", new JsonArray()); + JsonObject object = new JsonObject(); + object.addProperty("_ref", "/defect/1234"); + createResult.add("Object", object); + + JsonObject newDefect = new JsonObject(); + newDefect.addProperty("Name", "Foo"); + CreateRequest request = new CreateRequest("defect", newDefect); + + doReturn(new Gson().toJson(response)).when(api.client).doPost(request.toUrl(), request.getBody()); + CreateResponse createResponse = api.create(request); + + verify(api.client).doPost(request.toUrl(), request.getBody()); + Assert.assertTrue(createResponse.wasSuccessful()); + JsonObject createdObj = createResponse.getObject(); + assertEquals(createdObj.get("_ref").getAsString(), "/defect/1234"); } - public void shouldCorrectlyGet() throws Exception { + public void shouldUpdate() throws Exception { JsonObject response = new JsonObject(); - JsonObject defect = new JsonObject(); - response.add("Defect", defect); - defect.add("Errors", new JsonArray()); - defect.add("Warnings", new JsonArray()); - defect.addProperty("_ref", "/defect/1234.js"); - - RallyRestApi apiSpy = spy(api); - doReturn(new Gson().toJson(response)).when(apiSpy).doRequest(any(HttpRequestBase.class)); + JsonObject updateResult = new JsonObject(); + response.add("OperationResult", updateResult); + updateResult.add("Errors", new JsonArray()); + updateResult.add("Warnings", new JsonArray()); + JsonObject object = new JsonObject(); + object.addProperty("_ref", "/defect/1234"); + updateResult.add("Object", object); - GetRequest request = new GetRequest("/defect/1234.js"); - GetResponse getResponse = apiSpy.get(request); + JsonObject updatedDefect = new JsonObject(); + updatedDefect.addProperty("Name", "Foo"); + UpdateRequest request = new UpdateRequest("/defect/1234", updatedDefect); + doReturn(new Gson().toJson(response)).when(api.client).doPost(request.toUrl(), request.getBody()); + UpdateResponse updateResponse = api.update(request); - verify(apiSpy).doGet(api.buildWsapiUrl() + request.toUrl(), false); - Assert.assertTrue(getResponse.wasSuccessful()); - JsonObject obj = getResponse.getObject(); - assertEquals(obj.get("_ref").getAsString(), "/defect/1234.js"); - assertEquals(attachTokenCount, 0); + verify(api.client).doPost(request.toUrl(), request.getBody()); + Assert.assertTrue(updateResponse.wasSuccessful()); + JsonObject obj = updateResponse.getObject(); + assertEquals(obj.get("_ref").getAsString(), "/defect/1234"); } - public void shouldReturnCorrectWsapiUrl() throws Exception { - assertEquals(api.buildWsapiUrl(), "https://someServer.rallydev.com/slm/webservice/" + RallyRestApi.DEFAULT_WSAPI_VERSION); - api.setWsapiVersion("1.99"); - assertEquals(api.buildWsapiUrl(), "https://someServer.rallydev.com/slm/webservice/1.99"); + public void shouldUpdateCollection() throws Exception { + JsonObject response = new JsonObject(); + JsonObject result = new JsonObject(); + response.add("OperationResult", result); + result.add("Errors", new JsonArray()); + result.add("Warnings", new JsonArray()); + JsonArray results = new JsonArray(); + JsonObject tag = new JsonObject(); + tag.addProperty("_ref", "/tag/23456"); + results.add(tag); + result.add("Results", results); + + JsonArray updatedTags = new JsonArray(); + + updatedTags.add(tag); + CollectionUpdateRequest request = new CollectionUpdateRequest("/defect/1234/tags", updatedTags, true); + doReturn(new Gson().toJson(response)).when(api.client).doPost(request.toUrl(), request.getBody()); + CollectionUpdateResponse updateResponse = api.updateCollection(request); + + verify(api.client).doPost(request.toUrl(), request.getBody()); + Assert.assertTrue(updateResponse.wasSuccessful()); + JsonArray updateResults = updateResponse.getResults(); + assertEquals(updateResults.get(0).getAsJsonObject().get("_ref").getAsString(), "/tag/23456"); } - public void shouldCorrectlyEncodePutInUtf8() throws Exception { + public void shouldDelete() throws Exception { JsonObject response = new JsonObject(); + JsonObject deleteResult = new JsonObject(); + response.add("OperationResult", deleteResult); + deleteResult.add("Errors", new JsonArray()); + deleteResult.add("Warnings", new JsonArray()); - RallyRestApi apiSpy = spy(api); - doReturn(new Gson().toJson(response)).when(apiSpy).doRequest(any(HttpRequestBase.class)); + DeleteRequest request = new DeleteRequest("/defect/1234"); + doReturn(new Gson().toJson(response)).when(api.client).doDelete(request.toUrl()); + DeleteResponse deleteResponse = api.delete(request); - apiSpy.doPut("url", "body"); - verify(apiSpy).doRequest(argThat(new HttpRequestUtf8Matcher())); + verify(api.client).doDelete(request.toUrl()); + Assert.assertTrue(deleteResponse.wasSuccessful()); } - public void shouldCorrectlyEncodePostInUtf8() throws Exception { + public void shouldGet() throws Exception { JsonObject response = new JsonObject(); + JsonObject defect = new JsonObject(); + response.add("Defect", defect); + defect.add("Errors", new JsonArray()); + defect.add("Warnings", new JsonArray()); + defect.addProperty("_ref", "/defect/1234"); - RallyRestApi apiSpy = spy(api); - doReturn(new Gson().toJson(response)).when(apiSpy).doRequest(any(HttpRequestBase.class)); + GetRequest request = new GetRequest("/defect/1234"); + doReturn(new Gson().toJson(response)).when(api.client).doGet(request.toUrl()); + GetResponse getResponse = api.get(request); - apiSpy.doPost("url", "body"); - verify(apiSpy).doRequest(argThat(new HttpRequestUtf8Matcher())); + verify(api.client).doGet(request.toUrl()); + Assert.assertTrue(getResponse.wasSuccessful()); + JsonObject obj = getResponse.getObject(); + assertEquals(obj.get("_ref").getAsString(), "/defect/1234"); } - public void shouldCorrectlyQueryOnePage() throws Exception { + public void shouldQueryOnePage() throws Exception { JsonObject response = buildQueryResponse(5); - - RallyRestApi apiSpy = spy(api); - doReturn(new Gson().toJson(response)).when(apiSpy).doRequest(any(HttpRequestBase.class)); - QueryRequest request = new QueryRequest("Defect"); request.setPageSize(1); - QueryResponse queryResponse = apiSpy.query(request); + doReturn(new Gson().toJson(response)).when(api.client).doGet(request.toUrl()); + QueryResponse queryResponse = api.query(request); - verify(apiSpy, times(1)).doGet(anyString(), eq(false)); //make sure only one get - verify(apiSpy).doGet(api.buildWsapiUrl() + request.toUrl(), false); + verify(api.client, times(1)).doGet(anyString()); + verify(api.client).doGet(request.toUrl()); Assert.assertTrue(queryResponse.wasSuccessful()); assertEquals(queryResponse.getTotalResultCount(), 5); - assertEquals(attachTokenCount, 0); } - public void shouldCorrectlyQueryAllPages() throws Exception { + public void shouldQueryAllPages() throws Exception { JsonObject response = buildQueryResponse(5); - - RallyRestApi apiSpy = spy(api); - doReturn(new Gson().toJson(response)).when(apiSpy).doRequest(any(HttpRequestBase.class)); - QueryRequest request = new QueryRequest("Defect"); request.setPageSize(1); request.setLimit(Integer.MAX_VALUE); - apiSpy.query(request); - - String requestUrl = api.buildWsapiUrl() + request.toUrl(); - - verify(apiSpy, times(5)).doGet(anyString(), eq(false)); //make sure 5 gets - verify(apiSpy).doGet(requestUrl, false); - verify(apiSpy).doGet(requestUrl.replace("start=1", "start=2"), false); - verify(apiSpy).doGet(requestUrl.replace("start=1", "start=3"), false); - verify(apiSpy).doGet(requestUrl.replace("start=1", "start=4"), false); - verify(apiSpy).doGet(requestUrl.replace("start=1", "start=5"), false); - assertEquals(attachTokenCount, 0); + doReturn(new Gson().toJson(response)).when(api.client).doGet(anyString()); + api.query(request); + + String requestUrl = request.toUrl(); + verify(api.client, times(5)).doGet(anyString()); //make sure 5 gets + verify(api.client).doGet(requestUrl); + verify(api.client).doGet(requestUrl.replace("start=1", "start=2")); + verify(api.client).doGet(requestUrl.replace("start=1", "start=3")); + verify(api.client).doGet(requestUrl.replace("start=1", "start=4")); + verify(api.client).doGet(requestUrl.replace("start=1", "start=5")); } - public void shouldCorrectlyQuerySomePages() throws Exception { + public void shouldQuerySomePages() throws Exception { JsonObject response = buildQueryResponse(5); - RallyRestApi apiSpy = spy(api); - doReturn(new Gson().toJson(response)).when(apiSpy).doRequest(any(HttpRequestBase.class)); - QueryRequest request = new QueryRequest("Defect"); request.setPageSize(2); request.setLimit(4); - apiSpy.query(request); + doReturn(new Gson().toJson(response)).when(api.client).doGet(anyString()); + api.query(request); - String requestUrl = api.buildWsapiUrl() + request.toUrl(); + String requestUrl = request.toUrl(); - verify(apiSpy, times(2)).doGet(anyString(), eq(false)); //make sure 2 gets - verify(apiSpy).doGet(requestUrl, false); - verify(apiSpy).doGet(requestUrl.replace("start=1", "start=3"), false); - assertEquals(attachTokenCount, 0); + verify(api.client, times(2)).doGet(anyString()); //make sure 2 gets + verify(api.client).doGet(requestUrl); + verify(api.client).doGet(requestUrl.replace("start=1", "start=3")); } - public void shouldCorrectlyQueryNoPages() throws Exception { + public void shouldQueryNoPages() throws Exception { JsonObject response = buildQueryResponse(0); - RallyRestApi apiSpy = spy(api); - doReturn(new Gson().toJson(response)).when(apiSpy).doRequest(any(HttpRequestBase.class)); - QueryRequest request = new QueryRequest("Defect"); request.setPageSize(1); request.setLimit(4); - apiSpy.query(request); + doReturn(new Gson().toJson(response)).when(api.client).doGet(anyString()); + api.query(request); - String requestUrl = api.buildWsapiUrl() + request.toUrl(); - - verify(apiSpy, times(1)).doGet(anyString(), eq(false)); //make sure 1 get - verify(apiSpy).doGet(requestUrl, false); - assertEquals(attachTokenCount, 0); + verify(api.client, times(1)).doGet(anyString()); //make sure 1 get + verify(api.client).doGet(request.toUrl()); } - public void shouldCorrectlyQuerySomePagesWithNonStandardStart() throws Exception { + public void shouldQuerySomePagesWithNonStandardStart() throws Exception { JsonObject response = buildQueryResponse(10); - RallyRestApi apiSpy = spy(api); - doReturn(new Gson().toJson(response)).when(apiSpy).doRequest(any(HttpRequestBase.class)); - QueryRequest request = new QueryRequest("Defect"); request.setPageSize(1); request.setStart(5); request.setLimit(4); - apiSpy.query(request); + doReturn(new Gson().toJson(response)).when(api.client).doGet(anyString()); + api.query(request); - String requestUrl = api.buildWsapiUrl() + request.toUrl(); + String requestUrl = request.toUrl(); - verify(apiSpy, times(4)).doGet(anyString(), eq(false)); //make sure 4 gets - verify(apiSpy).doGet(requestUrl, false); - verify(apiSpy).doGet(requestUrl.replace("start=5", "start=6"), false); - verify(apiSpy).doGet(requestUrl.replace("start=5", "start=7"), false); - verify(apiSpy).doGet(requestUrl.replace("start=5", "start=8"), false); - assertEquals(attachTokenCount, 0); + verify(api.client, times(4)).doGet(anyString()); //make sure 4 gets + verify(api.client).doGet(requestUrl); + verify(api.client).doGet(requestUrl.replace("start=5", "start=6")); + verify(api.client).doGet(requestUrl.replace("start=5", "start=7")); + verify(api.client).doGet(requestUrl.replace("start=5", "start=8")); } - public void shouldCorrectlyQueryAllPagesWithNonStandardStart() throws Exception { + public void shouldQueryAllPagesWithNonStandardStart() throws Exception { JsonObject response = buildQueryResponse(10); - RallyRestApi apiSpy = spy(api); - doReturn(new Gson().toJson(response)).when(apiSpy).doRequest(any(HttpRequestBase.class)); - QueryRequest request = new QueryRequest("Defect"); request.setPageSize(1); request.setStart(5); request.setLimit(Integer.MAX_VALUE); - apiSpy.query(request); - - String requestUrl = api.buildWsapiUrl() + request.toUrl(); - - verify(apiSpy, times(6)).doGet(anyString(), eq(false)); //make sure 6 gets - verify(apiSpy).doGet(requestUrl, false); - verify(apiSpy).doGet(requestUrl.replace("start=5", "start=6"), false); - verify(apiSpy).doGet(requestUrl.replace("start=5", "start=7"), false); - verify(apiSpy).doGet(requestUrl.replace("start=5", "start=8"), false); - verify(apiSpy).doGet(requestUrl.replace("start=5", "start=9"), false); - verify(apiSpy).doGet(requestUrl.replace("start=5", "start=10"), false); - assertEquals(attachTokenCount, 0); + doReturn(new Gson().toJson(response)).when(api.client).doGet(anyString()); + api.query(request); + + String requestUrl = request.toUrl(); + + verify(api.client, times(6)).doGet(anyString()); //make sure 6 gets + verify(api.client).doGet(requestUrl); + verify(api.client).doGet(requestUrl.replace("start=5", "start=6")); + verify(api.client).doGet(requestUrl.replace("start=5", "start=7")); + verify(api.client).doGet(requestUrl.replace("start=5", "start=8")); + verify(api.client).doGet(requestUrl.replace("start=5", "start=9")); + verify(api.client).doGet(requestUrl.replace("start=5", "start=10")); + } + + public void shouldClose() throws Exception { + api.close(); + verify(api.client).close(); } private JsonObject buildQueryResponse(int totalResultCount) { JsonObject response = new JsonObject(); JsonObject queryResult = new JsonObject(); - response.add(QUERY_RESULT_KEY, queryResult); + response.add("QueryResult", queryResult); queryResult.add("Errors", new JsonArray()); queryResult.add("Warnings", new JsonArray()); queryResult.add("Results", new JsonArray()); @@ -337,80 +298,4 @@ private JsonObject buildQueryResponse(int totalResultCount) { return response; } - private void assertCanCreate() throws Exception { - JsonObject response = new JsonObject(); - JsonObject createResult = new JsonObject(); - response.add("CreateResult", createResult); - createResult.add("Errors", new JsonArray()); - createResult.add("Warnings", new JsonArray()); - JsonObject object = new JsonObject(); - object.addProperty("_ref", "/defect/1234.js"); - createResult.add("Object", object); - - RallyRestApi apiSpy = spy(api); - doReturn(new Gson().toJson(response)).when(apiSpy).doRequest(any(HttpRequestBase.class)); - - JsonObject newDefect = new JsonObject(); - newDefect.addProperty("Name", "Foo"); - CreateRequest request = new CreateRequest("defect", newDefect); - CreateResponse createResponse = apiSpy.create(request); - - verify(apiSpy).doPost(api.buildWsapiUrl() + request.toUrl(), request.getBody()); - Assert.assertTrue(createResponse.wasSuccessful()); - JsonObject createdObj = createResponse.getObject(); - assertEquals(createdObj.get("_ref").getAsString(), "/defect/1234.js"); - //assertEquals(attachTokenCount, 1); - } - - private void assertCanUpdate() throws Exception { - JsonObject response = new JsonObject(); - JsonObject updateResult = new JsonObject(); - response.add(OPERATION_RESULT_KEY, updateResult); - updateResult.add("Errors", new JsonArray()); - updateResult.add("Warnings", new JsonArray()); - JsonObject object = new JsonObject(); - object.addProperty("_ref", "/defect/1234.js"); - updateResult.add("Object", object); - - RallyRestApi apiSpy = spy(api); - doReturn(new Gson().toJson(response)).when(apiSpy).doRequest(any(HttpRequestBase.class)); - - JsonObject updatedDefect = new JsonObject(); - updatedDefect.addProperty("Name", "Foo"); - UpdateRequest request = new UpdateRequest("/defect/1234.js", updatedDefect); - UpdateResponse updateResponse = apiSpy.update(request); - - verify(apiSpy).doPost(api.buildWsapiUrl() + request.toUrl(), request.getBody()); - Assert.assertTrue(updateResponse.wasSuccessful()); - JsonObject obj = updateResponse.getObject(); - assertEquals(obj.get("_ref").getAsString(), "/defect/1234.js"); - } - - private void assertCanDelete() throws Exception { - JsonObject response = new JsonObject(); - JsonObject deleteResult = new JsonObject(); - response.add(OPERATION_RESULT_KEY, deleteResult); - deleteResult.add("Errors", new JsonArray()); - deleteResult.add("Warnings", new JsonArray()); - - RallyRestApi apiSpy = spy(api); - doReturn(new Gson().toJson(response)).when(apiSpy).doRequest(any(HttpRequestBase.class)); - - DeleteRequest request = new DeleteRequest("/defect/1234.js"); - DeleteResponse deleteResponse = apiSpy.delete(request); - - verify(apiSpy).doDelete(api.buildWsapiUrl() + request.toUrl()); - Assert.assertTrue(deleteResponse.wasSuccessful()); - } - - class HttpRequestUtf8Matcher extends ArgumentMatcher { - public boolean matches(Object o) { - if (o instanceof HttpEntityEnclosingRequestBase) { - HttpEntityEnclosingRequestBase h = (HttpEntityEnclosingRequestBase) o; - Header contentType = h.getEntity().getContentType(); - return contentType.getValue().toLowerCase().contains("utf-8"); - } - return false; - } - } } diff --git a/src/test/java/com/rallydev/rest/client/ApiKeyClientTest.java b/src/test/java/com/rallydev/rest/client/ApiKeyClientTest.java new file mode 100644 index 0000000..84ca9e6 --- /dev/null +++ b/src/test/java/com/rallydev/rest/client/ApiKeyClientTest.java @@ -0,0 +1,40 @@ +package com.rallydev.rest.client; + +import com.rallydev.rest.matchers.HttpRequestHeaderMatcher; +import org.apache.http.client.methods.HttpGet; +import org.apache.http.client.methods.HttpRequestBase; +import org.testng.Assert; +import org.testng.annotations.BeforeMethod; +import org.testng.annotations.Test; + +import java.net.URI; +import java.net.URISyntaxException; + +import static org.mockito.Matchers.any; +import static org.mockito.Matchers.argThat; +import static org.mockito.Mockito.*; + +public class ApiKeyClientTest { + + private String server = "https://rally1.rallydev.com"; + private String apiKey = "foo"; + private ApiKeyClient client; + + @BeforeMethod + public void setUp() throws URISyntaxException { + ApiKeyClient client = new ApiKeyClient(new URI(server), apiKey); + this.client = spy(client); + } + + @Test + public void shouldIntialize() { + Assert.assertEquals(client.getServer(), server); + } + + @Test + public void shouldIncludeApiKeyOnRequest() throws Exception { + doReturn("").when(client).executeRequest(any(HttpRequestBase.class)); + client.doRequest(new HttpGet()); + verify(client).doRequest(argThat(new HttpRequestHeaderMatcher("zsessionid", apiKey))); + } +} diff --git a/src/test/java/com/rallydev/rest/client/BasicAuthClientTest.java b/src/test/java/com/rallydev/rest/client/BasicAuthClientTest.java new file mode 100644 index 0000000..e661892 --- /dev/null +++ b/src/test/java/com/rallydev/rest/client/BasicAuthClientTest.java @@ -0,0 +1,92 @@ +package com.rallydev.rest.client; + +import com.rallydev.rest.matchers.HttpRequestHeaderMatcher; +import org.apache.http.Header; +import org.apache.http.client.methods.*; +import org.apache.http.impl.auth.BasicScheme; +import org.testng.Assert; +import org.testng.annotations.BeforeMethod; +import org.testng.annotations.Test; + +import java.net.URI; +import java.net.URISyntaxException; + +import static org.mockito.Matchers.any; +import static org.mockito.Mockito.*; + +public class BasicAuthClientTest { + + private String server = "https://rally1.rallydev.com"; + private String userName = "foo"; + private String password = "bar"; + private BasicAuthClient client; + + private static String SECURITY_TOKEN_RESPONSE ="{\"OperationResult\":{\"SecurityToken\":\"foo\",\"Errors\":[]}}"; + + @BeforeMethod + public void setUp() throws URISyntaxException { + BasicAuthClient client = new BasicAuthClient(new URI(server), userName, password); + this.client = spy(client); + } + + @Test + public void shouldIntialize() { + Assert.assertEquals(client.getServer(), server); + Assert.assertEquals(client.credentials.getPassword(), password); + Assert.assertEquals(client.credentials.getUserPrincipal().getName(), userName); + } + + @Test + public void shouldNotIncludeCSRFTokenOnGet() throws Exception { + doReturn("").when(client).executeRequest(any(HttpRequestBase.class)); + client.doRequest(new HttpGet()); + verify(client, times(0)).attachSecurityInfo(any(HttpRequestBase.class)); + } + + @Test + public void shouldNotIncludeCSRFTokenOnWsapiv1() throws Exception { + client.setWsapiVersion("1.43"); + doReturn("").when(client).executeRequest(any(HttpRequestBase.class)); + client.doRequest(new HttpPost()); + verify(client, times(0)).attachSecurityInfo(any(HttpRequestBase.class)); + } + + @Test + public void shouldRequestCSRFToken() throws Exception { + doReturn("").when(client).executeRequest(any(HttpPost.class)); + doReturn(SECURITY_TOKEN_RESPONSE).when(client).executeRequest(any(HttpGet.class)); + client.doRequest(new HttpPost(server)); + Header authHeader = BasicScheme.authenticate(client.credentials, "utf-8", false); + verify(client).executeRequest(argThat(new HttpRequestHeaderMatcher(authHeader.getName(), authHeader.getValue()))); + } + + @Test + public void shouldIncludeCSRFTokenOnPost() throws Exception { + doReturn("").when(client).executeRequest(any(HttpPost.class)); + doReturn(SECURITY_TOKEN_RESPONSE).when(client).executeRequest(any(HttpGet.class)); + HttpPost post = new HttpPost(server); + client.doRequest(post); + post.getURI().getQuery().contains(BasicAuthClient.SECURITY_TOKEN_KEY + "=foo"); + verify(client).executeRequest(post); + } + + @Test + public void shouldIncludeCSRFTokenOnPut() throws Exception { + doReturn("").when(client).executeRequest(any(HttpPut.class)); + doReturn(SECURITY_TOKEN_RESPONSE).when(client).executeRequest(any(HttpGet.class)); + HttpPut put = new HttpPut(server); + client.doRequest(put); + put.getURI().getQuery().contains(BasicAuthClient.SECURITY_TOKEN_KEY + "=foo"); + verify(client).executeRequest(put); + } + + @Test + public void shouldIncludeCSRFTokenOnDelete() throws Exception { + doReturn("").when(client).executeRequest(any(HttpDelete.class)); + doReturn(SECURITY_TOKEN_RESPONSE).when(client).executeRequest(any(HttpGet.class)); + HttpDelete delete = new HttpDelete(server); + client.doRequest(delete); + delete.getURI().getQuery().contains(BasicAuthClient.SECURITY_TOKEN_KEY + "=foo"); + verify(client).executeRequest(delete); + } +} \ No newline at end of file diff --git a/src/test/java/com/rallydev/rest/client/HttpClientTest.java b/src/test/java/com/rallydev/rest/client/HttpClientTest.java new file mode 100644 index 0000000..414c33c --- /dev/null +++ b/src/test/java/com/rallydev/rest/client/HttpClientTest.java @@ -0,0 +1,172 @@ +package com.rallydev.rest.client; + +import com.rallydev.rest.matchers.HttpRequestBodyMatcher; +import com.rallydev.rest.matchers.HttpRequestHeaderMatcher; +import com.rallydev.rest.matchers.HttpRequestUrlMatcher; +import org.apache.http.*; +import org.apache.http.client.methods.*; +import org.apache.http.conn.params.ConnRoutePNames; +import org.apache.http.entity.StringEntity; +import org.apache.http.impl.client.CloseableHttpClient; +import org.apache.http.impl.client.DecompressingHttpClient; +import org.testng.Assert; +import org.testng.annotations.BeforeMethod; +import org.testng.annotations.Test; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.net.URI; +import java.net.URISyntaxException; + +import static org.mockito.Matchers.any; +import static org.mockito.Matchers.argThat; +import static org.mockito.Mockito.*; + +public class HttpClientTest { + + private String server = "https://rally1.rallydev.com"; + private HttpClient client; + + @BeforeMethod + public void setUp() throws URISyntaxException { + HttpClient client = new HttpClient(new URI(server)); + this.client = spy(client); + } + + @Test + public void shouldIntialize() { + Assert.assertEquals(client.getServer(), server); + } + + @Test + public void shouldSetProxy() throws Exception { + URI proxy = new URI("http://my.proxy.com:8000"); + client.setProxy(proxy); + HttpHost actualProxy = new HttpHost( + client.getProxy().getHost(), + client.getProxy().getPort(), + client.getProxy().getScheme()); + Assert.assertEquals(actualProxy, + new HttpHost(proxy.getHost(), proxy.getPort(), proxy.getScheme())); + verify(client).buildClient(); + } + + @Test + public void shouldSetProxyWithCredentials() throws Exception { + URI proxy = new URI("http://my.proxy.com:8000"); + client.setProxy(proxy, "username", "password"); + HttpHost actualProxy = new HttpHost( + client.getProxy().getHost(), + client.getProxy().getPort(), + client.getProxy().getScheme()); + Assert.assertEquals(actualProxy, + new HttpHost(proxy.getHost(), proxy.getPort(), proxy.getScheme())); + verify(client).buildClient(); + } + + @Test + public void shouldSetApplicationVendor() throws Exception { + doReturn("").when(client).executeRequest(any(HttpRequestBase.class)); + client.setApplicationVendor("FooVendor"); + client.doRequest(new HttpGet()); + verify(client).doRequest(argThat(new HttpRequestHeaderMatcher("X-RallyIntegrationVendor", "FooVendor"))); + } + + @Test + public void shouldSetApplicationName() throws Exception { + doReturn("").when(client).executeRequest(any(HttpRequestBase.class)); + client.setApplicationName("FooName"); + client.doRequest(new HttpGet()); + verify(client).doRequest(argThat(new HttpRequestHeaderMatcher("X-RallyIntegrationName", "FooName"))); + } + + @Test + public void shouldSetApplicationVersion() throws Exception { + doReturn("").when(client).executeRequest(any(HttpRequestBase.class)); + client.setApplicationVersion("FooVersion"); + client.doRequest(new HttpGet()); + verify(client).doRequest(argThat(new HttpRequestHeaderMatcher("X-RallyIntegrationVersion", "FooVersion"))); + } + + @Test + public void shouldUseDefaultWsapiVersion() { + Assert.assertEquals(client.getWsapiVersion(), "v2.0"); + Assert.assertEquals(client.getWsapiUrl(), server + "/slm/webservice/v2.0"); + } + + @Test + public void shouldSetWsapiVersion() { + client.setWsapiVersion("v3.0"); + Assert.assertEquals(client.getWsapiVersion(), "v3.0"); + Assert.assertEquals(client.getWsapiUrl(), server + "/slm/webservice/v3.0"); + } + + @Test + public void shouldPost() throws Exception { + String url = "/defect/12345"; + String body = "{}"; + doReturn("").when(client).doRequest(any(HttpPost.class)); + client.doPost(url, body); + verify(client).doRequest(argThat(new HttpRequestBodyMatcher(client.getWsapiUrl() + url, body))); + } + + @Test + public void shouldPut() throws Exception { + String url = "/defect/12345"; + String body = "{}"; + doReturn("").when(client).doRequest(any(HttpPut.class)); + client.doPut(url, body); + verify(client).doRequest(argThat(new HttpRequestBodyMatcher(client.getWsapiUrl() + url, body))); + } + + @Test + public void shouldDelete() throws Exception { + String url = "/defect/12345"; + doReturn("").when(client).doRequest(any(HttpDelete.class)); + client.doDelete(url); + verify(client).doRequest(argThat(new HttpRequestUrlMatcher(client.getWsapiUrl() + url))); + } + + @Test + public void shouldGet() throws Exception { + String url = "/defect/12345"; + doReturn("").when(client).doRequest(any(HttpGet.class)); + client.doGet(url); + verify(client).doRequest(argThat(new HttpRequestUrlMatcher(client.getWsapiUrl() + url))); + } + + @Test + public void shouldGzip() throws Exception { + String url = "/defect/1234"; + client.client = spy(client.client); + doReturn(createMockResponse("{}")).when(client.client).execute(any(HttpGet.class)); + client.doGet(url); + Assert.assertTrue(client.client instanceof CloseableHttpClient); + verify(client.client).execute(argThat(new HttpRequestUrlMatcher(client.getWsapiUrl() + url))); + } + + @Test + public void shouldReturnValidResponse() throws Exception { + client.client = spy(client.client); + doReturn(createMockResponse("{}")).when(client.client).execute(any(HttpGet.class)); + String response = client.doGet("/defect/1234"); + Assert.assertEquals("{}", response); + } + + @Test(expectedExceptions = IOException.class) + public void shouldExplodeWithInvalidResponse() throws Exception { + client.client = spy(client.client); + doReturn(createMockResponse("")).when(client.client).execute(any(HttpGet.class)); + client.doGet("/defect/1234"); + } + + private CloseableHttpResponse createMockResponse(String responseText) throws Exception { + CloseableHttpResponse response = mock(CloseableHttpResponse.class); + StatusLine status = mock(StatusLine.class); + when(response.getStatusLine()).thenReturn(status); + when(status.getStatusCode()).thenReturn(responseText.length() == 0 ? 500 : 200); + when(response.getEntity()).thenReturn(new StringEntity(responseText)); + return response; + } +} \ No newline at end of file diff --git a/src/test/java/com/rallydev/rest/matchers/HttpRequestBodyMatcher.java b/src/test/java/com/rallydev/rest/matchers/HttpRequestBodyMatcher.java new file mode 100644 index 0000000..9577bdb --- /dev/null +++ b/src/test/java/com/rallydev/rest/matchers/HttpRequestBodyMatcher.java @@ -0,0 +1,27 @@ +package com.rallydev.rest.matchers; + +import org.apache.http.Header; +import org.apache.http.client.methods.HttpEntityEnclosingRequestBase; +import org.apache.http.client.methods.HttpRequestBase; +import org.mockito.ArgumentMatcher; + +public class HttpRequestBodyMatcher extends ArgumentMatcher { + private String url; + private String body; + + public HttpRequestBodyMatcher(String url, String body) { + this.url = url; + this.body = body; + } + + public boolean matches(Object o) { + if (o instanceof HttpEntityEnclosingRequestBase) { + HttpEntityEnclosingRequestBase h = (HttpEntityEnclosingRequestBase) o; + Header contentType = h.getEntity().getContentType(); + return contentType.getValue().toLowerCase().contains("utf-8") && + h.getURI().toString().equals(url) && + h.getEntity().toString().equals(body); + } + return false; + } +} \ No newline at end of file diff --git a/src/test/java/com/rallydev/rest/matchers/HttpRequestHeaderMatcher.java b/src/test/java/com/rallydev/rest/matchers/HttpRequestHeaderMatcher.java new file mode 100644 index 0000000..a941d12 --- /dev/null +++ b/src/test/java/com/rallydev/rest/matchers/HttpRequestHeaderMatcher.java @@ -0,0 +1,24 @@ +package com.rallydev.rest.matchers; + +import org.apache.http.Header; +import org.apache.http.client.methods.HttpRequestBase; +import org.mockito.ArgumentMatcher; + +public class HttpRequestHeaderMatcher extends ArgumentMatcher { + private String name; + private String value; + + public HttpRequestHeaderMatcher(String name, String value) { + this.name = name; + this.value = value; + } + + public boolean matches(Object o) { + if (o instanceof HttpRequestBase) { + HttpRequestBase h = (HttpRequestBase) o; + Header header = h.getFirstHeader(name); + return header != null && header.getValue().equals(value); + } + return false; + } +} diff --git a/src/test/java/com/rallydev/rest/matchers/HttpRequestUrlMatcher.java b/src/test/java/com/rallydev/rest/matchers/HttpRequestUrlMatcher.java new file mode 100644 index 0000000..7be5fc1 --- /dev/null +++ b/src/test/java/com/rallydev/rest/matchers/HttpRequestUrlMatcher.java @@ -0,0 +1,22 @@ +package com.rallydev.rest.matchers; + +import org.apache.http.Header; +import org.apache.http.client.methods.HttpRequestBase; +import org.mockito.ArgumentMatcher; + +public class HttpRequestUrlMatcher extends ArgumentMatcher { + private String url; + private String value; + + public HttpRequestUrlMatcher(String url) { + this.url = url; + } + + public boolean matches(Object o) { + if (o instanceof HttpRequestBase) { + HttpRequestBase h = (HttpRequestBase) o; + return h.getURI().toString().equals(url); + } + return false; + } +} diff --git a/src/test/java/com/rallydev/rest/request/CollectionUpdateRequestTest.java b/src/test/java/com/rallydev/rest/request/CollectionUpdateRequestTest.java new file mode 100644 index 0000000..2fb7fc4 --- /dev/null +++ b/src/test/java/com/rallydev/rest/request/CollectionUpdateRequestTest.java @@ -0,0 +1,45 @@ +package com.rallydev.rest.request; + +import com.google.gson.JsonArray; +import com.google.gson.JsonObject; +import com.rallydev.rest.util.Fetch; +import org.testng.Assert; +import org.testng.annotations.Test; + +public class CollectionUpdateRequestTest { + + @Test + public void shouldCreateACorrectBody() { + JsonArray items = new JsonArray(); + JsonObject tag = new JsonObject(); + tag.addProperty("_ref", "/tag/2345"); + items.add(tag); + CollectionUpdateRequest req = new CollectionUpdateRequest("/hierarchicalrequirement/1234/tags.js", items, true); + Assert.assertEquals(req.getBody(), "{\"CollectionItems\":[{\"_ref\":\"/tag/2345\"}]}"); + } + + @Test + public void shouldConstructTheCorrectUrlForAdds() { + JsonArray items = new JsonArray(); + CollectionUpdateRequest req = new CollectionUpdateRequest("/defect/1234/tags", items, true); + req.setFetch(new Fetch("Name", "Description")); + Assert.assertEquals(req.toUrl(), "/defect/1234/tags/add.js?fetch=Name%2CDescription"); + } + + @Test + public void shouldConstructTheCorrectUrlForRemoves() { + JsonObject tagsCollection = new JsonObject(); + tagsCollection.addProperty("_ref", "/defect/1234/tags"); + JsonArray items = new JsonArray(); + CollectionUpdateRequest req = new CollectionUpdateRequest(tagsCollection, items, false); + Assert.assertEquals(req.toUrl(), "/defect/1234/tags/remove.js?fetch=true"); + } + + @Test + public void shouldConstructTheCorrectUrlWithExtraParam() { + JsonArray items = new JsonArray(); + CollectionUpdateRequest req = new CollectionUpdateRequest("/defect/1234/tags", items, true); + req.addParam("foo", "Bar"); + Assert.assertEquals(req.toUrl(), "/defect/1234/tags/add.js?foo=Bar&fetch=true"); + } +} diff --git a/src/test/java/com/rallydev/rest/request/CreateRequestTest.java b/src/test/java/com/rallydev/rest/request/CreateRequestTest.java index 164f4fc..9fc8a6e 100644 --- a/src/test/java/com/rallydev/rest/request/CreateRequestTest.java +++ b/src/test/java/com/rallydev/rest/request/CreateRequestTest.java @@ -1,5 +1,6 @@ package com.rallydev.rest.request; +import com.google.gson.JsonNull; import com.google.gson.JsonObject; import com.rallydev.rest.util.Fetch; import org.apache.http.client.utils.URLEncodedUtils; @@ -16,6 +17,16 @@ public void shouldCreateACorrectBody() { Assert.assertEquals(req.getBody(), "{\"HierarchicalRequirement\":{\"Name\":\"My Story\"}}"); } + @Test + public void shouldCreateACorrectBodyWithNullFields() { + JsonObject body = new JsonObject(); + body.addProperty("Name", "My Story"); + body.add("Feature", JsonNull.INSTANCE); + CreateRequest req = new CreateRequest("HierarchicalRequirement", body); + req.getGsonBuilder().serializeNulls(); + Assert.assertEquals(req.getBody(), "{\"HierarchicalRequirement\":{\"Name\":\"My Story\",\"Feature\":null}}"); + } + @Test public void shouldConstructTheCorrectUrl() { JsonObject body = new JsonObject(); diff --git a/src/test/java/com/rallydev/rest/request/RequestTest.java b/src/test/java/com/rallydev/rest/request/RequestTest.java index 246b227..68086b5 100644 --- a/src/test/java/com/rallydev/rest/request/RequestTest.java +++ b/src/test/java/com/rallydev/rest/request/RequestTest.java @@ -1,5 +1,6 @@ package com.rallydev.rest.request; +import com.google.gson.GsonBuilder; import org.apache.http.NameValuePair; import org.apache.http.message.BasicNameValuePair; import org.testng.Assert; @@ -45,4 +46,19 @@ public void shouldBeAbleToSetParams() { Assert.assertSame(params, r.getParams()); Assert.assertEquals(r.getParams().size(), 1); } + + @Test + public void shouldBeAbleToSetGsonBuilder() { + Request r = createRequest(); + Assert.assertEquals(r.getParams().size(), 0); + + GsonBuilder previous = r.getGsonBuilder(); + GsonBuilder brandNew = new GsonBuilder(); + + r.setGsonBuilder(brandNew); + + Assert.assertNotNull(r.getGsonBuilder()); + Assert.assertSame(r.getGsonBuilder(), brandNew); + Assert.assertNotSame(brandNew, previous); + } } diff --git a/src/test/java/com/rallydev/rest/request/UpdateRequestTest.java b/src/test/java/com/rallydev/rest/request/UpdateRequestTest.java index bf8235a..df8f72f 100644 --- a/src/test/java/com/rallydev/rest/request/UpdateRequestTest.java +++ b/src/test/java/com/rallydev/rest/request/UpdateRequestTest.java @@ -1,5 +1,6 @@ package com.rallydev.rest.request; +import com.google.gson.JsonNull; import com.google.gson.JsonObject; import com.rallydev.rest.util.Fetch; import org.testng.Assert; @@ -15,6 +16,15 @@ public void shouldCreateACorrectBody() { Assert.assertEquals(req.getBody(), "{\"hierarchicalrequirement\":{\"Name\":\"My Story\"}}"); } + @Test + public void shouldCreateACorrectBodyWithNullFieldsByDefault() { + JsonObject body = new JsonObject(); + body.addProperty("Name", "My Story"); + body.add("Feature", JsonNull.INSTANCE); + UpdateRequest req = new UpdateRequest("https://rally1.rallydev.com/slm/webservice/1.32/hierarchicalrequirement/1234.js", body); + Assert.assertEquals(req.getBody(), "{\"hierarchicalrequirement\":{\"Name\":\"My Story\",\"Feature\":null}}"); + } + @Test public void shouldConstructTheCorrectUrl() { JsonObject body = new JsonObject(); diff --git a/src/test/java/com/rallydev/rest/response/CollectionUpdateResponseTest.java b/src/test/java/com/rallydev/rest/response/CollectionUpdateResponseTest.java new file mode 100644 index 0000000..093e9ec --- /dev/null +++ b/src/test/java/com/rallydev/rest/response/CollectionUpdateResponseTest.java @@ -0,0 +1,43 @@ +package com.rallydev.rest.response; + +import com.google.gson.Gson; +import com.google.gson.JsonArray; +import com.google.gson.JsonObject; +import org.testng.Assert; +import org.testng.annotations.Test; + +public class CollectionUpdateResponseTest { + private CollectionUpdateResponse createResponse(String[] errors, JsonArray results) { + return new CollectionUpdateResponse("{\"OperationResult\": { \"Errors\": " + new Gson().toJson(errors) + ", \"Warnings\": [], " + + "\"Results\": " + new Gson().toJson(results) + "}}"); + } + + @Test + public void shouldReturnResults() { + JsonArray results = new JsonArray(); + JsonObject r1 = new JsonObject(); + r1.addProperty("_ref", "/tag/12345"); + results.add(r1); + JsonObject r2 = new JsonObject(); + r2.addProperty("_ref", "/tag/23456"); + results.add(r2); + + CollectionUpdateResponse r = createResponse(new String[]{}, results); + + Assert.assertEquals(r.getErrors().length, 0, "Error length correct"); + Assert.assertEquals(r.getResults().size(), 2, "Result length correct"); + Assert.assertEquals(r.getResults().get(0).getAsJsonObject().get("_ref").getAsString(), "/tag/12345", "First result correct"); + Assert.assertEquals(r.getResults().get(1).getAsJsonObject().get("_ref").getAsString(), "/tag/23456", "Second result correct"); + Assert.assertTrue(r.wasSuccessful()); + } + + @Test + public void shouldReturnNoErrors() { + CollectionUpdateResponse r = createResponse(new String[]{"Foo"}, new JsonArray()); + + Assert.assertEquals(r.getErrors().length, 1, "Error length correct"); + Assert.assertEquals(r.getErrors()[0], "Foo"); + Assert.assertFalse(r.wasSuccessful()); + Assert.assertEquals(r.getResults().size(), 0); + } +} diff --git a/src/test/java/com/rallydev/rest/response/GetResponseTest.java b/src/test/java/com/rallydev/rest/response/GetResponseTest.java index 0772e57..9f70a0c 100644 --- a/src/test/java/com/rallydev/rest/response/GetResponseTest.java +++ b/src/test/java/com/rallydev/rest/response/GetResponseTest.java @@ -4,12 +4,10 @@ import org.testng.Assert; import org.testng.annotations.Test; -import static com.rallydev.rest.RallyRestApi.OPERATION_RESULT_KEY; - public class GetResponseTest { - + private GetResponse createResponse(String[] errors) { - return new GetResponse("{\"" + (errors.length > 0 ? OPERATION_RESULT_KEY: "Defect") + + return new GetResponse("{\"" + (errors.length > 0 ? "OperationResult" : "Defect") + "\": { \"Errors\": " + new Gson().toJson(errors) + ", \"Foo\": \"Bar\"}}"); } diff --git a/src/test/java/com/rallydev/rest/response/QueryResponseTest.java b/src/test/java/com/rallydev/rest/response/QueryResponseTest.java index 4ca2a94..c4b7c04 100644 --- a/src/test/java/com/rallydev/rest/response/QueryResponseTest.java +++ b/src/test/java/com/rallydev/rest/response/QueryResponseTest.java @@ -27,8 +27,8 @@ public void shouldReturnResults() { Assert.assertEquals(r.getErrors().length, 0, "Error length correct"); Assert.assertEquals(r.getTotalResultCount(), 2, "Total result count correct"); Assert.assertEquals(r.getResults().size(), 2, "Result length correct"); - Assert.assertEquals(r.getResults().get(0).getAsJsonObject().get("Foo").getAsInt(), 7, "First error correct"); - Assert.assertEquals(r.getResults().get(1).getAsJsonObject().get("Foo").getAsInt(), 1, "First error correct"); + Assert.assertEquals(r.getResults().get(0).getAsJsonObject().get("Foo").getAsInt(), 7, "First result correct"); + Assert.assertEquals(r.getResults().get(1).getAsJsonObject().get("Foo").getAsInt(), 1, "First result correct"); Assert.assertTrue(r.wasSuccessful()); Assert.assertEquals(r.getPageSize(), 20); Assert.assertEquals(r.getStart(), 1); diff --git a/src/test/java/com/rallydev/rest/util/RefTest.java b/src/test/java/com/rallydev/rest/util/RefTest.java index 0c22b78..272a895 100644 --- a/src/test/java/com/rallydev/rest/util/RefTest.java +++ b/src/test/java/com/rallydev/rest/util/RefTest.java @@ -9,6 +9,7 @@ public class RefTest { public void shouldDetectValidRefs() { Assert.assertTrue(Ref.isRef("/defect/1234"), "Valid relative ref"); Assert.assertTrue(Ref.isRef("/defect/1234.js"), "Valid relative ref w/ extension"); + Assert.assertTrue(Ref.isRef("/typedefinition/-1234.js"), "Valid relative built-in typedef ref"); Assert.assertTrue(Ref.isRef("https://rally1.rallydev.com/slm/webservice/1.32/defect/1234"), "Valid absolute ref"); Assert.assertTrue(Ref.isRef("http://rally1.rallydev.com/slm/webservice/1.32/defect/1234.js"), "Valid absolute ref w/ extension"); } @@ -75,6 +76,7 @@ public void shouldReturnNullTypesFromRefs() { public void shouldReturnOidsFromRefs() { Assert.assertEquals(Ref.getOidFromRef("/defect/1234"), "1234", "Relative ref"); Assert.assertEquals(Ref.getOidFromRef("/defect/1234.js"), "1234", "Relative ref with extension"); + Assert.assertEquals(Ref.getOidFromRef("/typedefinition/-1234.js"), "-1234", "Relative built-in typedef ref"); Assert.assertEquals(Ref.getOidFromRef("https://rally1.rallydev.com/slm/webservice/1.32/defect/1234"), "1234", "Valid absolute ref"); }