From 52e8ad27c4476f3f8b694fb9263fe32090f89d5b Mon Sep 17 00:00:00 2001 From: Kyle Morse Date: Wed, 16 Mar 2016 08:50:21 -0600 Subject: [PATCH] Javadocs for 2.2.1 release --- LICENSE | 7 - README.md | 26 - RallyRestToolkitForJava.iml | 31 - RallyRestToolkitForJava.ipr | 357 ------- ...lasses-frame.html => allclasses-frame.html | 8 +- ...es-noframe.html => allclasses-noframe.html | 8 +- com/rallydev/rest/RallyRestApi.html | 707 ++++++++++++++ .../rallydev/rest/class-use/RallyRestApi.html | 47 +- com/rallydev/rest/client/ApiKeyClient.html | 399 ++++++++ com/rallydev/rest/client/BasicAuthClient.html | 478 ++++++++++ com/rallydev/rest/client/HttpClient.html | 752 +++++++++++++++ .../rest/client/class-use/ApiKeyClient.html | 47 +- .../client/class-use/BasicAuthClient.html | 47 +- .../rest/client/class-use/HttpClient.html | 83 +- .../rallydev/rest/client/package-frame.html | 6 +- .../rallydev/rest/client/package-summary.html | 57 +- .../rallydev/rest/client/package-tree.html | 57 +- .../rallydev/rest/client/package-use.html | 49 +- .../rallydev/rest/package-frame.html | 6 +- .../rallydev/rest/package-summary.html | 57 +- .../rallydev/rest/package-tree.html | 49 +- .../rallydev/rest/package-use.html | 43 +- .../rest/request/CollectionUpdateRequest.html | 411 ++++++++ com/rallydev/rest/request/CreateRequest.html | 382 ++++++++ com/rallydev/rest/request/DeleteRequest.html | 318 +++++++ com/rallydev/rest/request/GetRequest.html | 373 ++++++++ com/rallydev/rest/request/QueryRequest.html | 788 ++++++++++++++++ com/rallydev/rest/request/Request.html | 432 +++++++++ com/rallydev/rest/request/UpdateRequest.html | 382 ++++++++ .../class-use/CollectionUpdateRequest.html | 53 +- .../rest/request/class-use/CreateRequest.html | 53 +- .../rest/request/class-use/DeleteRequest.html | 53 +- .../rest/request/class-use/GetRequest.html | 53 +- .../rest/request/class-use/QueryRequest.html | 57 +- .../rest/request/class-use/Request.html | 63 +- .../rest/request/class-use/UpdateRequest.html | 53 +- .../rallydev/rest/request/package-frame.html | 6 +- .../rest/request/package-summary.html | 57 +- .../rallydev/rest/request/package-tree.html | 61 +- .../rallydev/rest/request/package-use.html | 49 +- .../response/CollectionUpdateResponse.html | 338 +++++++ .../rest/response/CreateResponse.html | 338 +++++++ .../rest/response/DeleteResponse.html | 317 +++++++ com/rallydev/rest/response/GetResponse.html | 338 +++++++ com/rallydev/rest/response/QueryResponse.html | 398 ++++++++ com/rallydev/rest/response/Response.html | 401 ++++++++ .../rest/response/UpdateResponse.html | 338 +++++++ .../class-use/CollectionUpdateResponse.html | 53 +- .../response/class-use/CreateResponse.html | 53 +- .../response/class-use/DeleteResponse.html | 53 +- .../rest/response/class-use/GetResponse.html | 53 +- .../response/class-use/QueryResponse.html | 53 +- .../rest/response/class-use/Response.html | 63 +- .../response/class-use/UpdateResponse.html | 53 +- .../rallydev/rest/response/package-frame.html | 6 +- .../rest/response/package-summary.html | 57 +- .../rallydev/rest/response/package-tree.html | 61 +- .../rallydev/rest/response/package-use.html | 49 +- com/rallydev/rest/util/Fetch.html | 364 ++++++++ com/rallydev/rest/util/QueryFilter.html | 423 +++++++++ com/rallydev/rest/util/Ref.html | 349 +++++++ .../rallydev/rest/util/class-use/Fetch.html | 85 +- .../rest/util/class-use/QueryFilter.html | 92 +- .../rallydev/rest/util/class-use/Ref.html | 47 +- .../rallydev/rest/util/package-frame.html | 6 +- .../rallydev/rest/util/package-summary.html | 57 +- .../rallydev/rest/util/package-tree.html | 59 +- .../rallydev/rest/util/package-use.html | 49 +- constant-values.html | 188 ++++ ...precated-list.html => deprecated-list.html | 49 +- .../doc/help-doc.html => help-doc.html | 47 +- index-all.html | 883 ++++++++++++++++++ .../resources/doc/index.html => index.html | 14 +- ...overview-frame.html => overview-frame.html | 8 +- ...view-summary.html => overview-summary.html | 45 +- .../overview-tree.html => overview-tree.html | 99 +- .../doc/package-list => package-list | 0 pom.xml | 117 --- script.js | 30 + ...rialized-form.html => serialized-form.html | 45 +- src/main/java/META-INF/MANIFEST.MF | 9 - .../java/com/rallydev/rest/RallyRestApi.java | 221 ----- .../rallydev/rest/client/ApiKeyClient.java | 39 - .../rallydev/rest/client/BasicAuthClient.java | 89 -- .../com/rallydev/rest/client/HttpClient.java | 247 ----- .../rallydev/rest/client/package-info.java | 4 - .../java/com/rallydev/rest/package-info.java | 4 - .../rest/request/CollectionUpdateRequest.java | 96 -- .../rallydev/rest/request/CreateRequest.java | 77 -- .../rallydev/rest/request/DeleteRequest.java | 32 - .../com/rallydev/rest/request/GetRequest.java | 75 -- .../rallydev/rest/request/QueryRequest.java | 305 ------ .../com/rallydev/rest/request/Request.java | 83 -- .../rallydev/rest/request/UpdateRequest.java | 79 -- .../rallydev/rest/request/package-info.java | 4 - .../response/CollectionUpdateResponse.java | 37 - .../rest/response/CreateResponse.java | 38 - .../rest/response/DeleteResponse.java | 26 - .../rallydev/rest/response/GetResponse.java | 46 - .../rallydev/rest/response/QueryResponse.java | 65 -- .../com/rallydev/rest/response/Response.java | 69 -- .../rest/response/UpdateResponse.java | 37 - .../rallydev/rest/response/package-info.java | 4 - .../java/com/rallydev/rest/util/Fetch.java | 40 - .../com/rallydev/rest/util/QueryFilter.java | 115 --- src/main/java/com/rallydev/rest/util/Ref.java | 103 -- .../com/rallydev/rest/util/package-info.java | 4 - .../rallydev/rest/CollectionAddExample.html | 261 ------ .../rallydev/rest/CollectionQueryExample.html | 261 ------ .../rest/CollectionSummaryExample.html | 261 ------ .../doc/com/rallydev/rest/CrudExample.html | 261 ------ .../doc/com/rallydev/rest/QueryExample.html | 261 ------ .../doc/com/rallydev/rest/RallyRestApi.html | 578 ------------ .../com/rallydev/rest/RallyRestApiTest.html | 567 ----------- .../doc/com/rallydev/rest/RestApiFactory.html | 259 ----- .../rest/class-use/CollectionAddExample.html | 115 --- .../class-use/CollectionQueryExample.html | 115 --- .../class-use/CollectionSummaryExample.html | 115 --- .../rallydev/rest/class-use/CrudExample.html | 115 --- .../rallydev/rest/class-use/QueryExample.html | 115 --- .../rest/class-use/RallyRestApiTest.html | 115 --- .../rest/class-use/RestApiFactory.html | 115 --- .../rallydev/rest/client/ApiKeyClient.html | 275 ------ .../rest/client/ApiKeyClientTest.html | 288 ------ .../rallydev/rest/client/BasicAuthClient.html | 277 ------ .../rest/client/BasicAuthClientTest.html | 368 -------- .../com/rallydev/rest/client/HttpClient.html | 520 ----------- .../rallydev/rest/client/HttpClientTest.html | 490 ---------- .../client/class-use/ApiKeyClientTest.html | 115 --- .../client/class-use/BasicAuthClientTest.html | 115 --- .../rest/client/class-use/HttpClientTest.html | 115 --- .../rest/matchers/HttpRequestBodyMatcher.html | 292 ------ .../matchers/HttpRequestHeaderMatcher.html | 292 ------ .../rest/matchers/HttpRequestUrlMatcher.html | 290 ------ .../class-use/HttpRequestBodyMatcher.html | 115 --- .../class-use/HttpRequestHeaderMatcher.html | 115 --- .../class-use/HttpRequestUrlMatcher.html | 115 --- .../rallydev/rest/matchers/package-frame.html | 21 - .../rest/matchers/package-summary.html | 141 --- .../rallydev/rest/matchers/package-tree.html | 138 --- .../rallydev/rest/matchers/package-use.html | 115 --- .../rest/request/CollectionUpdateRequest.html | 358 ------- .../request/CollectionUpdateRequestTest.html | 295 ------ .../rallydev/rest/request/CreateRequest.html | 335 ------- .../rest/request/CreateRequestTest.html | 321 ------- .../rallydev/rest/request/DeleteRequest.html | 281 ------ .../rest/request/DeleteRequestTest.html | 282 ------ .../com/rallydev/rest/request/GetRequest.html | 317 ------- .../rallydev/rest/request/GetRequestTest.html | 308 ------ .../rallydev/rest/request/QueryRequest.html | 673 ------------- .../rest/request/QueryRequestTest.html | 451 --------- .../com/rallydev/rest/request/Request.html | 357 ------- .../rallydev/rest/request/RequestTest.html | 282 ------ .../rallydev/rest/request/UpdateRequest.html | 335 ------- .../rest/request/UpdateRequestTest.html | 308 ------ .../CollectionUpdateRequestTest.html | 115 --- .../request/class-use/CreateRequestTest.html | 115 --- .../request/class-use/DeleteRequestTest.html | 115 --- .../request/class-use/GetRequestTest.html | 115 --- .../request/class-use/QueryRequestTest.html | 115 --- .../rest/request/class-use/RequestTest.html | 115 --- .../request/class-use/UpdateRequestTest.html | 115 --- .../response/CollectionUpdateResponse.html | 278 ------ .../CollectionUpdateResponseTest.html | 269 ------ .../rest/response/CreateResponse.html | 278 ------ .../rest/response/CreateResponseTest.html | 269 ------ .../rest/response/DeleteResponse.html | 245 ----- .../rest/response/DeleteResponseTest.html | 269 ------ .../rallydev/rest/response/GetResponse.html | 278 ------ .../rest/response/GetResponseTest.html | 269 ------ .../rallydev/rest/response/QueryResponse.html | 329 ------- .../rest/response/QueryResponseTest.html | 269 ------ .../com/rallydev/rest/response/Response.html | 303 ------ .../rallydev/rest/response/ResponseTest.html | 295 ------ .../rest/response/UpdateResponse.html | 278 ------ .../rest/response/UpdateResponseTest.html | 269 ------ .../CollectionUpdateResponseTest.html | 115 --- .../class-use/CreateResponseTest.html | 115 --- .../class-use/DeleteResponseTest.html | 115 --- .../response/class-use/GetResponseTest.html | 115 --- .../response/class-use/QueryResponseTest.html | 115 --- .../rest/response/class-use/ResponseTest.html | 115 --- .../class-use/UpdateResponseTest.html | 115 --- .../doc/com/rallydev/rest/util/Fetch.html | 317 ------- .../doc/com/rallydev/rest/util/FetchTest.html | 282 ------ .../rest/util/InvalidURLException.html | 255 ----- .../com/rallydev/rest/util/QueryFilter.html | 355 ------- .../rallydev/rest/util/QueryFilterTest.html | 360 ------- .../doc/com/rallydev/rest/util/Ref.html | 316 ------- .../doc/com/rallydev/rest/util/RefTest.html | 451 --------- .../rest/util/class-use/FetchTest.html | 115 --- .../util/class-use/InvalidURLException.html | 115 --- .../rest/util/class-use/QueryFilterTest.html | 115 --- .../rallydev/rest/util/class-use/RefTest.html | 115 --- src/main/resources/doc/constant-values.html | 115 --- .../resources/doc/index-files/index-1.html | 138 --- .../resources/doc/index-files/index-10.html | 150 --- .../resources/doc/index-files/index-11.html | 154 --- .../resources/doc/index-files/index-12.html | 230 ----- .../resources/doc/index-files/index-13.html | 154 --- .../resources/doc/index-files/index-14.html | 142 --- .../resources/doc/index-files/index-15.html | 122 --- .../resources/doc/index-files/index-16.html | 122 --- .../resources/doc/index-files/index-2.html | 126 --- .../resources/doc/index-files/index-3.html | 190 ---- .../resources/doc/index-files/index-4.html | 154 --- .../resources/doc/index-files/index-5.html | 126 --- .../resources/doc/index-files/index-6.html | 278 ------ .../resources/doc/index-files/index-7.html | 122 --- .../resources/doc/index-files/index-8.html | 130 --- .../resources/doc/index-files/index-9.html | 126 --- .../resources/doc/resources/background.gif | Bin 2313 -> 0 bytes src/main/resources/doc/resources/tab.gif | Bin 291 -> 0 bytes src/main/resources/doc/resources/titlebar.gif | Bin 10701 -> 0 bytes .../resources/doc/resources/titlebar_end.gif | Bin 849 -> 0 bytes .../rallydev/rest/CollectionAddExample.java | 63 -- .../rallydev/rest/CollectionQueryExample.java | 56 -- .../rest/CollectionSummaryExample.java | 54 -- .../com/rallydev/rest/CrudExample.java | 63 -- .../com/rallydev/rest/QueryExample.java | 59 -- .../com/rallydev/rest/RestApiFactory.java | 50 - .../com/rallydev/rest/RallyRestApiTest.java | 301 ------ .../rest/client/ApiKeyClientTest.java | 40 - .../rest/client/BasicAuthClientTest.java | 92 -- .../rallydev/rest/client/HttpClientTest.java | 162 ---- .../rest/matchers/HttpRequestBodyMatcher.java | 27 - .../matchers/HttpRequestHeaderMatcher.java | 24 - .../rest/matchers/HttpRequestUrlMatcher.java | 22 - .../request/CollectionUpdateRequestTest.java | 45 - .../rest/request/CreateRequestTest.java | 61 -- .../rest/request/DeleteRequestTest.java | 26 - .../rallydev/rest/request/GetRequestTest.java | 45 - .../rest/request/QueryRequestTest.java | 165 ---- .../rallydev/rest/request/RequestTest.java | 64 -- .../rest/request/UpdateRequestTest.java | 50 - .../CollectionUpdateResponseTest.java | 43 - .../rest/response/CreateResponseTest.java | 32 - .../rest/response/DeleteResponseTest.java | 31 - .../rest/response/GetResponseTest.java | 35 - .../rest/response/QueryResponseTest.java | 47 - .../rallydev/rest/response/ResponseTest.java | 50 - .../rest/response/UpdateResponseTest.java | 32 - .../com/rallydev/rest/util/FetchTest.java | 31 - .../rallydev/rest/util/QueryFilterTest.java | 72 -- .../java/com/rallydev/rest/util/RefTest.java | 125 --- .../doc/stylesheet.css => stylesheet.css | 342 ++++--- 246 files changed, 11794 insertions(+), 29003 deletions(-) delete mode 100644 LICENSE delete mode 100644 README.md delete mode 100644 RallyRestToolkitForJava.iml delete mode 100644 RallyRestToolkitForJava.ipr rename src/main/resources/doc/allclasses-frame.html => allclasses-frame.html (91%) rename src/main/resources/doc/allclasses-noframe.html => allclasses-noframe.html (90%) create mode 100644 com/rallydev/rest/RallyRestApi.html rename {src/main/resources/doc/com => com}/rallydev/rest/class-use/RallyRestApi.html (66%) create mode 100644 com/rallydev/rest/client/ApiKeyClient.html create mode 100644 com/rallydev/rest/client/BasicAuthClient.html create mode 100644 com/rallydev/rest/client/HttpClient.html rename {src/main/resources/doc/com => com}/rallydev/rest/client/class-use/ApiKeyClient.html (66%) rename {src/main/resources/doc/com => com}/rallydev/rest/client/class-use/BasicAuthClient.html (66%) rename {src/main/resources/doc/com => com}/rallydev/rest/client/class-use/HttpClient.html (57%) rename {src/main/resources/doc/com => com}/rallydev/rest/client/package-frame.html (75%) rename {src/main/resources/doc/com => com}/rallydev/rest/client/package-summary.html (70%) rename {src/main/resources/doc/com => com}/rallydev/rest/client/package-tree.html (58%) rename {src/main/resources/doc/com => com}/rallydev/rest/client/package-use.html (72%) rename {src/main/resources/doc/com => com}/rallydev/rest/package-frame.html (69%) rename {src/main/resources/doc/com => com}/rallydev/rest/package-summary.html (66%) rename {src/main/resources/doc/com => com}/rallydev/rest/package-tree.html (61%) rename {src/main/resources/doc/com => com}/rallydev/rest/package-use.html (65%) create mode 100644 com/rallydev/rest/request/CollectionUpdateRequest.html create mode 100644 com/rallydev/rest/request/CreateRequest.html create mode 100644 com/rallydev/rest/request/DeleteRequest.html create mode 100644 com/rallydev/rest/request/GetRequest.html create mode 100644 com/rallydev/rest/request/QueryRequest.html create mode 100644 com/rallydev/rest/request/Request.html create mode 100644 com/rallydev/rest/request/UpdateRequest.html rename {src/main/resources/doc/com => com}/rallydev/rest/request/class-use/CollectionUpdateRequest.html (68%) rename {src/main/resources/doc/com => com}/rallydev/rest/request/class-use/CreateRequest.html (68%) rename {src/main/resources/doc/com => com}/rallydev/rest/request/class-use/DeleteRequest.html (68%) rename {src/main/resources/doc/com => com}/rallydev/rest/request/class-use/GetRequest.html (68%) rename {src/main/resources/doc/com => com}/rallydev/rest/request/class-use/QueryRequest.html (70%) rename {src/main/resources/doc/com => com}/rallydev/rest/request/class-use/Request.html (64%) rename {src/main/resources/doc/com => com}/rallydev/rest/request/class-use/UpdateRequest.html (68%) rename {src/main/resources/doc/com => com}/rallydev/rest/request/package-frame.html (82%) rename {src/main/resources/doc/com => com}/rallydev/rest/request/package-summary.html (75%) rename {src/main/resources/doc/com => com}/rallydev/rest/request/package-tree.html (62%) rename {src/main/resources/doc/com => com}/rallydev/rest/request/package-use.html (77%) create mode 100644 com/rallydev/rest/response/CollectionUpdateResponse.html create mode 100644 com/rallydev/rest/response/CreateResponse.html create mode 100644 com/rallydev/rest/response/DeleteResponse.html create mode 100644 com/rallydev/rest/response/GetResponse.html create mode 100644 com/rallydev/rest/response/QueryResponse.html create mode 100644 com/rallydev/rest/response/Response.html create mode 100644 com/rallydev/rest/response/UpdateResponse.html rename {src/main/resources/doc/com => com}/rallydev/rest/response/class-use/CollectionUpdateResponse.html (68%) rename {src/main/resources/doc/com => com}/rallydev/rest/response/class-use/CreateResponse.html (68%) rename {src/main/resources/doc/com => com}/rallydev/rest/response/class-use/DeleteResponse.html (68%) rename {src/main/resources/doc/com => com}/rallydev/rest/response/class-use/GetResponse.html (68%) rename {src/main/resources/doc/com => com}/rallydev/rest/response/class-use/QueryResponse.html (68%) rename {src/main/resources/doc/com => com}/rallydev/rest/response/class-use/Response.html (64%) rename {src/main/resources/doc/com => com}/rallydev/rest/response/class-use/UpdateResponse.html (68%) rename {src/main/resources/doc/com => com}/rallydev/rest/response/package-frame.html (82%) rename {src/main/resources/doc/com => com}/rallydev/rest/response/package-summary.html (75%) rename {src/main/resources/doc/com => com}/rallydev/rest/response/package-tree.html (63%) rename {src/main/resources/doc/com => com}/rallydev/rest/response/package-use.html (76%) create mode 100644 com/rallydev/rest/util/Fetch.html create mode 100644 com/rallydev/rest/util/QueryFilter.html create mode 100644 com/rallydev/rest/util/Ref.html rename {src/main/resources/doc/com => com}/rallydev/rest/util/class-use/Fetch.html (60%) rename {src/main/resources/doc/com => com}/rallydev/rest/util/class-use/QueryFilter.html (57%) rename {src/main/resources/doc/com => com}/rallydev/rest/util/class-use/Ref.html (65%) rename {src/main/resources/doc/com => com}/rallydev/rest/util/package-frame.html (74%) rename {src/main/resources/doc/com => com}/rallydev/rest/util/package-summary.html (69%) rename {src/main/resources/doc/com => com}/rallydev/rest/util/package-tree.html (50%) rename {src/main/resources/doc/com => com}/rallydev/rest/util/package-use.html (73%) create mode 100644 constant-values.html rename src/main/resources/doc/deprecated-list.html => deprecated-list.html (62%) rename src/main/resources/doc/help-doc.html => help-doc.html (82%) create mode 100644 index-all.html rename src/main/resources/doc/index.html => index.html (86%) rename src/main/resources/doc/overview-frame.html => overview-frame.html (71%) rename src/main/resources/doc/overview-summary.html => overview-summary.html (73%) rename src/main/resources/doc/overview-tree.html => overview-tree.html (52%) rename src/main/resources/doc/package-list => package-list (100%) delete mode 100644 pom.xml create mode 100644 script.js rename src/main/resources/doc/serialized-form.html => serialized-form.html (62%) delete mode 100644 src/main/java/META-INF/MANIFEST.MF delete mode 100644 src/main/java/com/rallydev/rest/RallyRestApi.java delete mode 100644 src/main/java/com/rallydev/rest/client/ApiKeyClient.java delete mode 100644 src/main/java/com/rallydev/rest/client/BasicAuthClient.java delete mode 100644 src/main/java/com/rallydev/rest/client/HttpClient.java delete mode 100644 src/main/java/com/rallydev/rest/client/package-info.java delete mode 100644 src/main/java/com/rallydev/rest/package-info.java delete mode 100644 src/main/java/com/rallydev/rest/request/CollectionUpdateRequest.java delete mode 100644 src/main/java/com/rallydev/rest/request/CreateRequest.java delete mode 100644 src/main/java/com/rallydev/rest/request/DeleteRequest.java delete mode 100644 src/main/java/com/rallydev/rest/request/GetRequest.java delete mode 100644 src/main/java/com/rallydev/rest/request/QueryRequest.java delete mode 100644 src/main/java/com/rallydev/rest/request/Request.java delete mode 100644 src/main/java/com/rallydev/rest/request/UpdateRequest.java delete mode 100644 src/main/java/com/rallydev/rest/request/package-info.java delete mode 100644 src/main/java/com/rallydev/rest/response/CollectionUpdateResponse.java delete mode 100644 src/main/java/com/rallydev/rest/response/CreateResponse.java delete mode 100644 src/main/java/com/rallydev/rest/response/DeleteResponse.java delete mode 100644 src/main/java/com/rallydev/rest/response/GetResponse.java delete mode 100644 src/main/java/com/rallydev/rest/response/QueryResponse.java delete mode 100644 src/main/java/com/rallydev/rest/response/Response.java delete mode 100644 src/main/java/com/rallydev/rest/response/UpdateResponse.java delete mode 100644 src/main/java/com/rallydev/rest/response/package-info.java delete mode 100644 src/main/java/com/rallydev/rest/util/Fetch.java delete mode 100644 src/main/java/com/rallydev/rest/util/QueryFilter.java delete mode 100644 src/main/java/com/rallydev/rest/util/Ref.java delete mode 100644 src/main/java/com/rallydev/rest/util/package-info.java delete mode 100644 src/main/resources/doc/com/rallydev/rest/CollectionAddExample.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/CollectionQueryExample.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/CollectionSummaryExample.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/CrudExample.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/QueryExample.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/RallyRestApi.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/RallyRestApiTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/RestApiFactory.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/class-use/CollectionAddExample.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/class-use/CollectionQueryExample.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/class-use/CollectionSummaryExample.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/class-use/CrudExample.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/class-use/QueryExample.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/class-use/RallyRestApiTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/class-use/RestApiFactory.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/client/ApiKeyClient.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/client/ApiKeyClientTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/client/BasicAuthClient.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/client/BasicAuthClientTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/client/HttpClient.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/client/HttpClientTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/client/class-use/ApiKeyClientTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/client/class-use/BasicAuthClientTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/client/class-use/HttpClientTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestBodyMatcher.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestHeaderMatcher.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestUrlMatcher.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestBodyMatcher.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestHeaderMatcher.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestUrlMatcher.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/matchers/package-frame.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/matchers/package-summary.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/matchers/package-tree.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/matchers/package-use.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/CollectionUpdateRequest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/CollectionUpdateRequestTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/CreateRequest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/CreateRequestTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/DeleteRequest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/DeleteRequestTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/GetRequest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/GetRequestTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/QueryRequest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/QueryRequestTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/Request.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/RequestTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/UpdateRequest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/UpdateRequestTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/class-use/CollectionUpdateRequestTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/class-use/CreateRequestTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/class-use/DeleteRequestTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/class-use/GetRequestTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/class-use/QueryRequestTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/class-use/RequestTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/request/class-use/UpdateRequestTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/CollectionUpdateResponse.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/CollectionUpdateResponseTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/CreateResponse.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/CreateResponseTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/DeleteResponse.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/DeleteResponseTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/GetResponse.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/GetResponseTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/QueryResponse.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/QueryResponseTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/Response.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/ResponseTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/UpdateResponse.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/UpdateResponseTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/class-use/CollectionUpdateResponseTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/class-use/CreateResponseTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/class-use/DeleteResponseTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/class-use/GetResponseTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/class-use/QueryResponseTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/class-use/ResponseTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/response/class-use/UpdateResponseTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/util/Fetch.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/util/FetchTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/util/InvalidURLException.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/util/QueryFilter.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/util/QueryFilterTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/util/Ref.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/util/RefTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/util/class-use/FetchTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/util/class-use/InvalidURLException.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/util/class-use/QueryFilterTest.html delete mode 100644 src/main/resources/doc/com/rallydev/rest/util/class-use/RefTest.html delete mode 100644 src/main/resources/doc/constant-values.html delete mode 100644 src/main/resources/doc/index-files/index-1.html delete mode 100644 src/main/resources/doc/index-files/index-10.html delete mode 100644 src/main/resources/doc/index-files/index-11.html delete mode 100644 src/main/resources/doc/index-files/index-12.html delete mode 100644 src/main/resources/doc/index-files/index-13.html delete mode 100644 src/main/resources/doc/index-files/index-14.html delete mode 100644 src/main/resources/doc/index-files/index-15.html delete mode 100644 src/main/resources/doc/index-files/index-16.html delete mode 100644 src/main/resources/doc/index-files/index-2.html delete mode 100644 src/main/resources/doc/index-files/index-3.html delete mode 100644 src/main/resources/doc/index-files/index-4.html delete mode 100644 src/main/resources/doc/index-files/index-5.html delete mode 100644 src/main/resources/doc/index-files/index-6.html delete mode 100644 src/main/resources/doc/index-files/index-7.html delete mode 100644 src/main/resources/doc/index-files/index-8.html delete mode 100644 src/main/resources/doc/index-files/index-9.html delete mode 100644 src/main/resources/doc/resources/background.gif delete mode 100644 src/main/resources/doc/resources/tab.gif delete mode 100644 src/main/resources/doc/resources/titlebar.gif delete mode 100644 src/main/resources/doc/resources/titlebar_end.gif delete mode 100644 src/main/resources/examples/com/rallydev/rest/CollectionAddExample.java delete mode 100644 src/main/resources/examples/com/rallydev/rest/CollectionQueryExample.java delete mode 100644 src/main/resources/examples/com/rallydev/rest/CollectionSummaryExample.java delete mode 100644 src/main/resources/examples/com/rallydev/rest/CrudExample.java delete mode 100644 src/main/resources/examples/com/rallydev/rest/QueryExample.java delete mode 100644 src/main/resources/examples/com/rallydev/rest/RestApiFactory.java delete mode 100644 src/test/java/com/rallydev/rest/RallyRestApiTest.java delete mode 100644 src/test/java/com/rallydev/rest/client/ApiKeyClientTest.java delete mode 100644 src/test/java/com/rallydev/rest/client/BasicAuthClientTest.java delete mode 100644 src/test/java/com/rallydev/rest/client/HttpClientTest.java delete mode 100644 src/test/java/com/rallydev/rest/matchers/HttpRequestBodyMatcher.java delete mode 100644 src/test/java/com/rallydev/rest/matchers/HttpRequestHeaderMatcher.java delete mode 100644 src/test/java/com/rallydev/rest/matchers/HttpRequestUrlMatcher.java delete mode 100644 src/test/java/com/rallydev/rest/request/CollectionUpdateRequestTest.java delete mode 100644 src/test/java/com/rallydev/rest/request/CreateRequestTest.java delete mode 100644 src/test/java/com/rallydev/rest/request/DeleteRequestTest.java delete mode 100644 src/test/java/com/rallydev/rest/request/GetRequestTest.java delete mode 100644 src/test/java/com/rallydev/rest/request/QueryRequestTest.java delete mode 100644 src/test/java/com/rallydev/rest/request/RequestTest.java delete mode 100644 src/test/java/com/rallydev/rest/request/UpdateRequestTest.java delete mode 100644 src/test/java/com/rallydev/rest/response/CollectionUpdateResponseTest.java delete mode 100644 src/test/java/com/rallydev/rest/response/CreateResponseTest.java delete mode 100644 src/test/java/com/rallydev/rest/response/DeleteResponseTest.java delete mode 100644 src/test/java/com/rallydev/rest/response/GetResponseTest.java delete mode 100644 src/test/java/com/rallydev/rest/response/QueryResponseTest.java delete mode 100644 src/test/java/com/rallydev/rest/response/ResponseTest.java delete mode 100644 src/test/java/com/rallydev/rest/response/UpdateResponseTest.java delete mode 100644 src/test/java/com/rallydev/rest/util/FetchTest.java delete mode 100644 src/test/java/com/rallydev/rest/util/QueryFilterTest.java delete mode 100644 src/test/java/com/rallydev/rest/util/RefTest.java rename src/main/resources/doc/stylesheet.css => stylesheet.css (50%) diff --git a/LICENSE b/LICENSE deleted file mode 100644 index bb49c9e..0000000 --- a/LICENSE +++ /dev/null @@ -1,7 +0,0 @@ -Copyright (c) 2002-2012 Rally Software Development Corp. All Rights Reserved. - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index 5deef6c..0000000 --- a/README.md +++ /dev/null @@ -1,26 +0,0 @@ -## License - -Copyright (c) Rally Software Development Corp. 2013 Distributed under the MIT License. - -## Warranty - -The Java Toolkit for Rally REST API is available on an as-is basis. - -## Support - -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 - -## Download - -[Download REST API jar and dependencies](https://github.com/RallyTools/RallyRestToolkitForJava/wiki/User-Guide#setup) - -## User Guide - -Please view the [Java Toolkit for Rally REST API User Guide](https://github.com/RallyTools/RallyRestToolkitForJava/wiki/User-Guide) in the attached wiki - -[Java Toolkit for Rally REST API javadocs](http://rallytools.github.io/RallyRestToolkitForJava/) - -[Web Services API documentation](https://rally1.rallydev.com/slm/doc/webservice) - -## 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 deleted file mode 100644 index 59304dc..0000000 --- a/RallyRestToolkitForJava.iml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/RallyRestToolkitForJava.ipr b/RallyRestToolkitForJava.ipr deleted file mode 100644 index 60e64fe..0000000 --- a/RallyRestToolkitForJava.ipr +++ /dev/null @@ -1,357 +0,0 @@ - - - - - $PROJECT_DIR$/out/artifacts/rally_rest_api_2_2.1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/src/main/resources/doc/allclasses-frame.html b/allclasses-frame.html similarity index 91% rename from src/main/resources/doc/allclasses-frame.html rename to allclasses-frame.html index 85b129b..1e7a21b 100644 --- a/src/main/resources/doc/allclasses-frame.html +++ b/allclasses-frame.html @@ -2,13 +2,15 @@ - -All Classes (Rally Rest API for Java 2.2) + + +All Classes (Rally Rest Toolkit For Java 2.2.1 API) + -

All Classes

+

All Classes

No usage of com.rallydev.rest.RallyRestApi
-
+
- + +
Skip navigation links
+
@@ -90,10 +100,10 @@

Uses of C
- +

+

Copyright © 2016. All Rights Reserved.

diff --git a/com/rallydev/rest/client/ApiKeyClient.html b/com/rallydev/rest/client/ApiKeyClient.html new file mode 100644 index 0000000..13c73fb --- /dev/null +++ b/com/rallydev/rest/client/ApiKeyClient.html @@ -0,0 +1,399 @@ + + + + + + +ApiKeyClient (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.client
+

Class ApiKeyClient

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Closeable, AutoCloseable, org.apache.http.client.HttpClient
    +
    +
    +
    +
    public class ApiKeyClient
+extends HttpClient
    +
    A HttpClient which authenticates using an API Key.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ApiKeyClient(URI server, + String apiKey) +
      Construct a new client.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected StringdoRequest(org.apache.http.client.methods.HttpRequestBase request) +
      Execute a request against the WSAPI
      +
      + +
        +
      • + + +

        Methods inherited from class org.apache.http.impl.client.DefaultHttpClient

        +createHttpParams, createHttpProcessor, setDefaultHttpParams
        • +
      +
        +
      • + + +

        Methods inherited from class org.apache.http.impl.client.AbstractHttpClient

        +addRequestInterceptor, addRequestInterceptor, addResponseInterceptor, addResponseInterceptor, clearRequestInterceptors, clearResponseInterceptors, createAuthSchemeRegistry, createClientConnectionManager, createClientRequestDirector, createClientRequestDirector, createClientRequestDirector, createConnectionKeepAliveStrategy, createConnectionReuseStrategy, createCookieSpecRegistry, createCookieStore, createCredentialsProvider, createHttpContext, createHttpRequestRetryHandler, createHttpRoutePlanner, createProxyAuthenticationHandler, createProxyAuthenticationStrategy, createRedirectHandler, createRequestExecutor, createTargetAuthenticationHandler, createTargetAuthenticationStrategy, createUserTokenHandler, determineParams, execute, execute, execute, execute, execute, execute, execute, execute, getAuthSchemes, getBackoffManager, getConnectionBackoffStrategy, getConnectionKeepAliveStrategy, getConnectionManager, getConnectionReuseStrategy, getCookieSpecs, getCookieStore, getCredentialsProvider, getHttpProcessor, getHttpRequestRetryHandler, getParams, getProxyAuthenticationHandler, getProxyAuthenticationStrategy, getRedirectHandler, getRedirectStrategy, getRequestExecutor, getRequestInterceptor, getRequestInterceptorCount, getResponseInterceptor, getResponseInterceptorCount, getRoutePlanner, getTargetAuthenticationHandler, getTargetAuthenticationStrategy, getUserTokenHandler, removeRequestInterceptorByClass, removeResponseInterceptorByClass, setAuthSchemes, setBackoffManager, setConnectionBackoffStrategy, setCookieSpecs, setCookieStore, setCredentialsProvider, setHttpRequestRetryHandler, setKeepAliveStrategy, setParams, setProxyAuthenticationHandler, setProxyAuthenticationStrategy, setRedirectHandler, setRedirectStrategy, setReuseStrategy, setRoutePlanner, setTargetAuthenticationHandler, setTargetAuthenticationStrategy, setUserTokenHandler
        • +
      + +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      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
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        doRequest

        +
        protected String doRequest(org.apache.http.client.methods.HttpRequestBase request)
+                    throws IOException
        +
        Execute a request against the WSAPI
        +
        +
        Overrides:
        +
        doRequest in class HttpClient
        +
        Parameters:
        +
        request - the request to be executed
        +
        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
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/client/BasicAuthClient.html b/com/rallydev/rest/client/BasicAuthClient.html new file mode 100644 index 0000000..0418212 --- /dev/null +++ b/com/rallydev/rest/client/BasicAuthClient.html @@ -0,0 +1,478 @@ + + + + + + +BasicAuthClient (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.client
+

Class BasicAuthClient

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

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      BasicAuthClient(URI server, + String userName, + String password) +
      Construct a new client.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected voidattachSecurityInfo(org.apache.http.client.methods.HttpRequestBase request) +
      Attach the security token parameter to the request.
      +
      protected StringdoRequest(org.apache.http.client.methods.HttpRequestBase request) +
      Execute a request against the WSAPI
      +
      + +
        +
      • + + +

        Methods inherited from class org.apache.http.impl.client.DefaultHttpClient

        +createHttpParams, createHttpProcessor, setDefaultHttpParams
        • +
      +
        +
      • + + +

        Methods inherited from class org.apache.http.impl.client.AbstractHttpClient

        +addRequestInterceptor, addRequestInterceptor, addResponseInterceptor, addResponseInterceptor, clearRequestInterceptors, clearResponseInterceptors, createAuthSchemeRegistry, createClientConnectionManager, createClientRequestDirector, createClientRequestDirector, createClientRequestDirector, createConnectionKeepAliveStrategy, createConnectionReuseStrategy, createCookieSpecRegistry, createCookieStore, createCredentialsProvider, createHttpContext, createHttpRequestRetryHandler, createHttpRoutePlanner, createProxyAuthenticationHandler, createProxyAuthenticationStrategy, createRedirectHandler, createRequestExecutor, createTargetAuthenticationHandler, createTargetAuthenticationStrategy, createUserTokenHandler, determineParams, execute, execute, execute, execute, execute, execute, execute, execute, getAuthSchemes, getBackoffManager, getConnectionBackoffStrategy, getConnectionKeepAliveStrategy, getConnectionManager, getConnectionReuseStrategy, getCookieSpecs, getCookieStore, getCredentialsProvider, getHttpProcessor, getHttpRequestRetryHandler, getParams, getProxyAuthenticationHandler, getProxyAuthenticationStrategy, getRedirectHandler, getRedirectStrategy, getRequestExecutor, getRequestInterceptor, getRequestInterceptorCount, getResponseInterceptor, getResponseInterceptorCount, getRoutePlanner, getTargetAuthenticationHandler, getTargetAuthenticationStrategy, getUserTokenHandler, removeRequestInterceptorByClass, removeResponseInterceptorByClass, setAuthSchemes, setBackoffManager, setConnectionBackoffStrategy, setCookieSpecs, setCookieStore, setCredentialsProvider, setHttpRequestRetryHandler, setKeepAliveStrategy, setParams, setProxyAuthenticationHandler, setProxyAuthenticationStrategy, setRedirectHandler, setRedirectStrategy, setReuseStrategy, setRoutePlanner, setTargetAuthenticationHandler, setTargetAuthenticationStrategy, setUserTokenHandler
        • +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        SECURITY_ENDPOINT_DOES_NOT_EXIST

        +
        protected static final String SECURITY_ENDPOINT_DOES_NOT_EXIST
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        securityToken

        +
        protected String securityToken
        +
        • +
      + + + +
        +
      • +

        credentials

        +
        protected org.apache.http.auth.Credentials credentials
        +
        • +
      +
      • +
    + +
      +
    • + + +

      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
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        doRequest

        +
        protected String doRequest(org.apache.http.client.methods.HttpRequestBase request)
+                    throws IOException
        +
        Execute a request against the WSAPI
        +
        +
        Overrides:
        +
        doRequest in class HttpClient
        +
        Parameters:
        +
        request - the request to be executed
        +
        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
        +
        +
        • +
      + + + +
        +
      • +

        attachSecurityInfo

        +
        protected void attachSecurityInfo(org.apache.http.client.methods.HttpRequestBase request)
+                           throws IOException,
+                                  URISyntaxException
        +
        Attach the security token parameter to the request. + + Response Structure: + {"OperationResult": {"SecurityToken": "UUID"}}
        +
        +
        Parameters:
        +
        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
        +
        URISyntaxException - if there is a problem with the url in the request
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/client/HttpClient.html b/com/rallydev/rest/client/HttpClient.html new file mode 100644 index 0000000..41c5e3e --- /dev/null +++ b/com/rallydev/rest/client/HttpClient.html @@ -0,0 +1,752 @@ + + + + + + +HttpClient (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.client
+

Class HttpClient

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Closeable, AutoCloseable, org.apache.http.client.HttpClient
    +
    +
    +
    Direct Known Subclasses:
    +
    ApiKeyClient, BasicAuthClient
    +
    +
    +
    +
    public class HttpClient
+extends org.apache.http.impl.client.DefaultHttpClient
+implements Closeable
    +
    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.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected org.apache.http.impl.client.DecompressingHttpClientclient 
      protected URIserver 
      protected StringwsapiVersion 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected HttpClient(URI server) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Release all resources associated with this instance.
      +
      StringdoDelete(String url) +
      Perform a delete against the WSAPI
      +
      StringdoGet(String url) +
      Perform a get against the WSAPI
      +
      StringdoPost(String url, + String body) +
      Perform a post against the WSAPI
      +
      StringdoPut(String url, + String body) +
      Perform a put against the WSAPI
      +
      protected StringdoRequest(org.apache.http.client.methods.HttpRequestBase request) +
      Execute a request against the WSAPI
      +
      protected StringexecuteRequest(org.apache.http.client.methods.HttpRequestBase request) +
      Execute a request against the WSAPI
      +
      StringgetServer() +
      Get the current server being targeted.
      +
      StringgetWsapiUrl() +
      Get the WSAPI base url based on the current server and WSAPI version
      +
      StringgetWsapiVersion() +
      Get the current version of the WSAPI being targeted.
      +
      voidsetApplicationName(String value) +
      Set the value of the X-RallyIntegrationName header included on all requests.
      +
      voidsetApplicationVendor(String value) +
      Set the value of the X-RallyIntegrationVendor header included on all requests.
      +
      voidsetApplicationVersion(String value) +
      Set the value of the X-RallyIntegrationVersion header included on all requests.
      +
      protected org.apache.http.auth.CredentialssetClientCredentials(URI server, + String userName, + String password) 
      voidsetProxy(URI proxy) +
      Set the unauthenticated proxy server to use.
      +
      voidsetProxy(URI proxy, + String userName, + String password) +
      Set the authenticated proxy server to use.
      +
      voidsetWsapiVersion(String wsapiVersion) +
      Set the current version of the WSAPI being targeted.
      +
      +
        +
      • + + +

        Methods inherited from class org.apache.http.impl.client.DefaultHttpClient

        +createHttpParams, createHttpProcessor, setDefaultHttpParams
        • +
      +
        +
      • + + +

        Methods inherited from class org.apache.http.impl.client.AbstractHttpClient

        +addRequestInterceptor, addRequestInterceptor, addResponseInterceptor, addResponseInterceptor, clearRequestInterceptors, clearResponseInterceptors, createAuthSchemeRegistry, createClientConnectionManager, createClientRequestDirector, createClientRequestDirector, createClientRequestDirector, createConnectionKeepAliveStrategy, createConnectionReuseStrategy, createCookieSpecRegistry, createCookieStore, createCredentialsProvider, createHttpContext, createHttpRequestRetryHandler, createHttpRoutePlanner, createProxyAuthenticationHandler, createProxyAuthenticationStrategy, createRedirectHandler, createRequestExecutor, createTargetAuthenticationHandler, createTargetAuthenticationStrategy, createUserTokenHandler, determineParams, execute, execute, execute, execute, execute, execute, execute, execute, getAuthSchemes, getBackoffManager, getConnectionBackoffStrategy, getConnectionKeepAliveStrategy, getConnectionManager, getConnectionReuseStrategy, getCookieSpecs, getCookieStore, getCredentialsProvider, getHttpProcessor, getHttpRequestRetryHandler, getParams, getProxyAuthenticationHandler, getProxyAuthenticationStrategy, getRedirectHandler, getRedirectStrategy, getRequestExecutor, getRequestInterceptor, getRequestInterceptorCount, getResponseInterceptor, getResponseInterceptorCount, getRoutePlanner, getTargetAuthenticationHandler, getTargetAuthenticationStrategy, getUserTokenHandler, removeRequestInterceptorByClass, removeResponseInterceptorByClass, setAuthSchemes, setBackoffManager, setConnectionBackoffStrategy, setCookieSpecs, setCookieStore, setCredentialsProvider, setHttpRequestRetryHandler, setKeepAliveStrategy, setParams, setProxyAuthenticationHandler, setProxyAuthenticationStrategy, setRedirectHandler, setRedirectStrategy, setReuseStrategy, setRoutePlanner, setTargetAuthenticationHandler, setTargetAuthenticationStrategy, setUserTokenHandler
        • +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        server

        +
        protected URI server
        +
        • +
      + + + +
        +
      • +

        wsapiVersion

        +
        protected String wsapiVersion
        +
        • +
      + + + +
        +
      • +

        client

        +
        protected org.apache.http.impl.client.DecompressingHttpClient client
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HttpClient

        +
        protected HttpClient(URI server)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      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"
        +
        +
        • +
      + + + +
        +
      • +

        doRequest

        +
        protected String doRequest(org.apache.http.client.methods.HttpRequestBase request)
+                    throws IOException
        +
        Execute a request against the WSAPI
        +
        +
        Parameters:
        +
        request - the request to be executed
        +
        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
        +
        +
        • +
      + + + +
        +
      • +

        executeRequest

        +
        protected String executeRequest(org.apache.http.client.methods.HttpRequestBase request)
+                         throws IOException
        +
        Execute a request against the WSAPI
        +
        +
        Parameters:
        +
        request - the request to be executed
        +
        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
        +
        +
        • +
      + + + +
        +
      • +

        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
        +
        +
        • +
      + + + +
        +
      • +

        setClientCredentials

        +
        protected org.apache.http.auth.Credentials setClientCredentials(URI server,
+                                                                String userName,
+                                                                String password)
        +
        • +
      + + + +
        +
      • +

        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
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/src/main/resources/doc/com/rallydev/rest/client/class-use/ApiKeyClient.html b/com/rallydev/rest/client/class-use/ApiKeyClient.html similarity index 66% rename from src/main/resources/doc/com/rallydev/rest/client/class-use/ApiKeyClient.html rename to com/rallydev/rest/client/class-use/ApiKeyClient.html index 0192075..cbf7e4e 100644 --- a/src/main/resources/doc/com/rallydev/rest/client/class-use/ApiKeyClient.html +++ b/com/rallydev/rest/client/class-use/ApiKeyClient.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.client.ApiKeyClient (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.client.ApiKeyClient (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +
@@ -67,9 +75,11 @@

Us
No usage of com.rallydev.rest.client.ApiKeyClient
-
+
- + +
Skip navigation links
+
@@ -90,10 +100,10 @@

Us
- +

+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/com/rallydev/rest/client/class-use/BasicAuthClient.html b/com/rallydev/rest/client/class-use/BasicAuthClient.html similarity index 66% rename from src/main/resources/doc/com/rallydev/rest/client/class-use/BasicAuthClient.html rename to com/rallydev/rest/client/class-use/BasicAuthClient.html index 02b4cf1..d710827 100644 --- a/src/main/resources/doc/com/rallydev/rest/client/class-use/BasicAuthClient.html +++ b/com/rallydev/rest/client/class-use/BasicAuthClient.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.client.BasicAuthClient (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.client.BasicAuthClient (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +
@@ -67,9 +75,11 @@

No usage of com.rallydev.rest.client.BasicAuthClient
-
+
- + +
Skip navigation links
+
@@ -90,10 +100,10 @@

- +

+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/com/rallydev/rest/client/class-use/HttpClient.html b/com/rallydev/rest/client/class-use/HttpClient.html similarity index 57% rename from src/main/resources/doc/com/rallydev/rest/client/class-use/HttpClient.html rename to com/rallydev/rest/client/class-use/HttpClient.html index 0601e0e..2c71a8d 100644 --- a/src/main/resources/doc/com/rallydev/rest/client/class-use/HttpClient.html +++ b/com/rallydev/rest/client/class-use/HttpClient.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.client.HttpClient (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.client.HttpClient (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +
@@ -68,7 +76,7 @@

Uses
- +

Package com.rallydev.rest.client Description

Provides the underlying http client implementations.
-
+
- + +
Skip navigation links
+
- +
+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/com/rallydev/rest/client/package-tree.html b/com/rallydev/rest/client/package-tree.html similarity index 58% rename from src/main/resources/doc/com/rallydev/rest/client/package-tree.html rename to com/rallydev/rest/client/package-tree.html index 79b7cb7..f155911 100644 --- a/src/main/resources/doc/com/rallydev/rest/client/package-tree.html +++ b/com/rallydev/rest/client/package-tree.html @@ -2,15 +2,21 @@ - -com.rallydev.rest.client Class Hierarchy (Rally Rest API for Java 2.2) + + +com.rallydev.rest.client Class Hierarchy (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +

Hierarchy For Package com.rallydev.rest.client

-Package Hierarchies: +Package Hierarchies: @@ -72,16 +80,16 @@

Hierarchy For Package com.rallydev.rest.client

Class Hierarchy

-
+
- + +
Skip navigation links
+
@@ -116,10 +126,10 @@

Class Hierarchy

- +
+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/com/rallydev/rest/client/package-use.html b/com/rallydev/rest/client/package-use.html similarity index 72% rename from src/main/resources/doc/com/rallydev/rest/client/package-use.html rename to com/rallydev/rest/client/package-use.html index a7acda1..cd50b05 100644 --- a/src/main/resources/doc/com/rallydev/rest/client/package-use.html +++ b/com/rallydev/rest/client/package-use.html @@ -2,15 +2,21 @@ - -Uses of Package com.rallydev.rest.client (Rally Rest API for Java 2.2) + + +Uses of Package com.rallydev.rest.client (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +
@@ -68,7 +76,7 @@

Uses of Packa
  • - +
    @@ -93,7 +101,7 @@

    Uses of Packa
  • -

    • Packages that use com.rallydev.rest.client 
    Package
    +
    @@ -110,7 +118,7 @@

    Uses of Packa
  • -

    • Classes in com.rallydev.rest.client used by com.rallydev.rest 
    Class and Description
    +
    @@ -127,9 +135,11 @@

    Uses of Packa -
    +
    - + +
    Skip navigation links
    +
    @@ -150,10 +160,10 @@

    Uses of Packa
    - +

    +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/package-frame.html b/com/rallydev/rest/package-frame.html similarity index 69% rename from src/main/resources/doc/com/rallydev/rest/package-frame.html rename to com/rallydev/rest/package-frame.html index f5d6a58..7f7e177 100644 --- a/src/main/resources/doc/com/rallydev/rest/package-frame.html +++ b/com/rallydev/rest/package-frame.html @@ -2,10 +2,12 @@ - -com.rallydev.rest (Rally Rest API for Java 2.2) + + +com.rallydev.rest (Rally Rest Toolkit For Java 2.2.1 API) +

    com.rallydev.rest

    diff --git a/src/main/resources/doc/com/rallydev/rest/package-summary.html b/com/rallydev/rest/package-summary.html similarity index 66% rename from src/main/resources/doc/com/rallydev/rest/package-summary.html rename to com/rallydev/rest/package-summary.html index 541afa1..5d53ec4 100644 --- a/src/main/resources/doc/com/rallydev/rest/package-summary.html +++ b/com/rallydev/rest/package-summary.html @@ -2,15 +2,21 @@ - -com.rallydev.rest (Rally Rest API for Java 2.2) + + +com.rallydev.rest (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    - +
    @@ -67,12 +75,12 @@

    Package com.rallydev.rest

    Provides the main interface to the Rest API.
    -

    See: Description

    +

    See: Description

    • -
    Classes in com.rallydev.rest.client used by com.rallydev.rest.client 
    Class and Description
    +
    @@ -89,16 +97,18 @@

    Package com.rallydev.rest

    Class Summary 
    Class
- +

Package com.rallydev.rest Description

Provides the main interface to the Rest API.
-
+
- + +
Skip navigation links
+
- +
+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/com/rallydev/rest/package-tree.html b/com/rallydev/rest/package-tree.html similarity index 61% rename from src/main/resources/doc/com/rallydev/rest/package-tree.html rename to com/rallydev/rest/package-tree.html index e76a490..91bbc42 100644 --- a/src/main/resources/doc/com/rallydev/rest/package-tree.html +++ b/com/rallydev/rest/package-tree.html @@ -2,15 +2,21 @@ - -com.rallydev.rest Class Hierarchy (Rally Rest API for Java 2.2) + + +com.rallydev.rest Class Hierarchy (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +

Hierarchy For Package com.rallydev.rest

-Package Hierarchies: +Package Hierarchies: @@ -72,17 +80,19 @@

Hierarchy For Package com.rallydev.rest

Class Hierarchy

-
+
- + +
Skip navigation links
+
@@ -103,10 +113,10 @@

Class Hierarchy

- +
+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/com/rallydev/rest/package-use.html b/com/rallydev/rest/package-use.html similarity index 65% rename from src/main/resources/doc/com/rallydev/rest/package-use.html rename to com/rallydev/rest/package-use.html index c65165a..bdf162d 100644 --- a/src/main/resources/doc/com/rallydev/rest/package-use.html +++ b/com/rallydev/rest/package-use.html @@ -2,15 +2,21 @@ - -Uses of Package com.rallydev.rest (Rally Rest API for Java 2.2) + + +Uses of Package com.rallydev.rest (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +
@@ -67,9 +75,11 @@

Uses of Package
c

No usage of com.rallydev.rest
-
+
- + +
Skip navigation links
+
@@ -90,10 +100,10 @@

Uses of Package
c
- +

+

Copyright © 2016. All Rights Reserved.

diff --git a/com/rallydev/rest/request/CollectionUpdateRequest.html b/com/rallydev/rest/request/CollectionUpdateRequest.html new file mode 100644 index 0000000..265a0bb --- /dev/null +++ b/com/rallydev/rest/request/CollectionUpdateRequest.html @@ -0,0 +1,411 @@ + + + + + + +CollectionUpdateRequest (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.request
+

Class CollectionUpdateRequest

+
+
+ +
+
    +
  • +
    +
    +
    public class CollectionUpdateRequest
+extends Request
    +
    Represents a WSAPI request to update a collection.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CollectionUpdateRequest

        +
        public CollectionUpdateRequest(com.google.gson.JsonObject collection,
+                               com.google.gson.JsonArray items,
+                               boolean add)
        +
        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.
        +
        +
        Parameters:
        +
        collection - the collection to be updated
        +
        items - the items to be added or removed
        +
        add - true if adding, false if removing
        +
        +
        • +
      + + + +
        +
      • +

        CollectionUpdateRequest

        +
        public CollectionUpdateRequest(String collectionRef,
+                               com.google.gson.JsonArray items,
+                               boolean adding)
        +
        Create a new update request for the specified collection and values.
        +
        +
        Parameters:
        +
        collectionRef - the ref of the collection to be updated. May be absolute or relative, e.g. "/defect/12345/tags"
        +
        items - the items to be added or removed
        +
        adding - true if adding, false if removing
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBody

        +
        public String getBody()
        +
        Get the JSON encoded string representation of the object to be updated.
        +
        +
        Returns:
        +
        the JSON encoded object
        +
        +
        • +
      + + + +
        +
      • +

        getFetch

        +
        public Fetch getFetch()
        +

        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).
        +
        +
        Returns:
        +
        the current list of fields.
        +
        +
        • +
      + + + +
        +
      • +

        setFetch

        +
        public void setFetch(Fetch fetch)
        +
        Set the current list of fields to be returned on the updated object.
        +
        +
        Parameters:
        +
        fetch - the list of fields to be returned.
        +
        +
        • +
      + + + +
        +
      • +

        toUrl

        +
        public String toUrl()
        +

        Convert this request into a url compatible with the WSAPI.

        + The current fetch and any other parameters will be included.
        +
        +
        Specified by:
        +
        toUrl in class Request
        +
        Returns:
        +
        the url representing this request.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/request/CreateRequest.html b/com/rallydev/rest/request/CreateRequest.html new file mode 100644 index 0000000..710ca55 --- /dev/null +++ b/com/rallydev/rest/request/CreateRequest.html @@ -0,0 +1,382 @@ + + + + + + +CreateRequest (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.request
+

Class CreateRequest

+
+
+ +
+
    +
  • +
    +
    +
    public class CreateRequest
+extends Request
    +
    Represents a WSAPI request to create an object.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CreateRequest

        +
        public CreateRequest(String type,
+                     com.google.gson.JsonObject obj)
        +
        Create a new create request with the specified type and values.
        +
        +
        Parameters:
        +
        type - the WSAPI object type to be created, e.g. Defect
        +
        obj - the JSON representation of the values of the object
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBody

        +
        public String getBody()
        +
        Get the JSON encoded string representation of the object to be created.
        +
        +
        Returns:
        +
        the JSON encoded object
        +
        +
        • +
      + + + +
        +
      • +

        getFetch

        +
        public Fetch getFetch()
        +

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

        + By default only the underscore fields such as _ref will be returned in the response.
        +
        +
        Returns:
        +
        the current list of fields.
        +
        +
        • +
      + + + +
        +
      • +

        setFetch

        +
        public void setFetch(Fetch fetch)
        +
        Set the current list of fields to be returned on the created object.
        +
        +
        Parameters:
        +
        fetch - the list of fields to be returned.
        +
        +
        • +
      + + + +
        +
      • +

        toUrl

        +
        public String toUrl()
        +

        Convert this request into a url compatible with the WSAPI.

        + The current fetch and any other parameters will be included.
        +
        +
        Specified by:
        +
        toUrl in class Request
        +
        Returns:
        +
        the url representing this request.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/request/DeleteRequest.html b/com/rallydev/rest/request/DeleteRequest.html new file mode 100644 index 0000000..3f65f61 --- /dev/null +++ b/com/rallydev/rest/request/DeleteRequest.html @@ -0,0 +1,318 @@ + + + + + + +DeleteRequest (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.request
+

Class DeleteRequest

+
+
+ +
+
    +
  • +
    +
    +
    public class DeleteRequest
+extends Request
    +
    Represents a WSAPI request to delete an object.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DeleteRequest

        +
        public DeleteRequest(String ref)
        +
        Createa new delete request for the specified object.
        +
        +
        Parameters:
        +
        ref - the ref of the WSAPI object to be created. May be absolute or relative, e.g. "/defect/12345"
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toUrl

        +
        public String toUrl()
        +

        Convert this request into a url compatible with the WSAPI.

        + Any parameters set will be included.
        +
        +
        Specified by:
        +
        toUrl in class Request
        +
        Returns:
        +
        the url representing this request.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/request/GetRequest.html b/com/rallydev/rest/request/GetRequest.html new file mode 100644 index 0000000..575b6c1 --- /dev/null +++ b/com/rallydev/rest/request/GetRequest.html @@ -0,0 +1,373 @@ + + + + + + +GetRequest (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.request
+

Class GetRequest

+
+
+ +
+
    +
  • +
    +
    +
    public class GetRequest
+extends Request
    +
    Represents a WSAPI request to retrieve a specific object.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GetRequest

        +
        public GetRequest(String ref)
        +
        Create a new get request for the specified object.
        +
        +
        Parameters:
        +
        ref - the ref of the WSAPI object to be retrieved. May be absolute or relative, e.g. "/defect/12345" + May also be "/user" or "/subscription" to get the current instances
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFetch

        +
        public Fetch getFetch()
        +

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

        + By default all fields will be returned in the response (fetch=true).
        +
        +
        Returns:
        +
        the current list of fields.
        +
        +
        • +
      + + + +
        +
      • +

        setFetch

        +
        public void setFetch(Fetch fetch)
        +
        Set the current list of fields to be returned on the retrieved object.
        +
        +
        Parameters:
        +
        fetch - the list of fields to be returned.
        +
        +
        • +
      + + + +
        +
      • +

        toUrl

        +
        public String toUrl()
        +

        Convert this request into a url compatible with the WSAPI.

        + The current fetch and any other parameters will be included.
        +
        +
        Specified by:
        +
        toUrl in class Request
        +
        Returns:
        +
        the url representing this request.
        +
        +
        • +
      + + + +
        +
      • +

        getEndpoint

        +
        protected String getEndpoint()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/request/QueryRequest.html b/com/rallydev/rest/request/QueryRequest.html new file mode 100644 index 0000000..769a13b --- /dev/null +++ b/com/rallydev/rest/request/QueryRequest.html @@ -0,0 +1,788 @@ + + + + + + +QueryRequest (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.request
+

Class QueryRequest

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cloneable
    +
    +
    +
    +
    public class QueryRequest
+extends Request
+implements Cloneable
    +
    Represents a WSAPI request to retrieve all objects matching specified criteria.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      QueryRequest(com.google.gson.JsonObject collection) +
      Create a new query request for the specified collection.
      +
      QueryRequest(String type) +
      Create a new query request for the specified type.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      QueryRequestclone() +
      Clone this request.
      +
      FetchgetFetch() +
      Get the current list of fields to be returned on the matching objects.
      +
      intgetLimit() +
      Get the maximum number of records to be returned from the query.
      +
      StringgetOrder() +
      Set the order by which the result set will be sorted.
      +
      intgetPageSize() +
      Get the page size of the result set.
      +
      StringgetProject() +
      Get the project which the result set should be scoped to.
      +
      QueryFiltergetQueryFilter() +
      Get the filter by which the result set will be narrowed down.
      +
      intgetStart() +
      Get the start index of the result set.
      +
      protected StringgetTypeEndpoint() 
      StringgetWorkspace() +
      Get the workspace which the result set should be scoped to.
      +
      booleanisScopedDown() +
      If a project has been specified, get whether to include matching objects in child projects in the result set.
      +
      booleanisScopedUp() +
      If a project has been specified, get whether to include matching objects in parent projects in the result set.
      +
      voidsetFetch(Fetch fetch) +
      Set the current list of fields to be returned on the matching objects.
      +
      voidsetLimit(int limit) +
      Set the maximum number of records to be returned from the query.
      +
      voidsetOrder(String order) +
      Get the order by which the result set will be sorted.
      +
      voidsetPageSize(int pageSize) +
      Set the page size of the result set.
      +
      voidsetProject(String projectRef) +
      Specify the project which the result set should be scoped to.
      +
      voidsetQueryFilter(QueryFilter queryFilter) +
      Set a filter by which the result set will be narrowed down.
      +
      voidsetScopedDown(boolean scopeDown) +
      If a project has been specified, set whether to include matching objects in child projects in the result set.
      +
      voidsetScopedUp(boolean scopeUp) +
      If a project has been specified, set whether to include matching objects in parent projects in the result set.
      +
      voidsetStart(int start) +
      Set the 1-based start index of the result set.
      +
      voidsetWorkspace(String workspaceRef) +
      Specify the workspace which the result set should be scoped to.
      +
      StringtoUrl() +
      Convert this request into a url compatible with the WSAPI.
      +
      + + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        QueryRequest

        +
        public QueryRequest(String type)
        +
        Create a new query request for the specified type.
        +
        +
        Parameters:
        +
        type - The WSAPI type to be queried, e.g. Defect
        +
        +
        • +
      + + + +
        +
      • +

        QueryRequest

        +
        public QueryRequest(com.google.gson.JsonObject collection)
        +
        Create a new query request for the specified collection. + Only supported in WSAPI v2.0 and above.
        +
        +
        Parameters:
        +
        collection - The collection to query. Should have a _ref property.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getQueryFilter

        +
        public QueryFilter getQueryFilter()
        +
        Get the filter by which the result set will be narrowed down.
        +
        +
        Returns:
        +
        the filter
        +
        +
        • +
      + + + +
        +
      • +

        setQueryFilter

        +
        public void setQueryFilter(QueryFilter queryFilter)
        +
        Set a filter by which the result set will be narrowed down.
        +
        +
        Parameters:
        +
        queryFilter - the filter
        +
        +
        • +
      + + + +
        +
      • +

        getOrder

        +
        public String getOrder()
        +
        Set the order by which the result set will be sorted. +

        The default is ObjectID ASC.

        +
        +
        Returns:
        +
        the order
        +
        +
        • +
      + + + +
        +
      • +

        setOrder

        +
        public void setOrder(String order)
        +
        Get the order by which the result set will be sorted.
        +
        +
        Parameters:
        +
        order - the order
        +
        +
        • +
      + + + +
        +
      • +

        getWorkspace

        +
        public String getWorkspace()
        +
        Get the workspace which the result set should be scoped to.
        +
        +
        Returns:
        +
        the project
        +
        +
        • +
      + + + +
        +
      • +

        setWorkspace

        +
        public void setWorkspace(String workspaceRef)
        +

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

        + The default is the user's default workspace.
        +
        +
        Parameters:
        +
        workspaceRef - the ref of the workspace to scope to. May be an absolute or relative ref, e.g. /workspace/1234
        +
        +
        • +
      + + + +
        +
      • +

        getProject

        +
        public String getProject()
        +
        Get the project which the result set should be scoped to.
        +
        +
        Returns:
        +
        the project
        +
        +
        • +
      + + + +
        +
      • +

        setProject

        +
        public void setProject(String projectRef)
        +

        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.
        +
        +
        Parameters:
        +
        projectRef - the ref of the project to scope to. May be null or an absolute or relative ref, e.g. /project/1234
        +
        +
        • +
      + + + +
        +
      • +

        isScopedUp

        +
        public boolean isScopedUp()
        +
        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.
        +
        +
        • +
      + + + +
        +
      • +

        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.
        +
        +
        Parameters:
        +
        scopeUp - whether to include matching objects in parent projects
        +
        +
        • +
      + + + +
        +
      • +

        isScopedDown

        +
        public boolean isScopedDown()
        +
        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.
        +
        +
        • +
      + + + +
        +
      • +

        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.
        +
        +
        Parameters:
        +
        scopeDown - whether to include matching objects in child projects
        +
        +
        • +
      + + + +
        +
      • +

        getStart

        +
        public int getStart()
        +
        Get the start index of the result set.
        +
        +
        Returns:
        +
        the start index
        +
        +
        • +
      + + + +
        +
      • +

        setStart

        +
        public void setStart(int start)
        +
        Set the 1-based start index of the result set. + The default is 1.
        +
        +
        Parameters:
        +
        start - the start index
        +
        +
        • +
      + + + +
        +
      • +

        getFetch

        +
        public Fetch getFetch()
        +

        Get the current list of fields to be returned on the matching objects.

        + By default all fields will be returned in the response (fetch=true).
        +
        +
        Returns:
        +
        the current list of fields.
        +
        +
        • +
      + + + +
        +
      • +

        setFetch

        +
        public void setFetch(Fetch fetch)
        +
        Set the current list of fields to be returned on the matching objects.
        +
        +
        Parameters:
        +
        fetch - the list of fields to be returned.
        +
        +
        • +
      + + + +
        +
      • +

        getPageSize

        +
        public int getPageSize()
        +
        Get the page size of the result set.
        +
        +
        Returns:
        +
        the page size
        +
        +
        • +
      + + + +
        +
      • +

        setPageSize

        +
        public void setPageSize(int pageSize)
        +

        Set the page size of the result set.

        + The default is 200.
        +
        +
        Parameters:
        +
        pageSize - the new page size. Must be between 1 and 200 inclusive.
        +
        +
        • +
      + + + +
        +
      • +

        getLimit

        +
        public int getLimit()
        +
        Get the maximum number of records to be returned from the query.
        +
        +
        Returns:
        +
        the maximum number of records
        +
        +
        • +
      + + + +
        +
      • +

        setLimit

        +
        public void setLimit(int limit)
        +

        Set the maximum number of records to be returned from the query.

        + If not set only one page of data will be returned by RallyRestApi.query(com.rallydev.rest.request.QueryRequest)
        +
        +
        Parameters:
        +
        limit - the maximum number of records to be returned
        +
        +
        • +
      + + + +
        +
      • +

        clone

        +
        public QueryRequest clone()
        +
        Clone this request.
        +
        +
        Overrides:
        +
        clone in class Object
        +
        Returns:
        +
        the cloned instance of this request.
        +
        +
        • +
      + + + +
        +
      • +

        toUrl

        +
        public String toUrl()
        +

        Convert this request into a url compatible with the WSAPI.

        + The current criteria set on this request and any other parameters will be included.
        +
        +
        Specified by:
        +
        toUrl in class Request
        +
        Returns:
        +
        the url representing this request.
        +
        +
        • +
      + + + +
        +
      • +

        getTypeEndpoint

        +
        protected String getTypeEndpoint()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/request/Request.html b/com/rallydev/rest/request/Request.html new file mode 100644 index 0000000..c91e5d4 --- /dev/null +++ b/com/rallydev/rest/request/Request.html @@ -0,0 +1,432 @@ + + + + + + +Request (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.request
+

Class Request

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

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected com.google.gson.GsonBuildergsonBuilder +
      Gson Builder used for JSON serialization in this request.
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Request() +
      Create a new request.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        gsonBuilder

        +
        protected com.google.gson.GsonBuilder gsonBuilder
        +
        Gson Builder used for JSON serialization in this request.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Request

        +
        public Request()
        +
        Create a new request.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getParams

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

        setParams

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

        addParam

        +
        public void addParam(String name,
+                     String value)
        +
        Add the specified parameter to this request.
        +
        +
        Parameters:
        +
        name - the parameter name
        +
        value - the parameter value
        +
        +
        • +
      + + + +
        +
      • +

        getGsonBuilder

        +
        public com.google.gson.GsonBuilder getGsonBuilder()
        +
        Get the Gson Builder used for JSON serialization in this request.
        +
        +
        Returns:
        +
        The Gson Builder used for JSON serialization
        +
        +
        • +
      + + + +
        +
      • +

        setGsonBuilder

        +
        public void setGsonBuilder(com.google.gson.GsonBuilder gsonBuilder)
        +
        Set the Gson Builder used for JSON serialization in this request.
        +
        +
        Parameters:
        +
        gsonBuilder - The Gson Builder used for JSON serialization
        +
        +
        • +
      + + + +
        +
      • +

        toUrl

        +
        public abstract String toUrl()
        +

        Convert this request into a url compatible with the WSAPI.

        + Must be implemented by subclasses.
        +
        +
        Returns:
        +
        the url representing this request.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/request/UpdateRequest.html b/com/rallydev/rest/request/UpdateRequest.html new file mode 100644 index 0000000..4c46d05 --- /dev/null +++ b/com/rallydev/rest/request/UpdateRequest.html @@ -0,0 +1,382 @@ + + + + + + +UpdateRequest (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.request
+

Class UpdateRequest

+
+
+ +
+
    +
  • +
    +
    +
    public class UpdateRequest
+extends Request
    +
    Represents a WSAPI request to update an object.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UpdateRequest

        +
        public UpdateRequest(String ref,
+                     com.google.gson.JsonObject obj)
        +
        Create a new update request for the specified object and values.
        +
        +
        Parameters:
        +
        ref - the ref of the WSAPI object to be created. May be absolute or relative, e.g. "/defect/12345"
        +
        obj - the JSON representation of the values of the object
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBody

        +
        public String getBody()
        +
        Get the JSON encoded string representation of the object to be updated.
        +
        +
        Returns:
        +
        the JSON encoded object
        +
        +
        • +
      + + + +
        +
      • +

        getFetch

        +
        public Fetch getFetch()
        +

        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).
        +
        +
        Returns:
        +
        the current list of fields.
        +
        +
        • +
      + + + +
        +
      • +

        setFetch

        +
        public void setFetch(Fetch fetch)
        +
        Set the current list of fields to be returned on the updated object.
        +
        +
        Parameters:
        +
        fetch - the list of fields to be returned.
        +
        +
        • +
      + + + +
        +
      • +

        toUrl

        +
        public String toUrl()
        +

        Convert this request into a url compatible with the WSAPI.

        + The current fetch and any other parameters will be included.
        +
        +
        Specified by:
        +
        toUrl in class Request
        +
        Returns:
        +
        the url representing this request.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/CollectionUpdateRequest.html b/com/rallydev/rest/request/class-use/CollectionUpdateRequest.html similarity index 68% rename from src/main/resources/doc/com/rallydev/rest/request/class-use/CollectionUpdateRequest.html rename to com/rallydev/rest/request/class-use/CollectionUpdateRequest.html index 8a83788..4583bdd 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/CollectionUpdateRequest.html +++ b/com/rallydev/rest/request/class-use/CollectionUpdateRequest.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.request.CollectionUpdateRequest (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.request.CollectionUpdateRequest (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +
@@ -68,7 +76,7 @@

  • - +
    @@ -90,7 +98,7 @@

    Uses of CollectionUpdateRequest in com.rallydev.rest

    -
    Packages that use CollectionUpdateRequest 
    Package
    +
    @@ -99,7 +107,7 @@

    Uses of

    - @@ -111,9 +119,11 @@

    Uses of +
    - + +
    Skip navigation links
    +
    @@ -134,10 +144,10 @@

    Uses of
  • Frames
    • -
  • No Frames
    • +
  • No Frames
    • - + +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/CreateRequest.html b/com/rallydev/rest/request/class-use/CreateRequest.html similarity index 68% rename from src/main/resources/doc/com/rallydev/rest/request/class-use/CreateRequest.html rename to com/rallydev/rest/request/class-use/CreateRequest.html index 3344800..3c05299 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/CreateRequest.html +++ b/com/rallydev/rest/request/class-use/CreateRequest.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.request.CreateRequest (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.request.CreateRequest (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    @@ -41,10 +49,10 @@
    - +
    @@ -68,7 +76,7 @@

    • -

    Methods in com.rallydev.rest with parameters of type CollectionUpdateRequest 
    Modifier and TypeCollectionUpdateResponseRallyRestApi.updateCollection(CollectionUpdateRequest request) +RallyRestApi.updateCollection(CollectionUpdateRequest request)
    Update the specified collection.
    +
    @@ -90,7 +98,7 @@

    Uses of CreateRequest in com.rallydev.rest

    -
    Packages that use CreateRequest 
    Package
    +
    @@ -99,7 +107,7 @@

    Uses of

    - @@ -111,9 +119,11 @@

    Uses of +
    - + +
    Skip navigation links
    +
    @@ -134,10 +144,10 @@

    Uses of
  • Frames
    • -
  • No Frames
    • +
  • No Frames
    • - + +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/DeleteRequest.html b/com/rallydev/rest/request/class-use/DeleteRequest.html similarity index 68% rename from src/main/resources/doc/com/rallydev/rest/request/class-use/DeleteRequest.html rename to com/rallydev/rest/request/class-use/DeleteRequest.html index 77bd178..dfd9eb4 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/DeleteRequest.html +++ b/com/rallydev/rest/request/class-use/DeleteRequest.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.request.DeleteRequest (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.request.DeleteRequest (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    @@ -41,10 +49,10 @@
    - +
    @@ -68,7 +76,7 @@

    • -

    Methods in com.rallydev.rest with parameters of type CreateRequest 
    Modifier and TypeCreateResponseRallyRestApi.create(CreateRequest request) +RallyRestApi.create(CreateRequest request)
    Create the specified object.
    +
    @@ -90,7 +98,7 @@

    Uses of DeleteRequest in com.rallydev.rest

    -
    Packages that use DeleteRequest 
    Package
    +
    @@ -99,7 +107,7 @@

    Uses of

    - @@ -111,9 +119,11 @@

    Uses of +
    - + +
    Skip navigation links
    +
    @@ -134,10 +144,10 @@

    Uses of
  • Frames
    • -
  • No Frames
    • +
  • No Frames
    • - + +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/GetRequest.html b/com/rallydev/rest/request/class-use/GetRequest.html similarity index 68% rename from src/main/resources/doc/com/rallydev/rest/request/class-use/GetRequest.html rename to com/rallydev/rest/request/class-use/GetRequest.html index 6995415..ec6b750 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/GetRequest.html +++ b/com/rallydev/rest/request/class-use/GetRequest.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.request.GetRequest (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.request.GetRequest (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    @@ -41,10 +49,10 @@
    - +
    @@ -68,7 +76,7 @@

    Use
    • -

    Methods in com.rallydev.rest with parameters of type DeleteRequest 
    Modifier and TypeDeleteResponseRallyRestApi.delete(DeleteRequest request) +RallyRestApi.delete(DeleteRequest request)
    Delete the specified object.
    +
    @@ -90,7 +98,7 @@

    Use

    Uses of GetRequest in com.rallydev.rest

    -
    Packages that use GetRequest 
    Package
    +
    @@ -99,7 +107,7 @@

    Uses of

    - @@ -111,9 +119,11 @@

    Uses of -
    +
    - + +
    Skip navigation links
    +
    @@ -134,10 +144,10 @@

    Uses of
    - +

    +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/QueryRequest.html b/com/rallydev/rest/request/class-use/QueryRequest.html similarity index 70% rename from src/main/resources/doc/com/rallydev/rest/request/class-use/QueryRequest.html rename to com/rallydev/rest/request/class-use/QueryRequest.html index 0b8b28c..3d3401c 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/QueryRequest.html +++ b/com/rallydev/rest/request/class-use/QueryRequest.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.request.QueryRequest (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.request.QueryRequest (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    @@ -41,10 +49,10 @@
    - +
    @@ -68,7 +76,7 @@

    U
    • -

    Methods in com.rallydev.rest with parameters of type GetRequest 
    Modifier and Type
    GetResponseRallyRestApi.get(GetRequest request) +RallyRestApi.get(GetRequest request)
    Get the specified object.
    +
    @@ -96,7 +104,7 @@

    U

    Uses of QueryRequest in com.rallydev.rest

    -
    Packages that use QueryRequest 
    Package
    +
    @@ -105,7 +113,7 @@

    Uses of

    - @@ -116,7 +124,7 @@

    Uses of

    Uses of QueryRequest in com.rallydev.rest.request

    -
    Methods in com.rallydev.rest with parameters of type QueryRequest 
    Modifier and Type
    QueryResponseRallyRestApi.query(QueryRequest request) +RallyRestApi.query(QueryRequest request)
    Query for objects matching the specified request.
    +
    @@ -125,7 +133,7 @@

    Uses of

    - @@ -137,9 +145,11 @@

    Uses of -
    +
    - + +
    Skip navigation links
    +
    @@ -160,10 +170,10 @@

    Uses of
    - +

    +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/Request.html b/com/rallydev/rest/request/class-use/Request.html similarity index 64% rename from src/main/resources/doc/com/rallydev/rest/request/class-use/Request.html rename to com/rallydev/rest/request/class-use/Request.html index 15da546..a352627 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/Request.html +++ b/com/rallydev/rest/request/class-use/Request.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.request.Request (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.request.Request (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    @@ -41,10 +49,10 @@
    - +
    @@ -68,7 +76,7 @@

    Uses o
    • -

    Methods in com.rallydev.rest.request that return QueryRequest 
    Modifier and Type
    QueryRequestQueryRequest.clone() +QueryRequest.clone()
    Clone this request.
    +
    @@ -90,7 +98,7 @@

    Uses o

    Uses of Request in com.rallydev.rest.request

    -
    Packages that use Request 
    Package
    +
    @@ -99,37 +107,37 @@

    Uses of

    - - - - - - @@ -141,9 +149,11 @@

    Uses of -
    +
    - + +
    Skip navigation links
    +
    @@ -164,10 +174,10 @@

    Uses of
    - +

    +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/request/class-use/UpdateRequest.html b/com/rallydev/rest/request/class-use/UpdateRequest.html similarity index 68% rename from src/main/resources/doc/com/rallydev/rest/request/class-use/UpdateRequest.html rename to com/rallydev/rest/request/class-use/UpdateRequest.html index 34c4fae..bcc2081 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/UpdateRequest.html +++ b/com/rallydev/rest/request/class-use/UpdateRequest.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.request.UpdateRequest (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.request.UpdateRequest (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    @@ -41,10 +49,10 @@
    - +
    @@ -68,7 +76,7 @@

    • -

    Subclasses of Request in com.rallydev.rest.request 
    Modifier and Type
    class CollectionUpdateRequest +CollectionUpdateRequest
    Represents a WSAPI request to update a collection.
    class CreateRequest +CreateRequest
    Represents a WSAPI request to create an object.
    class DeleteRequest +DeleteRequest
    Represents a WSAPI request to delete an object.
    class GetRequest +GetRequest
    Represents a WSAPI request to retrieve a specific object.
    class QueryRequest +QueryRequest
    Represents a WSAPI request to retrieve all objects matching specified criteria.
    class UpdateRequest +UpdateRequest
    Represents a WSAPI request to update an object.
    +
    @@ -90,7 +98,7 @@

    Uses of UpdateRequest in com.rallydev.rest

    -
    Packages that use UpdateRequest 
    Package
    +
    @@ -99,7 +107,7 @@

    Uses of

    - @@ -111,9 +119,11 @@

    Uses of +
    - + +
    Skip navigation links
    +
    @@ -134,10 +144,10 @@

    Uses of
  • Frames
    • -
  • No Frames
    • +
  • No Frames
    • - + +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/request/package-frame.html b/com/rallydev/rest/request/package-frame.html similarity index 82% rename from src/main/resources/doc/com/rallydev/rest/request/package-frame.html rename to com/rallydev/rest/request/package-frame.html index 777b7a3..7245084 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/package-frame.html +++ b/com/rallydev/rest/request/package-frame.html @@ -2,10 +2,12 @@ - -com.rallydev.rest.request (Rally Rest API for Java 2.2) + + +com.rallydev.rest.request (Rally Rest Toolkit For Java 2.2.1 API) +

    com.rallydev.rest.request

    diff --git a/src/main/resources/doc/com/rallydev/rest/request/package-summary.html b/com/rallydev/rest/request/package-summary.html similarity index 75% rename from src/main/resources/doc/com/rallydev/rest/request/package-summary.html rename to com/rallydev/rest/request/package-summary.html index 13d0548..eb2e422 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/package-summary.html +++ b/com/rallydev/rest/request/package-summary.html @@ -2,15 +2,21 @@ - -com.rallydev.rest.request (Rally Rest API for Java 2.2) + + +com.rallydev.rest.request (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    - +
    @@ -67,12 +75,12 @@

    Package com.rallydev.rest.request

    Provides objects for encoding requests to the Rest API.
    -

    See: Description

    +

    See: Description

    • -
    Methods in com.rallydev.rest with parameters of type UpdateRequest 
    Modifier and TypeUpdateResponseRallyRestApi.update(UpdateRequest request) +RallyRestApi.update(UpdateRequest request)
    Update the specified object.
    +
    @@ -125,16 +133,18 @@

    Package com.rallydev.rest.request

    Class Summary 
    Class
- +

Package com.rallydev.rest.request Description

Provides objects for encoding requests to the Rest API.
-
+
- + +
Skip navigation links
+
- +
+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/com/rallydev/rest/request/package-tree.html b/com/rallydev/rest/request/package-tree.html similarity index 62% rename from src/main/resources/doc/com/rallydev/rest/request/package-tree.html rename to com/rallydev/rest/request/package-tree.html index ab9fd00..df8e8d7 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/package-tree.html +++ b/com/rallydev/rest/request/package-tree.html @@ -2,15 +2,21 @@ - -com.rallydev.rest.request Class Hierarchy (Rally Rest API for Java 2.2) + + +com.rallydev.rest.request Class Hierarchy (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +

Hierarchy For Package com.rallydev.rest.request

-Package Hierarchies: +Package Hierarchies: @@ -72,16 +80,16 @@

Hierarchy For Package com.rallydev.rest.request

Class Hierarchy

-
+
- + +
Skip navigation links
+
@@ -112,10 +122,10 @@

Class Hierarchy

- +
+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/com/rallydev/rest/request/package-use.html b/com/rallydev/rest/request/package-use.html similarity index 77% rename from src/main/resources/doc/com/rallydev/rest/request/package-use.html rename to com/rallydev/rest/request/package-use.html index 0c7d0f0..46380bb 100644 --- a/src/main/resources/doc/com/rallydev/rest/request/package-use.html +++ b/com/rallydev/rest/request/package-use.html @@ -2,15 +2,21 @@ - -Uses of Package com.rallydev.rest.request (Rally Rest API for Java 2.2) + + +Uses of Package com.rallydev.rest.request (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +
@@ -68,7 +76,7 @@

Uses of Pack
  • - +
    @@ -93,7 +101,7 @@

    Uses of Pack
  • -

    • Packages that use com.rallydev.rest.request 
    Package
    +
    @@ -135,7 +143,7 @@

    Uses of Pack
  • -

    • Classes in com.rallydev.rest.request used by com.rallydev.rest 
    Class and Description
    +
    @@ -157,9 +165,11 @@

    Uses of Pack -
    +
    - + +
    Skip navigation links
    +
    @@ -180,10 +190,10 @@

    Uses of Pack
    - +

    +

    Copyright © 2016. All Rights Reserved.

    diff --git a/com/rallydev/rest/response/CollectionUpdateResponse.html b/com/rallydev/rest/response/CollectionUpdateResponse.html new file mode 100644 index 0000000..3080825 --- /dev/null +++ b/com/rallydev/rest/response/CollectionUpdateResponse.html @@ -0,0 +1,338 @@ + + + + + + +CollectionUpdateResponse (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.rallydev.rest.response
    +

    Class CollectionUpdateResponse

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

        Constructor Summary

        +

    Classes in com.rallydev.rest.request used by com.rallydev.rest.request 
    Class and Description
    + + + + + + + +
    Constructors 
    Constructor and Description
    CollectionUpdateResponse(String updateResponse) +
    Create a new collection update response from the specified JSON encoded string.
    +
    +
    • +
+ + + + +
+
+
    +
  • + +
      +
    • + + +

      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

      + + + +
        +
      • +

        getRoot

        +
        protected String getRoot()
        +
        Get the name of the root JSON result
        +
        +
        Specified by:
        +
        getRoot in class Response
        +
        Returns:
        +
        the root element name
        +
        +
        • +
      + + + +
        +
      • +

        getResults

        +
        public com.google.gson.JsonArray getResults()
        +
        Get the results of the collection update
        +
        +
        Returns:
        +
        the results
        +
        +
        • +
      +
      • +
    +
    • +
+
+

+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/response/CreateResponse.html b/com/rallydev/rest/response/CreateResponse.html new file mode 100644 index 0000000..a9491d8 --- /dev/null +++ b/com/rallydev/rest/response/CreateResponse.html @@ -0,0 +1,338 @@ + + + + + + +CreateResponse (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.response
+

Class CreateResponse

+
+
+ +
+
    +
  • +
    +
    +
    public class CreateResponse
+extends Response
    +
    Represents a WSAPI response from creating an object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CreateResponse

        +
        public CreateResponse(String createResponse)
        +
        Create a new create response from the specified JSON encoded string.
        +
        +
        Parameters:
        +
        createResponse - the JSON encoded string
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRoot

        +
        protected String getRoot()
        +
        Get the name of the root JSON result
        +
        +
        Specified by:
        +
        getRoot in class Response
        +
        Returns:
        +
        the root element name
        +
        +
        • +
      + + + +
        +
      • +

        getObject

        +
        public com.google.gson.JsonObject getObject()
        +
        Get the created object. +

        Returns null if the operation was not successful

        +
        +
        Returns:
        +
        the created object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/response/DeleteResponse.html b/com/rallydev/rest/response/DeleteResponse.html new file mode 100644 index 0000000..d92b2d6 --- /dev/null +++ b/com/rallydev/rest/response/DeleteResponse.html @@ -0,0 +1,317 @@ + + + + + + +DeleteResponse (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.response
+

Class DeleteResponse

+
+
+ +
+
    +
  • +
    +
    +
    public class DeleteResponse
+extends Response
    +
    Represents a WSAPI response from deleting an object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DeleteResponse

        +
        public DeleteResponse(String deleteResponse)
        +
        Create a new delete response from the specified JSON encoded string.
        +
        +
        Parameters:
        +
        deleteResponse - the JSON encoded string
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRoot

        +
        protected String getRoot()
        +
        Get the name of the root JSON result
        +
        +
        Specified by:
        +
        getRoot in class Response
        +
        Returns:
        +
        the root element name
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/response/GetResponse.html b/com/rallydev/rest/response/GetResponse.html new file mode 100644 index 0000000..4487352 --- /dev/null +++ b/com/rallydev/rest/response/GetResponse.html @@ -0,0 +1,338 @@ + + + + + + +GetResponse (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.response
+

Class GetResponse

+
+
+ +
+
    +
  • +
    +
    +
    public class GetResponse
+extends Response
    +
    Represents a WSAPI response from retrieving a single object.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GetResponse

        +
        public GetResponse(String getResponse)
        +
        Create a new get response from the specified JSON encoded string.
        +
        +
        Parameters:
        +
        getResponse - the JSON encoded string
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRoot

        +
        protected String getRoot()
        +
        Get the name of the root JSON result
        +
        +
        Specified by:
        +
        getRoot in class Response
        +
        Returns:
        +
        the root element name
        +
        +
        • +
      + + + +
        +
      • +

        getObject

        +
        public com.google.gson.JsonObject getObject()
        +
        Get the retrieved object. +

        Returns null if the operation was not successful

        +
        +
        Returns:
        +
        the retrieved object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/response/QueryResponse.html b/com/rallydev/rest/response/QueryResponse.html new file mode 100644 index 0000000..d06d589 --- /dev/null +++ b/com/rallydev/rest/response/QueryResponse.html @@ -0,0 +1,398 @@ + + + + + + +QueryResponse (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.response
+

Class QueryResponse

+
+
+ +
+
    +
  • +
    +
    +
    public class QueryResponse
+extends Response
    +
    Represents a WSAPI response from querying for objects.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        QueryResponse

        +
        public QueryResponse(String queryResponse)
        +
        Create a new query response from the specified JSON encoded string.
        +
        +
        Parameters:
        +
        queryResponse - the JSON encoded string
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRoot

        +
        protected String getRoot()
        +
        Get the name of the root JSON result
        +
        +
        Specified by:
        +
        getRoot in class Response
        +
        Returns:
        +
        the root element name
        +
        +
        • +
      + + + +
        +
      • +

        getTotalResultCount

        +
        public int getTotalResultCount()
        +
        Get the total number of objects that matched the query
        +
        +
        Returns:
        +
        the total number of objects
        +
        +
        • +
      + + + +
        +
      • +

        getResults

        +
        public com.google.gson.JsonArray getResults()
        +
        Get the results of the query +

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

        +
        +
        Returns:
        +
        the results
        +
        +
        • +
      + + + +
        +
      • +

        getPageSize

        +
        public int getPageSize()
        +
        Get the page size of the results
        +
        +
        Returns:
        +
        the page size
        +
        +
        • +
      + + + +
        +
      • +

        getStart

        +
        public int getStart()
        +
        Get the start index of the results
        +
        +
        Returns:
        +
        the start index
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/response/Response.html b/com/rallydev/rest/response/Response.html new file mode 100644 index 0000000..d916a6e --- /dev/null +++ b/com/rallydev/rest/response/Response.html @@ -0,0 +1,401 @@ + + + + + + +Response (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.response
+

Class Response

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

      Field Detail

      + + + +
        +
      • +

        result

        +
        protected com.google.gson.JsonObject result
        +
        • +
      + + + +
        +
      • +

        raw

        +
        protected String raw
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Response

        +
        public Response(String response)
        +
        Create a new response from the specified JSON encoded string.
        +
        +
        Parameters:
        +
        response - the JSON encoded string
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        wasSuccessful

        +
        public boolean wasSuccessful()
        +
        Returns whether the response was successful (no errors)
        +
        +
        Returns:
        +
        whether the response was successful
        +
        +
        • +
      + + + +
        +
      • +

        getErrors

        +
        public String[] getErrors()
        +
        Get any errors returned in the response.
        +
        +
        Returns:
        +
        the response errors
        +
        +
        • +
      + + + +
        +
      • +

        getWarnings

        +
        public String[] getWarnings()
        +
        Get any warnings returned in the response.
        +
        +
        Returns:
        +
        the response warnings
        +
        +
        • +
      + + + +
        +
      • +

        getRoot

        +
        protected abstract String getRoot()
        +
        Get the name of the root JSON result
        +
        +
        Returns:
        +
        the root element name
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/response/UpdateResponse.html b/com/rallydev/rest/response/UpdateResponse.html new file mode 100644 index 0000000..6099ce1 --- /dev/null +++ b/com/rallydev/rest/response/UpdateResponse.html @@ -0,0 +1,338 @@ + + + + + + +UpdateResponse (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.rallydev.rest.response
+

Class UpdateResponse

+
+
+ +
+
    +
  • +
    +
    +
    public class UpdateResponse
+extends Response
    +
    Represents a WSAPI response from updating an object.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UpdateResponse

        +
        public UpdateResponse(String updateResponse)
        +
        Create a new update response from the specified JSON encoded string.
        +
        +
        Parameters:
        +
        updateResponse - the JSON encoded string
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRoot

        +
        protected String getRoot()
        +
        Get the name of the root JSON result
        +
        +
        Specified by:
        +
        getRoot in class Response
        +
        Returns:
        +
        the root element name
        +
        +
        • +
      + + + +
        +
      • +

        getObject

        +
        public com.google.gson.JsonObject getObject()
        +
        Get the updated object. +

        Returns null if the operation was not successful

        +
        +
        Returns:
        +
        the updated object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/CollectionUpdateResponse.html b/com/rallydev/rest/response/class-use/CollectionUpdateResponse.html similarity index 68% rename from src/main/resources/doc/com/rallydev/rest/response/class-use/CollectionUpdateResponse.html rename to com/rallydev/rest/response/class-use/CollectionUpdateResponse.html index 197da83..590636a 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/CollectionUpdateResponse.html +++ b/com/rallydev/rest/response/class-use/CollectionUpdateResponse.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.response.CollectionUpdateResponse (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.response.CollectionUpdateResponse (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +
@@ -68,7 +76,7 @@

  • - +
    @@ -90,7 +98,7 @@

    Uses of CollectionUpdateResponse in com.rallydev.rest

    -
    Packages that use CollectionUpdateResponse 
    Package
    +
    @@ -99,7 +107,7 @@

    Uses of

    - @@ -111,9 +119,11 @@

    Uses of +
    - + +
    Skip navigation links
    +
    @@ -134,10 +144,10 @@

    Uses of
  • Frames
    • -
  • No Frames
    • +
  • No Frames
    • - + +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/CreateResponse.html b/com/rallydev/rest/response/class-use/CreateResponse.html similarity index 68% rename from src/main/resources/doc/com/rallydev/rest/response/class-use/CreateResponse.html rename to com/rallydev/rest/response/class-use/CreateResponse.html index 0d21e67..cde532b 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/CreateResponse.html +++ b/com/rallydev/rest/response/class-use/CreateResponse.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.response.CreateResponse (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.response.CreateResponse (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    @@ -41,10 +49,10 @@
    - +
    @@ -68,7 +76,7 @@

    • -

    Methods in com.rallydev.rest that return CollectionUpdateResponse 
    Modifier and TypeCollectionUpdateResponseRallyRestApi.updateCollection(CollectionUpdateRequest request) +RallyRestApi.updateCollection(CollectionUpdateRequest request)
    Update the specified collection.
    +
    @@ -90,7 +98,7 @@

    CreateResponse in com.rallydev.rest

    -
    Packages that use CreateResponse 
    Package
    +
    @@ -99,7 +107,7 @@

    Uses of

    - @@ -111,9 +119,11 @@

    Uses of +
    - + +
    Skip navigation links
    +
    @@ -134,10 +144,10 @@

    Uses of
  • Frames
    • -
  • No Frames
    • +
  • No Frames
    • - + +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/DeleteResponse.html b/com/rallydev/rest/response/class-use/DeleteResponse.html similarity index 68% rename from src/main/resources/doc/com/rallydev/rest/response/class-use/DeleteResponse.html rename to com/rallydev/rest/response/class-use/DeleteResponse.html index ef543d8..dce3b98 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/DeleteResponse.html +++ b/com/rallydev/rest/response/class-use/DeleteResponse.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.response.DeleteResponse (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.response.DeleteResponse (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    @@ -41,10 +49,10 @@
    - +
    @@ -68,7 +76,7 @@

    • -

    Methods in com.rallydev.rest that return CreateResponse 
    Modifier and TypeCreateResponseRallyRestApi.create(CreateRequest request) +RallyRestApi.create(CreateRequest request)
    Create the specified object.
    +
    @@ -90,7 +98,7 @@

    DeleteResponse in com.rallydev.rest

    -
    Packages that use DeleteResponse 
    Package
    +
    @@ -99,7 +107,7 @@

    Uses of

    - @@ -111,9 +119,11 @@

    Uses of +
    - + +
    Skip navigation links
    +
    @@ -134,10 +144,10 @@

    Uses of
  • Frames
    • -
  • No Frames
    • +
  • No Frames
    • - + +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/GetResponse.html b/com/rallydev/rest/response/class-use/GetResponse.html similarity index 68% rename from src/main/resources/doc/com/rallydev/rest/response/class-use/GetResponse.html rename to com/rallydev/rest/response/class-use/GetResponse.html index 15d3ed5..3fe1e82 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/GetResponse.html +++ b/com/rallydev/rest/response/class-use/GetResponse.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.response.GetResponse (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.response.GetResponse (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    @@ -41,10 +49,10 @@
    - +
    @@ -68,7 +76,7 @@

    U
    • -

    Methods in com.rallydev.rest that return DeleteResponse 
    Modifier and TypeDeleteResponseRallyRestApi.delete(DeleteRequest request) +RallyRestApi.delete(DeleteRequest request)
    Delete the specified object.
    +
    @@ -90,7 +98,7 @@

    U

    Uses of GetResponse in com.rallydev.rest

    -
    Packages that use GetResponse 
    Package
    +
    @@ -99,7 +107,7 @@

    Uses of

    - @@ -111,9 +119,11 @@

    Uses of -
    +
    - + +
    Skip navigation links
    +
    @@ -134,10 +144,10 @@

    Uses of
    - +

    +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/QueryResponse.html b/com/rallydev/rest/response/class-use/QueryResponse.html similarity index 68% rename from src/main/resources/doc/com/rallydev/rest/response/class-use/QueryResponse.html rename to com/rallydev/rest/response/class-use/QueryResponse.html index 990ba64..897a7b6 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/QueryResponse.html +++ b/com/rallydev/rest/response/class-use/QueryResponse.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.response.QueryResponse (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.response.QueryResponse (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    @@ -41,10 +49,10 @@
    - +
    @@ -68,7 +76,7 @@

    • -

    Methods in com.rallydev.rest that return GetResponse 
    Modifier and Type
    GetResponseRallyRestApi.get(GetRequest request) +RallyRestApi.get(GetRequest request)
    Get the specified object.
    +
    @@ -90,7 +98,7 @@

    Uses of QueryResponse in com.rallydev.rest

    -
    Packages that use QueryResponse 
    Package
    +
    @@ -99,7 +107,7 @@

    Uses of

    - @@ -111,9 +119,11 @@

    Uses of +
    - + +
    Skip navigation links
    +
    @@ -134,10 +144,10 @@

    Uses of
  • Frames
    • -
  • No Frames
    • +
  • No Frames
    • - + +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/Response.html b/com/rallydev/rest/response/class-use/Response.html similarity index 64% rename from src/main/resources/doc/com/rallydev/rest/response/class-use/Response.html rename to com/rallydev/rest/response/class-use/Response.html index d4a863a..053a8d0 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/Response.html +++ b/com/rallydev/rest/response/class-use/Response.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.response.Response (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.response.Response (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    @@ -41,10 +49,10 @@
    - +
    @@ -68,7 +76,7 @@

    Uses
    • -

    Methods in com.rallydev.rest that return QueryResponse 
    Modifier and TypeQueryResponseRallyRestApi.query(QueryRequest request) +RallyRestApi.query(QueryRequest request)
    Query for objects matching the specified request.
    +
    @@ -90,7 +98,7 @@

    Uses

    Uses of Response in com.rallydev.rest.response

    -
    Packages that use Response 
    Package
    +
    @@ -99,37 +107,37 @@

    Uses of

    - - - - - - @@ -141,9 +149,11 @@

    Uses of -
    +
    - + +
    Skip navigation links
    +
    @@ -164,10 +174,10 @@

    Uses of
    - +

    +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/response/class-use/UpdateResponse.html b/com/rallydev/rest/response/class-use/UpdateResponse.html similarity index 68% rename from src/main/resources/doc/com/rallydev/rest/response/class-use/UpdateResponse.html rename to com/rallydev/rest/response/class-use/UpdateResponse.html index 9bbd953..180075f 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/UpdateResponse.html +++ b/com/rallydev/rest/response/class-use/UpdateResponse.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.response.UpdateResponse (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.response.UpdateResponse (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    @@ -41,10 +49,10 @@
    - +
    @@ -68,7 +76,7 @@

    • -

    Subclasses of Response in com.rallydev.rest.response 
    Modifier and Type
    class CollectionUpdateResponse +CollectionUpdateResponse
    Represents a WSAPI response from updating a collection.
    class CreateResponse +CreateResponse
    Represents a WSAPI response from creating an object
    class DeleteResponse +DeleteResponse
    Represents a WSAPI response from deleting an object
    class GetResponse +GetResponse
    Represents a WSAPI response from retrieving a single object.
    class QueryResponse +QueryResponse
    Represents a WSAPI response from querying for objects.
    class UpdateResponse +UpdateResponse
    Represents a WSAPI response from updating an object.
    +
    @@ -90,7 +98,7 @@

    UpdateResponse in com.rallydev.rest

    -
    Packages that use UpdateResponse 
    Package
    +
    @@ -99,7 +107,7 @@

    Uses of

    - @@ -111,9 +119,11 @@

    Uses of +
    - + +
    Skip navigation links
    +
    @@ -134,10 +144,10 @@

    Uses of
  • Frames
    • -
  • No Frames
    • +
  • No Frames
    • - + +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/resources/doc/com/rallydev/rest/response/package-frame.html b/com/rallydev/rest/response/package-frame.html similarity index 82% rename from src/main/resources/doc/com/rallydev/rest/response/package-frame.html rename to com/rallydev/rest/response/package-frame.html index 31296d9..eafc74e 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/package-frame.html +++ b/com/rallydev/rest/response/package-frame.html @@ -2,10 +2,12 @@ - -com.rallydev.rest.response (Rally Rest API for Java 2.2) + + +com.rallydev.rest.response (Rally Rest Toolkit For Java 2.2.1 API) +

    com.rallydev.rest.response

    diff --git a/src/main/resources/doc/com/rallydev/rest/response/package-summary.html b/com/rallydev/rest/response/package-summary.html similarity index 75% rename from src/main/resources/doc/com/rallydev/rest/response/package-summary.html rename to com/rallydev/rest/response/package-summary.html index 50f57e9..017e910 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/package-summary.html +++ b/com/rallydev/rest/response/package-summary.html @@ -2,15 +2,21 @@ - -com.rallydev.rest.response (Rally Rest API for Java 2.2) + + +com.rallydev.rest.response (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
    JavaScript is disabled on your browser.
    -
    +
    - + +
    Skip navigation links
    +
    - +
    @@ -67,12 +75,12 @@

    Package com.rallydev.rest.response

    Provides objects for parsing responses from the Rest API.
    -

    See: Description

    +

    See: Description

    • -
    Methods in com.rallydev.rest that return UpdateResponse 
    Modifier and TypeUpdateResponseRallyRestApi.update(UpdateRequest request) +RallyRestApi.update(UpdateRequest request)
    Update the specified object.
    +
    @@ -125,16 +133,18 @@

    Package com.rallydev.rest.response

    Class Summary 
    Class
- +

Package com.rallydev.rest.response Description

Provides objects for parsing responses from the Rest API.
-
+
- + +
Skip navigation links
+
- +
+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/com/rallydev/rest/response/package-tree.html b/com/rallydev/rest/response/package-tree.html similarity index 63% rename from src/main/resources/doc/com/rallydev/rest/response/package-tree.html rename to com/rallydev/rest/response/package-tree.html index 90ba57d..1663e5d 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/package-tree.html +++ b/com/rallydev/rest/response/package-tree.html @@ -2,15 +2,21 @@ - -com.rallydev.rest.response Class Hierarchy (Rally Rest API for Java 2.2) + + +com.rallydev.rest.response Class Hierarchy (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +

Hierarchy For Package com.rallydev.rest.response

-Package Hierarchies: +Package Hierarchies: @@ -72,16 +80,16 @@

Hierarchy For Package com.rallydev.rest.response

Class Hierarchy

-
+
- + +
Skip navigation links
+
@@ -112,10 +122,10 @@

Class Hierarchy

- +
+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/com/rallydev/rest/response/package-use.html b/com/rallydev/rest/response/package-use.html similarity index 76% rename from src/main/resources/doc/com/rallydev/rest/response/package-use.html rename to com/rallydev/rest/response/package-use.html index 7cc755b..a5850e5 100644 --- a/src/main/resources/doc/com/rallydev/rest/response/package-use.html +++ b/com/rallydev/rest/response/package-use.html @@ -2,15 +2,21 @@ - -Uses of Package com.rallydev.rest.response (Rally Rest API for Java 2.2) + + +Uses of Package com.rallydev.rest.response (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +
@@ -68,7 +76,7 @@

Uses of Pac
+ + + + +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Fetch

        +
        public Fetch(String... fetch)
        +
        Create a new fetch with the specified fields.
        +
        +
        Parameters:
        +
        fetch - one or more fields to be returned
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        public String toString()
        +
        Get the comma separated list of fields to be returned. + If the list is empty true will be returned.
        +
        +
        Overrides:
        +
        toString in class AbstractCollection<String>
        +
        Returns:
        +
        the comma separated list of fields to be returned
        +
        +
        • +
      +
      • +
    +
    • +
+
+

+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/util/QueryFilter.html b/com/rallydev/rest/util/QueryFilter.html new file mode 100644 index 0000000..aca2913 --- /dev/null +++ b/com/rallydev/rest/util/QueryFilter.html @@ -0,0 +1,423 @@ + + + + + + +QueryFilter (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.rallydev.rest.util
+

Class QueryFilter

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cloneable
    +
    +
    +
    +
    public class QueryFilter
+extends Object
+implements Cloneable
    +
    Represents a query filter to be applied to query requests. +

    More on the WSAPI query syntax can be found here: http://rally1.rallydev.com/slm/doc/webservice

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

      Constructor Detail

      + + + +
        +
      • +

        QueryFilter

        +
        public QueryFilter(String field,
+                   String operator,
+                   String value)
        +
        Create a new query filter with the specified options.
        +
        +
        Parameters:
        +
        field - the object field to evaluate
        +
        operator - the operator to use for evaluation
        +
        value - the value to be evaluated
        +
        +
        • +
      + + + +
        +
      • +

        QueryFilter

        +
        protected QueryFilter(QueryFilter left,
+                      String operator,
+                      QueryFilter right)
        +
        Internal constructor for joining multiple QueryFilter objects by an AND or OR.
        +
        +
        Parameters:
        +
        left - the left query
        +
        operator - AND/OR
        +
        right - the right query
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        and

        +
        public QueryFilter and(QueryFilter q)
        +
        Get a query filter that is the ANDed combination of this filter and the specified one.
        +
        +
        Parameters:
        +
        q - the filter to be ANDed
        +
        Returns:
        +
        the ANDed query filter
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public QueryFilter or(QueryFilter q)
        +
        Get a query filter that is the ORed combination of this filter and the specified one.
        +
        +
        Parameters:
        +
        q - the filter to be ORed
        +
        Returns:
        +
        the ORed query filter
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public String toString()
        +
        Get the string representation of this query filter. +

        Examples:

        +
          +
        • (ScheduleState = Accepted)
          • +
        • ((ScheduleState = Accepted) AND (Iteration.Name = "My Iteration"))
          • +
        +
        +
        Overrides:
        +
        toString in class Object
        +
        Returns:
        +
        the string representation of this query filter.
        +
        +
        • +
      + + + +
        +
      • +

        and

        +
        public static QueryFilter and(QueryFilter... queryFilters)
        +
        Get a query filter that is the ANDed combination of the specified filters.
        +
        +
        Parameters:
        +
        queryFilters - one or more query filters to be ANDed together
        +
        Returns:
        +
        the ANDed query filter
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public static QueryFilter or(QueryFilter... queryFilters)
        +
        Get a query filter that is the ORed combination of the specified filters.
        +
        +
        Parameters:
        +
        queryFilters - one or more query filters to be ORed together
        +
        Returns:
        +
        the ORed query filter
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/com/rallydev/rest/util/Ref.html b/com/rallydev/rest/util/Ref.html new file mode 100644 index 0000000..9b41025 --- /dev/null +++ b/com/rallydev/rest/util/Ref.html @@ -0,0 +1,349 @@ + + + + + + +Ref (Rally Rest Toolkit For Java 2.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.rallydev.rest.util
+

Class Ref

+
+
+ +
+
    +
  • +
    +
    +
    public class Ref
+extends Object
    +
    Provides utility methods for working with ref URLs.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Ref

        +
        public Ref()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isRef

        +
        public static boolean isRef(String ref)
        +
        Determine whether the specified string is a valid ref url.
        +
        +
        Parameters:
        +
        ref - the string to be tested. May be either absolute or relative, e.g. /defect/1234
        +
        Returns:
        +
        whether the specified string is a valid ref url
        +
        +
        • +
      + + + +
        +
      • +

        getRelativeRef

        +
        public static String getRelativeRef(String ref)
        +
        Create a relative ref url from the specified ref
        +
        +
        Parameters:
        +
        ref - the ref url to be made relative
        +
        Returns:
        +
        the relative ref url or null if the specified ref was not valid
        +
        +
        • +
      + + + +
        +
      • +

        getTypeFromRef

        +
        public static String getTypeFromRef(String ref)
        +
        Get the type from the specified ref url
        +
        +
        Parameters:
        +
        ref - the ref url to extract the type from
        +
        Returns:
        +
        the extracted type or null if the specified ref was not valid
        +
        +
        • +
      + + + +
        +
      • +

        getOidFromRef

        +
        public static String getOidFromRef(String ref)
        +
        Get the ObjectID from the specified ref url
        +
        +
        Parameters:
        +
        ref - the ref url to extract the ObjectID from
        +
        Returns:
        +
        the extracted ObjectID or null if the specified ref was not valid
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/src/main/resources/doc/com/rallydev/rest/util/class-use/Fetch.html b/com/rallydev/rest/util/class-use/Fetch.html similarity index 60% rename from src/main/resources/doc/com/rallydev/rest/util/class-use/Fetch.html rename to com/rallydev/rest/util/class-use/Fetch.html index b6f4e27..cb1cb9d 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/class-use/Fetch.html +++ b/com/rallydev/rest/util/class-use/Fetch.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.util.Fetch (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.util.Fetch (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +
@@ -68,7 +76,7 @@

Uses of Cla
-
+
- + +
Skip navigation links
+
@@ -226,10 +251,10 @@

Uses of
- +

+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/com/rallydev/rest/util/class-use/Ref.html b/com/rallydev/rest/util/class-use/Ref.html similarity index 65% rename from src/main/resources/doc/com/rallydev/rest/util/class-use/Ref.html rename to com/rallydev/rest/util/class-use/Ref.html index d0449d2..730fbd0 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/class-use/Ref.html +++ b/com/rallydev/rest/util/class-use/Ref.html @@ -2,15 +2,21 @@ - -Uses of Class com.rallydev.rest.util.Ref (Rally Rest API for Java 2.2) + + +Uses of Class com.rallydev.rest.util.Ref (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +
@@ -67,9 +75,11 @@

Uses of Class

No usage of com.rallydev.rest.util.Ref
-
+
- + +
Skip navigation links
+
@@ -90,10 +100,10 @@

Uses of Class
- +

+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/com/rallydev/rest/util/package-frame.html b/com/rallydev/rest/util/package-frame.html similarity index 74% rename from src/main/resources/doc/com/rallydev/rest/util/package-frame.html rename to com/rallydev/rest/util/package-frame.html index 495d866..0ef6b0d 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/package-frame.html +++ b/com/rallydev/rest/util/package-frame.html @@ -2,10 +2,12 @@ - -com.rallydev.rest.util (Rally Rest API for Java 2.2) + + +com.rallydev.rest.util (Rally Rest Toolkit For Java 2.2.1 API) +

com.rallydev.rest.util

diff --git a/src/main/resources/doc/com/rallydev/rest/util/package-summary.html b/com/rallydev/rest/util/package-summary.html similarity index 69% rename from src/main/resources/doc/com/rallydev/rest/util/package-summary.html rename to com/rallydev/rest/util/package-summary.html index 886484b..c45d19b 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/package-summary.html +++ b/com/rallydev/rest/util/package-summary.html @@ -2,15 +2,21 @@ - -com.rallydev.rest.util (Rally Rest API for Java 2.2) + + +com.rallydev.rest.util (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
- +
@@ -67,12 +75,12 @@

Package com.rallydev.rest.util

Provides utilities for working with the Rest API.
-

See: Description

+

See: Description

  • - +
    @@ -101,16 +109,18 @@

    Package com.rallydev.rest.util

    Class Summary 
    Class
- +

Package com.rallydev.rest.util Description

Provides utilities for working with the Rest API.
-
+
- + +
Skip navigation links
+
- +
+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/com/rallydev/rest/util/package-tree.html b/com/rallydev/rest/util/package-tree.html similarity index 50% rename from src/main/resources/doc/com/rallydev/rest/util/package-tree.html rename to com/rallydev/rest/util/package-tree.html index d42ce88..221b87c 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/package-tree.html +++ b/com/rallydev/rest/util/package-tree.html @@ -2,15 +2,21 @@ - -com.rallydev.rest.util Class Hierarchy (Rally Rest API for Java 2.2) + + +com.rallydev.rest.util Class Hierarchy (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +

Hierarchy For Package com.rallydev.rest.util

-Package Hierarchies: +Package Hierarchies: @@ -72,31 +80,33 @@

Hierarchy For Package com.rallydev.rest.util

Class Hierarchy

-
+
- + +
Skip navigation links
+
@@ -117,10 +127,10 @@

Class Hierarchy

- +
+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/com/rallydev/rest/util/package-use.html b/com/rallydev/rest/util/package-use.html similarity index 73% rename from src/main/resources/doc/com/rallydev/rest/util/package-use.html rename to com/rallydev/rest/util/package-use.html index 4b66a80..eeafa01 100644 --- a/src/main/resources/doc/com/rallydev/rest/util/package-use.html +++ b/com/rallydev/rest/util/package-use.html @@ -2,15 +2,21 @@ - -Uses of Package com.rallydev.rest.util (Rally Rest API for Java 2.2) + + +Uses of Package com.rallydev.rest.util (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +
@@ -68,7 +76,7 @@

Uses of Package
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +

Copyright © 2016. All Rights Reserved.

+ + diff --git a/src/main/resources/doc/deprecated-list.html b/deprecated-list.html similarity index 62% rename from src/main/resources/doc/deprecated-list.html rename to deprecated-list.html index 8e84859..158fa38 100644 --- a/src/main/resources/doc/deprecated-list.html +++ b/deprecated-list.html @@ -2,15 +2,21 @@ - -Deprecated List (Rally Rest API for Java 2.2) + + +Deprecated List (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +
@@ -74,15 +82,15 @@

Contents

-
+
- + +
Skip navigation links
+
@@ -130,10 +140,10 @@

Rally Rest API for Java 2.2

- +
+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/overview-tree.html b/overview-tree.html similarity index 52% rename from src/main/resources/doc/overview-tree.html rename to overview-tree.html index 074e018..61f37e5 100644 --- a/src/main/resources/doc/overview-tree.html +++ b/overview-tree.html @@ -2,15 +2,21 @@ - -Class Hierarchy (Rally Rest API for Java 2.2) + + +Class Hierarchy (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +

Hierarchy For All Packages

-Package Hierarchies: +Package Hierarchies:
- +
+

Copyright © 2016. All Rights Reserved.

diff --git a/src/main/resources/doc/package-list b/package-list similarity index 100% rename from src/main/resources/doc/package-list rename to package-list diff --git a/pom.xml b/pom.xml deleted file mode 100644 index e0ede63..0000000 --- a/pom.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - 4.0.0 - - org.sonatype.oss - oss-parent - 7 - - jar - Rally Rest Toolkit For Java - com.rallydev.rest - rally-rest-api - 2.2.2-SNAPSHOT - - A java toolkit for interacting with the Rally Rest API - - https://github.com/RallyTools/RallyRestToolkitForJava - - - The MIT License (MIT) - http://opensource.org/licenses/MIT - repo - - - - - - krmorse - Kyle Morse - - - - - scm:git:git@github.com:RallyTools/RallyRestToolkitForJava.git - scm:git:git@github.com:RallyTools/RallyRestToolkitForJava.git - git@github.com:RallyTools/RallyRestToolkitForJava.git - - - - - org.apache.maven.plugins - maven-javadoc-plugin - - - attach-javadocs - - jar - - - - - - org.apache.maven.plugins - maven-source-plugin - - - attach-sources - - jar - - - - - - org.apache.maven.plugins - maven-gpg-plugin - - - sign-artifacts - verify - - sign - - - - - - org.sonatype.plugins - nexus-staging-maven-plugin - 1.6.2 - true - - sonatype-nexus-staging - - https://oss.sonatype.org/ - - - - - - - - org.apache.httpcomponents - httpclient - 4.2.5 - - - com.google.code.gson - gson - 2.2.4 - - - org.testng - testng - 6.1.1 - test - - - org.mockito - mockito-core - 1.9.5 - test - - - - - diff --git a/script.js b/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/src/main/resources/doc/serialized-form.html b/serialized-form.html similarity index 62% rename from src/main/resources/doc/serialized-form.html rename to serialized-form.html index 49ad6f5..52fe839 100644 --- a/src/main/resources/doc/serialized-form.html +++ b/serialized-form.html @@ -2,15 +2,21 @@ - -Serialized Form (Rally Rest API for Java 2.2) + + +Serialized Form (Rally Rest Toolkit For Java 2.2.1 API) + @@ -18,9 +24,11 @@
JavaScript is disabled on your browser.
-
+
- + +
Skip navigation links
+
@@ -41,10 +49,10 @@
- +
@@ -73,16 +81,18 @@

Package com.rallydev.rest.util

  • -

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

    +

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

    • -
    +
    - + +
    Skip navigation links
    +
    @@ -103,10 +113,10 @@

    Class
  • Frames
    • -
  • No Frames
    • +
  • No Frames
    • - +

    +

    Copyright © 2016. All Rights Reserved.

    diff --git a/src/main/java/META-INF/MANIFEST.MF b/src/main/java/META-INF/MANIFEST.MF deleted file mode 100644 index e2ce639..0000000 --- a/src/main/java/META-INF/MANIFEST.MF +++ /dev/null @@ -1,9 +0,0 @@ -Manifest-Version: "1.2" -Implementation-Vendor: "Rally Software, Inc." -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.2.1" diff --git a/src/main/java/com/rallydev/rest/RallyRestApi.java b/src/main/java/com/rallydev/rest/RallyRestApi.java deleted file mode 100644 index 6a0eaa8..0000000 --- a/src/main/java/com/rallydev/rest/RallyRestApi.java +++ /dev/null @@ -1,221 +0,0 @@ -package com.rallydev.rest; - -import com.google.gson.JsonArray; -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; - -/** - *

    The main interface to the Rest API.

    - *

    Provides CRUD and query operations.

    - */ -public class RallyRestApi implements Closeable { - - protected HttpClient client; - - /** - * Creates a new instance for the specified server using the specified credentials. - * - * @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(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; - } - - /** - * 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) { - client.setProxy(proxy); - } - - /** - * 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) { - client.setProxy(proxy, userName, password); - } - - /** - * 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) { - client.setApplicationVendor(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) { - client.setApplicationVersion(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) { - 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); - } - - /** - * Create the specified object. - * - * @param request the {@link CreateRequest} specifying the object to be created. - * @return the resulting {@link CreateResponse} - * @throws IOException if an error occurs during the creation. - */ - public CreateResponse create(CreateRequest request) throws IOException { - return new CreateResponse(client.doPost(request.toUrl(), request.getBody())); - } - - /** - * Update the specified object. - * - * @param request the {@link UpdateRequest} specifying the object to be updated. - * @return the resulting {@link UpdateResponse} - * @throws IOException if an error occurs during the update. - */ - public UpdateResponse update(UpdateRequest request) throws IOException { - return new UpdateResponse(client.doPost(request.toUrl(), request.getBody())); - } - - /** - * 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())); - } - - /** - * Delete the specified object. - * - * @param request the {@link DeleteRequest} specifying the object to be deleted. - * @return the resulting {@link DeleteResponse} - * @throws IOException if an error occurs during the deletion. - */ - public DeleteResponse delete(DeleteRequest request) throws IOException { - return new DeleteResponse(client.doDelete(request.toUrl())); - } - - /** - * 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. - * - * @param request the {@link QueryRequest} specifying the object to be created. - * @return the resulting {@link QueryResponse} - * @throws IOException if an error occurs during the query. - */ - public QueryResponse query(QueryRequest request) throws IOException { - 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(client.doGet(pageRequest.toUrl())); - if (pageResponse.wasSuccessful()) { - JsonArray results = queryResponse.getResults(); - results.addAll(pageResponse.getResults()); - receivedRecords += pageRequest.getPageSize(); - } - } - } - - return queryResponse; - } - - /** - * Get the specified object. - * - * @param request the {@link GetRequest} specifying the object to be retrieved. - * @return the resulting {@link GetResponse} - * @throws IOException if an error occurs during the retrieval. - */ - public GetResponse get(GetRequest request) throws IOException { - return new GetResponse(client.doGet(request.toUrl())); - } - - /** - * Release all resources associated with this instance. - * - * @throws IOException if an error occurs releasing resources - */ - public void close() throws IOException { - client.close(); - } - - /** - * 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 raw http client - */ - 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 deleted file mode 100644 index 2295824..0000000 --- a/src/main/java/com/rallydev/rest/client/ApiKeyClient.java +++ /dev/null @@ -1,39 +0,0 @@ -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 deleted file mode 100644 index 2b6d04a..0000000 --- a/src/main/java/com/rallydev/rest/client/BasicAuthClient.java +++ /dev/null @@ -1,89 +0,0 @@ -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.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); - credentials = setClientCredentials(server, 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; - } - } - } -} \ 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 deleted file mode 100644 index 3bc4a9a..0000000 --- a/src/main/java/com/rallydev/rest/client/HttpClient.java +++ /dev/null @@ -1,247 +0,0 @@ -package com.rallydev.rest.client; - -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.Credentials; -import org.apache.http.auth.UsernamePasswordCredentials; -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.DecompressingHttpClient; -import org.apache.http.impl.client.DefaultHttpClient; -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 extends DefaultHttpClient - implements Closeable { - - protected URI server; - protected String wsapiVersion = "v2.0"; - protected DecompressingHttpClient client; - - 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 = server; - client = new DecompressingHttpClient(this); - } - - /** - * 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) { - this.getParams().setParameter(ConnRoutePNames.DEFAULT_PROXY, new HttpHost(proxy.getHost(), proxy.getPort(), proxy.getScheme())); - } - - /** - * 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) { - setProxy(proxy); - setClientCredentials(proxy, userName, password); - } - - /** - * 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 { - HttpResponse 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. - * - * @throws IOException if an error occurs releasing resources - */ - public void close() throws IOException { - client.getConnectionManager().shutdown(); - } - - protected Credentials setClientCredentials(URI server, String userName, String password) { - UsernamePasswordCredentials credentials = new UsernamePasswordCredentials(userName, password); - this.getCredentialsProvider().setCredentials(new AuthScope(server.getHost(), server.getPort()), credentials); - return credentials; - } - - /** - * 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 deleted file mode 100644 index 2b38cbd..0000000 --- a/src/main/java/com/rallydev/rest/client/package-info.java +++ /dev/null @@ -1,4 +0,0 @@ -/** - * 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/package-info.java b/src/main/java/com/rallydev/rest/package-info.java deleted file mode 100644 index f9d15fc..0000000 --- a/src/main/java/com/rallydev/rest/package-info.java +++ /dev/null @@ -1,4 +0,0 @@ -/** - * Provides the main interface to the Rest API. - */ -package com.rallydev.rest; \ 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 deleted file mode 100644 index 4b162b1..0000000 --- a/src/main/java/com/rallydev/rest/request/CollectionUpdateRequest.java +++ /dev/null @@ -1,96 +0,0 @@ -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 deleted file mode 100644 index 86aa554..0000000 --- a/src/main/java/com/rallydev/rest/request/CreateRequest.java +++ /dev/null @@ -1,77 +0,0 @@ -package com.rallydev.rest.request; - -import com.google.gson.JsonObject; -import com.rallydev.rest.util.Fetch; -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 create an object. - */ -public class CreateRequest extends Request { - - private String type; - private JsonObject obj; - private Fetch fetch = new Fetch(); - - /** - * Create a new create request with the specified type and values. - * - * @param type the WSAPI object type to be created, e.g. Defect - * @param obj the JSON representation of the values of the object - */ - public CreateRequest(String type, JsonObject obj) { - this.type = type; - this.obj = obj; - } - - /** - * Get the JSON encoded string representation of the object to be created. - * - * @return the JSON encoded object - */ - public String getBody() { - JsonObject wrapper = new JsonObject(); - wrapper.add(type, obj); - return gsonBuilder.create().toJson(wrapper); - } - - /** - *

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

    - * By default only the underscore fields such as _ref will be returned in the response. - * - * @return the current list of fields. - */ - public Fetch getFetch() { - return fetch; - } - - /** - * Set the current list of fields to be returned on the created 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/create.js?%s", type.toLowerCase().replaceAll(" ", ""), - URLEncodedUtils.format(params, "utf-8")); - } -} diff --git a/src/main/java/com/rallydev/rest/request/DeleteRequest.java b/src/main/java/com/rallydev/rest/request/DeleteRequest.java deleted file mode 100644 index 33a1aa7..0000000 --- a/src/main/java/com/rallydev/rest/request/DeleteRequest.java +++ /dev/null @@ -1,32 +0,0 @@ -package com.rallydev.rest.request; - -import com.rallydev.rest.util.Ref; -import org.apache.http.client.utils.URLEncodedUtils; - -/** - * Represents a WSAPI request to delete an object. - */ -public class DeleteRequest extends Request{ - - private String ref; - - /** - * Createa new delete request for the specified object. - * @param ref the ref of the WSAPI object to be created. May be absolute or relative, e.g. "/defect/12345" - */ - public DeleteRequest(String ref) { - this.ref = ref; - } - - /** - *

    Convert this request into a url compatible with the WSAPI.

    - * Any parameters set will be included. - * - * @return the url representing this request. - */ - @Override - public String toUrl() { - return String.format("%s.js%s", Ref.getRelativeRef(ref), - getParams().size() > 0 ? ("?" + URLEncodedUtils.format(getParams(), "utf-8")) : ""); - } -} diff --git a/src/main/java/com/rallydev/rest/request/GetRequest.java b/src/main/java/com/rallydev/rest/request/GetRequest.java deleted file mode 100644 index eaea818..0000000 --- a/src/main/java/com/rallydev/rest/request/GetRequest.java +++ /dev/null @@ -1,75 +0,0 @@ -package com.rallydev.rest.request; - -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 retrieve a specific object. - */ -public class GetRequest extends Request { - - private String ref; - private Fetch fetch = new Fetch(); - - /** - * Create a new get request for the specified object. - * - * @param ref the ref of the WSAPI object to be retrieved. May be absolute or relative, e.g. "/defect/12345" - * May also be "/user" or "/subscription" to get the current instances - */ - public GetRequest(String ref) { - this.ref = ref; - } - - /** - *

    Get the current list of fields to be returned on the retrieved 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 retrieved 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", fetch.toString())); - return String.format("%s.js?%s", getEndpoint(), - URLEncodedUtils.format(params, "utf-8")); - } - - protected String getEndpoint() { - String endpoint = ref.toLowerCase(); - if (Ref.isRef(endpoint)) { - endpoint = Ref.getRelativeRef(endpoint); - } else if (endpoint.contains("user")) { - endpoint = "/user"; - } else if (endpoint.contains("subscription")) { - endpoint = "/subscription"; - } - - return endpoint; - } -} diff --git a/src/main/java/com/rallydev/rest/request/QueryRequest.java b/src/main/java/com/rallydev/rest/request/QueryRequest.java deleted file mode 100644 index c013452..0000000 --- a/src/main/java/com/rallydev/rest/request/QueryRequest.java +++ /dev/null @@ -1,305 +0,0 @@ -package com.rallydev.rest.request; - -import com.google.gson.JsonObject; -import com.rallydev.rest.util.Fetch; -import com.rallydev.rest.util.QueryFilter; -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 retrieve all objects matching specified criteria. - */ -public class QueryRequest extends Request implements Cloneable { - - private String type; - private JsonObject collection; - - private Fetch fetch = new Fetch(); - private String order = "ObjectID"; - private QueryFilter queryFilter = null; - - private int pageSize = 200; - private int limit = 0; - private int start = 1; - - private String workspace = ""; - private String project = ""; - private boolean scopedUp = false; - private boolean scopedDown = true; - - /** - * Create a new query request for the specified type. - * - * @param type The WSAPI type to be queried, e.g. Defect - */ - public QueryRequest(String type) { - this.type = type; - } - - /** - * Create a new query request for the specified collection. - * Only supported in WSAPI v2.0 and above. - * - * @param collection The collection to query. Should have a _ref property. - */ - public QueryRequest(JsonObject collection) { - this.collection = collection; - } - - /** - * Get the filter by which the result set will be narrowed down. - * - * @return the filter - */ - public QueryFilter getQueryFilter() { - return queryFilter; - } - - /** - * Set a filter by which the result set will be narrowed down. - * - * @param queryFilter the filter - */ - public void setQueryFilter(QueryFilter queryFilter) { - this.queryFilter = queryFilter; - } - - /** - * Set the order by which the result set will be sorted. - *

    The default is ObjectID ASC.

    - * - * @return the order - */ - public String getOrder() { - return order; - } - - /** - * Get the order by which the result set will be sorted. - * - * @param order the order - */ - public void setOrder(String order) { - this.order = order; - } - - /** - * Get the workspace which the result set should be scoped to. - * - * @return the project - */ - public String getWorkspace() { - return workspace; - } - - /** - *

    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 - */ - public void setWorkspace(String workspaceRef) { - this.workspace = workspaceRef; - } - - /** - * Get the project which the result set should be scoped to. - * - * @return the project - */ - public String getProject() { - return project; - } - - /** - *

    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 - */ - public void setProject(String projectRef) { - this.project = 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. - */ - public boolean isScopedUp() { - return scopedUp; - } - - /** - *

    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 - */ - public void setScopedUp(boolean scopeUp) { - this.scopedUp = 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. - */ - public boolean isScopedDown() { - return scopedDown; - } - - /** - *

    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 - */ - public void setScopedDown(boolean scopeDown) { - this.scopedDown = scopeDown; - } - - /** - * Get the start index of the result set. - * - * @return the start index - */ - public int getStart() { - return start; - } - - /** - * Set the 1-based start index of the result set. - * The default is 1. - * - * @param start the start index - */ - public void setStart(int start) { - this.start = start; - } - - /** - *

    Get the current list of fields to be returned on the matching objects.

    - * 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 matching objects. - * - * @param fetch the list of fields to be returned. - */ - public void setFetch(Fetch fetch) { - this.fetch = fetch; - } - - /** - * Get the page size of the result set. - * - * @return the page size - */ - public int getPageSize() { - return pageSize; - } - - /** - *

    Set the page size of the result set.

    - * The default is 200. - * - * @param pageSize the new page size. Must be between 1 and 200 inclusive. - */ - public void setPageSize(int pageSize) { - this.pageSize = pageSize; - } - - /** - * Get the maximum number of records to be returned from the query. - * - * @return the maximum number of records - */ - public int getLimit() { - return limit; - } - - /** - *

    Set the maximum number of records to be returned from the query.

    - * If not set only one page of data will be returned by {@link com.rallydev.rest.RallyRestApi#query} - * - * @param limit the maximum number of records to be returned - */ - public void setLimit(int limit) { - this.limit = limit; - } - - /** - * Clone this request. - * - * @return the cloned instance of this request. - */ - @Override - public QueryRequest clone() { - try { - return (QueryRequest) super.clone(); - } catch (CloneNotSupportedException c) { - return null; - } - } - - /** - *

    Convert this request into a url compatible with the WSAPI.

    - * The current criteria set on this request 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("start", Integer.toString(getStart()))); - params.add(new BasicNameValuePair("pagesize", Integer.toString(getPageSize()))); - params.add(new BasicNameValuePair("fetch", fetch.toString())); - - String order = getOrder(); - if (!order.contains("ObjectID")) { - order += ",ObjectID"; - } - params.add(new BasicNameValuePair("order", order)); - if (getQueryFilter() != null) { - params.add(new BasicNameValuePair("query", getQueryFilter().toString())); - } - - if (getWorkspace() != null && getWorkspace().length() > 0) { - params.add(new BasicNameValuePair("workspace", Ref.getRelativeRef(getWorkspace()))); - } - - if (getProject() == null) { - params.add(new BasicNameValuePair("project", "null")); - } else if (getProject().length() > 0) { - params.add(new BasicNameValuePair("project", getProject())); - params.add(new BasicNameValuePair("projectScopeUp", Boolean.toString(isScopedUp()))); - params.add(new BasicNameValuePair("projectScopeDown", Boolean.toString(isScopedDown()))); - } - - return (this.type != null ? getTypeEndpoint() : - Ref.getRelativeRef(collection.get("_ref").getAsString())) + - "?" + URLEncodedUtils.format(params, "utf-8"); - } - - protected String getTypeEndpoint() { - String typeEndpoint = type.toLowerCase().replaceAll(" ", ""); - if (typeEndpoint.equals("subscription") || typeEndpoint.equals("user")) { - typeEndpoint += "s"; - } - return "/" + typeEndpoint + ".js"; - } -} \ No newline at end of file diff --git a/src/main/java/com/rallydev/rest/request/Request.java b/src/main/java/com/rallydev/rest/request/Request.java deleted file mode 100644 index 9e86066..0000000 --- a/src/main/java/com/rallydev/rest/request/Request.java +++ /dev/null @@ -1,83 +0,0 @@ -package com.rallydev.rest.request; - -import com.google.gson.GsonBuilder; -import org.apache.http.NameValuePair; -import org.apache.http.message.BasicNameValuePair; - -import java.util.ArrayList; -import java.util.List; - -/** - *

    Base class for all WSAPI requests.

    - * Subclasses classes should provide an implementation of {@link com.rallydev.rest.request.Request#toUrl} - */ -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(); - } - - /** - * Get the list of additional parameters included in this request. - * - * @return The list of additional parameters - */ - public List getParams() { - return params; - } - - /** - * Set the list of additional parameters included in this request. - * - * @param params The list of additional parameters - */ - public void setParams(List params) { - this.params = params; - } - - /** - * Add the specified parameter to this request. - * - * @param name the parameter name - * @param value the parameter value - */ - 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. - * - * @return the url representing this request. - */ - public abstract String toUrl(); -} diff --git a/src/main/java/com/rallydev/rest/request/UpdateRequest.java b/src/main/java/com/rallydev/rest/request/UpdateRequest.java deleted file mode 100644 index e0f3a7d..0000000 --- a/src/main/java/com/rallydev/rest/request/UpdateRequest.java +++ /dev/null @@ -1,79 +0,0 @@ -package com.rallydev.rest.request; - -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 an object. - */ -public class UpdateRequest extends Request { - - private String ref; - private JsonObject obj; - private Fetch fetch = new Fetch(); - - /** - * Create a new update request for the specified object and values. - * - * @param ref the ref of the WSAPI object to be created. May be absolute or relative, e.g. "/defect/12345" - * @param obj the JSON representation of the values of the object - */ - public UpdateRequest(String ref, JsonObject obj) { - this.ref = ref; - this.obj = obj; - } - - /** - * 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(Ref.getTypeFromRef(ref), obj); - 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.js?%s", Ref.getRelativeRef(ref), - URLEncodedUtils.format(params, "utf-8")); - } -} diff --git a/src/main/java/com/rallydev/rest/request/package-info.java b/src/main/java/com/rallydev/rest/request/package-info.java deleted file mode 100644 index 0a45275..0000000 --- a/src/main/java/com/rallydev/rest/request/package-info.java +++ /dev/null @@ -1,4 +0,0 @@ -/** - * Provides objects for encoding requests to the Rest API. - */ -package com.rallydev.rest.request; \ No newline at end of file diff --git a/src/main/java/com/rallydev/rest/response/CollectionUpdateResponse.java b/src/main/java/com/rallydev/rest/response/CollectionUpdateResponse.java deleted file mode 100644 index 6a42b3f..0000000 --- a/src/main/java/com/rallydev/rest/response/CollectionUpdateResponse.java +++ /dev/null @@ -1,37 +0,0 @@ -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 deleted file mode 100644 index 1a60045..0000000 --- a/src/main/java/com/rallydev/rest/response/CreateResponse.java +++ /dev/null @@ -1,38 +0,0 @@ -package com.rallydev.rest.response; - -import com.google.gson.JsonObject; -import com.rallydev.rest.RallyRestApi; - -/** - * 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) { - super(createResponse); - } - - /** - * Get the name of the root JSON result - * - * @return the root element name - */ - @Override - protected String getRoot() { - return "CreateResult"; - } - - /** - * Get the created object. - *

    Returns null if the operation was not successful

    - * @return the created object - */ - public JsonObject getObject() { - return wasSuccessful() ? result.getAsJsonObject("Object") : null; - } -} diff --git a/src/main/java/com/rallydev/rest/response/DeleteResponse.java b/src/main/java/com/rallydev/rest/response/DeleteResponse.java deleted file mode 100644 index 477efff..0000000 --- a/src/main/java/com/rallydev/rest/response/DeleteResponse.java +++ /dev/null @@ -1,26 +0,0 @@ -package com.rallydev.rest.response; - -/** - * Represents a WSAPI response from deleting an object - */ -public class DeleteResponse extends Response { - - /** - * Create a new delete response from the specified JSON encoded string. - * - * @param deleteResponse the JSON encoded string - */ - public DeleteResponse(String deleteResponse) { - super(deleteResponse); - } - - /** - * Get the name of the root JSON result - * - * @return the root element name - */ - @Override - protected String getRoot() { - return "OperationResult"; - } -} diff --git a/src/main/java/com/rallydev/rest/response/GetResponse.java b/src/main/java/com/rallydev/rest/response/GetResponse.java deleted file mode 100644 index 0165f9f..0000000 --- a/src/main/java/com/rallydev/rest/response/GetResponse.java +++ /dev/null @@ -1,46 +0,0 @@ -package com.rallydev.rest.response; - -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParser; - -import java.util.Map; - -/** - * Represents a WSAPI response from retrieving a single object. - */ -public class GetResponse extends Response { - - /** - * Create a new get response from the specified JSON encoded string. - * - * @param getResponse the JSON encoded string - */ - public GetResponse(String getResponse) { - super(getResponse); - } - - /** - * Get the name of the root JSON result - * - * @return the root element name - */ - @Override - protected String getRoot() { - JsonObject result = ((JsonObject) new JsonParser().parse(raw)); - String root = null; - for(Map.Entry member : result.entrySet()) { - root = member.getKey(); - } - return root; - } - - /** - * Get the retrieved object. - *

    Returns null if the operation was not successful

    - * @return the retrieved object - */ - public JsonObject getObject() { - return wasSuccessful() ? result : null; - } -} diff --git a/src/main/java/com/rallydev/rest/response/QueryResponse.java b/src/main/java/com/rallydev/rest/response/QueryResponse.java deleted file mode 100644 index 148f92e..0000000 --- a/src/main/java/com/rallydev/rest/response/QueryResponse.java +++ /dev/null @@ -1,65 +0,0 @@ -package com.rallydev.rest.response; - -import com.google.gson.JsonArray; - -/** - * Represents a WSAPI response from querying for objects. - */ -public class QueryResponse extends Response { - - /** - * Create a new query response from the specified JSON encoded string. - * - * @param queryResponse the JSON encoded string - */ - public QueryResponse(String queryResponse) { - super(queryResponse); - } - - /** - * Get the name of the root JSON result - * - * @return the root element name - */ - @Override - protected String getRoot() { - return "QueryResult"; - } - - /** - * Get the total number of objects that matched the query - * - * @return the total number of objects - */ - public int getTotalResultCount() { - return result.get("TotalResultCount").getAsInt(); - } - - /** - * 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() { - return result.getAsJsonArray("Results"); - } - - /** - * Get the page size of the results - * - * @return the page size - */ - public int getPageSize() { - return result.get("PageSize").getAsInt(); - } - - /** - * Get the start index of the results - * - * @return the start index - */ - public int getStart() { - return result.get("StartIndex").getAsInt(); - } -} diff --git a/src/main/java/com/rallydev/rest/response/Response.java b/src/main/java/com/rallydev/rest/response/Response.java deleted file mode 100644 index de1123a..0000000 --- a/src/main/java/com/rallydev/rest/response/Response.java +++ /dev/null @@ -1,69 +0,0 @@ -package com.rallydev.rest.response; - -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParser; - -import java.util.ArrayList; -import java.util.List; - -/** - * Represents a WSAPI response. - */ -public abstract class Response { - - protected JsonObject result; - protected String raw; - - /** - * Create a new response from the specified JSON encoded string. - * - * @param response the JSON encoded string - */ - public Response(String response) { - this.raw = response; - this.result = ((JsonObject) new JsonParser().parse(response)).getAsJsonObject(getRoot()); - } - - /** - * Returns whether the response was successful (no errors) - * - * @return whether the response was successful - */ - public boolean wasSuccessful() { - return getErrors().length == 0; - } - - /** - * Get any errors returned in the response. - * - * @return the response errors - */ - public String[] getErrors() { - return parseArray("Errors"); - } - - /** - * Get any warnings returned in the response. - * - * @return the response warnings - */ - public String[] getWarnings() { - return parseArray("Warnings"); - } - - /** - * Get the name of the root JSON result - * - * @return the root element name - */ - protected abstract String getRoot(); - - private String[] parseArray(String key) { - List elements = new ArrayList(); - for (JsonElement j : result.getAsJsonArray(key)) { - elements.add(j.getAsString()); - } - return elements.toArray(new String[elements.size()]); - } -} diff --git a/src/main/java/com/rallydev/rest/response/UpdateResponse.java b/src/main/java/com/rallydev/rest/response/UpdateResponse.java deleted file mode 100644 index 0e12292..0000000 --- a/src/main/java/com/rallydev/rest/response/UpdateResponse.java +++ /dev/null @@ -1,37 +0,0 @@ -package com.rallydev.rest.response; - -import com.google.gson.JsonObject; - -/** - * Represents a WSAPI response from updating an object. - */ -public class UpdateResponse extends Response { - - /** - * Create a new update response from the specified JSON encoded string. - * - * @param updateResponse the JSON encoded string - */ - public UpdateResponse(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 updated object. - *

    Returns null if the operation was not successful

    - * @return the updated object - */ - public JsonObject getObject() { - return wasSuccessful() ? result.getAsJsonObject("Object") : null; - } -} diff --git a/src/main/java/com/rallydev/rest/response/package-info.java b/src/main/java/com/rallydev/rest/response/package-info.java deleted file mode 100644 index 8fb39e8..0000000 --- a/src/main/java/com/rallydev/rest/response/package-info.java +++ /dev/null @@ -1,4 +0,0 @@ -/** - * Provides objects for parsing responses from the Rest API. - */ -package com.rallydev.rest.response; \ No newline at end of file diff --git a/src/main/java/com/rallydev/rest/util/Fetch.java b/src/main/java/com/rallydev/rest/util/Fetch.java deleted file mode 100644 index 9d5804d..0000000 --- a/src/main/java/com/rallydev/rest/util/Fetch.java +++ /dev/null @@ -1,40 +0,0 @@ -package com.rallydev.rest.util; - -import java.util.ArrayList; -import java.util.Arrays; - -/** - * Represents a list of fields to be returned in responses from the WSAPI. - */ -public class Fetch extends ArrayList { - - /** - * Create a new fetch with the specified fields. - * - * @param fetch one or more fields to be returned - */ - public Fetch(String... fetch) { - this.addAll(Arrays.asList(fetch)); - } - - /** - * Get the comma separated list of fields to be returned. - * If the list is empty true will be returned. - * - * @return the comma separated list of fields to be returned - */ - @Override - public String toString() { - if (size() == 0) { - return "true"; - } else { - StringBuilder s = new StringBuilder(); - for (String f : this) { - s.append(f); - s.append(","); - } - s.deleteCharAt(s.length() - 1); - return s.toString(); - } - } -} diff --git a/src/main/java/com/rallydev/rest/util/QueryFilter.java b/src/main/java/com/rallydev/rest/util/QueryFilter.java deleted file mode 100644 index b2a55de..0000000 --- a/src/main/java/com/rallydev/rest/util/QueryFilter.java +++ /dev/null @@ -1,115 +0,0 @@ -package com.rallydev.rest.util; - -/** - * Represents a query filter to be applied to query requests. - *

    More on the WSAPI query syntax can be found here: http://rally1.rallydev.com/slm/doc/webservice

    - */ -public class QueryFilter implements Cloneable { - - private String field; - private String operator; - private String value; - - private QueryFilter left = null; - private QueryFilter right = null; - - /** - * Create a new query filter with the specified options. - * - * @param field the object field to evaluate - * @param operator the operator to use for evaluation - * @param value the value to be evaluated - */ - public QueryFilter(String field, String operator, String value) { - this.field = field; - this.operator = operator; - this.value = value; - } - - /** - * Internal constructor for joining multiple QueryFilter objects by an AND or OR. - * - * @param left the left query - * @param operator AND/OR - * @param right the right query - */ - protected QueryFilter(QueryFilter left, String operator, QueryFilter right) { - this.left = left; - this.operator = operator; - this.right = right; - } - - /** - * Get a query filter that is the ANDed combination of this filter and the specified one. - * - * @param q the filter to be ANDed - * @return the ANDed query filter - */ - public QueryFilter and(QueryFilter q) { - return new QueryFilter(this, "AND", q); - } - - /** - * Get a query filter that is the ORed combination of this filter and the specified one. - * - * @param q the filter to be ORed - * @return the ORed query filter - */ - public QueryFilter or(QueryFilter q) { - return new QueryFilter(this, "OR", q); - } - - /** - * Get the string representation of this query filter. - *

    Examples:

    - *
      - *
    • (ScheduleState = Accepted)
      • - *
    • ((ScheduleState = Accepted) AND (Iteration.Name = "My Iteration"))
      • - *
    - * - * @return the string representation of this query filter. - */ - public String toString() { - if (left != null) { - return String.format("(%s %s %s)", left, operator, right); - } else { - String val = value; - if (val != null) { - val = val.contains(" ") ? "\"" + val + "\"" : val; - - if (Ref.isRef(val)) { - val = Ref.getRelativeRef(val); - } - } - return String.format("(%s %s %s)", field, operator, val); - } - } - - /** - * Get a query filter that is the ANDed combination of the specified filters. - * - * @param queryFilters one or more query filters to be ANDed together - * @return the ANDed query filter - */ - public static QueryFilter and(QueryFilter... queryFilters) { - QueryFilter result = null; - for (QueryFilter q : queryFilters) { - result = result == null ? q : result.and(q); - } - return result; - } - - /** - * Get a query filter that is the ORed combination of the specified filters. - * - * @param queryFilters one or more query filters to be ORed together - * @return the ORed query filter - */ - public static QueryFilter or(QueryFilter... queryFilters) { - QueryFilter result = null; - for (QueryFilter q : queryFilters) { - result = result == null ? q : result.or(q); - } - return result; - } -} diff --git a/src/main/java/com/rallydev/rest/util/Ref.java b/src/main/java/com/rallydev/rest/util/Ref.java deleted file mode 100644 index 2463787..0000000 --- a/src/main/java/com/rallydev/rest/util/Ref.java +++ /dev/null @@ -1,103 +0,0 @@ -package com.rallydev.rest.util; - -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; -import java.util.regex.Matcher; -import java.util.regex.Pattern; - -/** - * Provides utility methods for working with ref URLs. - */ -public class Ref { - - private static List patterns = new ArrayList(Arrays.asList( - - //dynatype collection ref (/portfolioitem/feature/1234 - Pattern.compile(".*?/(\\w{2,}/\\w+)/(\\d+/\\w+)(?:\\.js\\??.*)*$"), - - //dynatype ref (/portfolioitem/feature/1234 - Pattern.compile(".*?/(\\w{2,}/\\w+)/(\\d+)(?:\\.js\\??.*)*$"), - - //collection ref (/defect/1234/tasks) - Pattern.compile(".*?/(\\w+/-?\\d+)/(\\w+)(?:\\.js\\??.*)*$"), - - //basic ref (/defect/1234) - Pattern.compile(".*?/(\\w+)/(-?\\d+)(?:\\.js\\??.*)*$"), - - //permission ref (/workspacepermission/123u456w1) - 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) { - String test = ref != null ? ref : ""; - for(Pattern pattern : patterns) { - Matcher m = pattern.matcher(test); - if(m.matches()) { - return m; - } - } - return null; - } - - /** - * Determine whether the specified string is a valid ref url. - * - * @param ref the string to be tested. May be either absolute or relative, e.g. /defect/1234 - * - * @return whether the specified string is a valid ref url - */ - public static boolean isRef(String ref) { - return match(ref) != null; - } - - /** - * Create a relative ref url from the specified ref - * - * @param ref the ref url to be made relative - * - * @return the relative ref url or null if the specified ref was not valid - */ - public static String getRelativeRef(String ref) { - Matcher matcher = match(ref); - return matcher != null ? String.format("/%s/%s", matcher.group(1), matcher.group(2)) : null; - } - - /** - * Get the type from the specified ref url - * - * @param ref the ref url to extract the type from - * - * @return the extracted type or null if the specified ref was not valid - */ - public static String getTypeFromRef(String ref) { - Matcher matcher = match(ref); - return matcher != null ? matcher.group(1) : null; - } - - /** - * Get the ObjectID from the specified ref url - * - * @param ref the ref url to extract the ObjectID from - * - * @return the extracted ObjectID or null if the specified ref was not valid - */ - public static String getOidFromRef(String ref) { - Matcher matcher = match(ref); - return matcher != null ? matcher.group(2) : null; - } -} diff --git a/src/main/java/com/rallydev/rest/util/package-info.java b/src/main/java/com/rallydev/rest/util/package-info.java deleted file mode 100644 index 265c077..0000000 --- a/src/main/java/com/rallydev/rest/util/package-info.java +++ /dev/null @@ -1,4 +0,0 @@ -/** - * Provides utilities for working with the Rest API. - */ -package com.rallydev.rest.util; \ No newline at end of file diff --git a/src/main/resources/doc/com/rallydev/rest/CollectionAddExample.html b/src/main/resources/doc/com/rallydev/rest/CollectionAddExample.html deleted file mode 100644 index b2e95d8..0000000 --- a/src/main/resources/doc/com/rallydev/rest/CollectionAddExample.html +++ /dev/null @@ -1,261 +0,0 @@ - - - - - -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 deleted file mode 100644 index fb0971c..0000000 --- a/src/main/resources/doc/com/rallydev/rest/CollectionQueryExample.html +++ /dev/null @@ -1,261 +0,0 @@ - - - - - -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 deleted file mode 100644 index 0edcc04..0000000 --- a/src/main/resources/doc/com/rallydev/rest/CollectionSummaryExample.html +++ /dev/null @@ -1,261 +0,0 @@ - - - - - -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 deleted file mode 100644 index 94c9c7a..0000000 --- a/src/main/resources/doc/com/rallydev/rest/CrudExample.html +++ /dev/null @@ -1,261 +0,0 @@ - - - - - -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 deleted file mode 100644 index df7ba86..0000000 --- a/src/main/resources/doc/com/rallydev/rest/QueryExample.html +++ /dev/null @@ -1,261 +0,0 @@ - - - - - -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 deleted file mode 100644 index 3fe53db..0000000 --- a/src/main/resources/doc/com/rallydev/rest/RallyRestApi.html +++ /dev/null @@ -1,578 +0,0 @@ - - - - - -RallyRestApi (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    -
      -
    • Prev Class
      • -
    • Next Class
      • -
    - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest
    -

    Class RallyRestApi

    -
    -
    - -
    -
      -
    • -
      -
      All Implemented Interfaces:
      -
      Closeable, AutoCloseable
      -
      -
      -
      -
      public class RallyRestApi
-extends Object
-implements Closeable
      -

      The main interface to the Rest API.

      -

      Provides CRUD and query operations.

      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        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.
          -
          • -
        -
        • -
      - -
        -
      • - - -

        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.
          -
          • -
        - - - -
          -
        • -

          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"
          -
          • -
        - - - - - - - - - - - - - - - - - - - -
          -
        • -

          query

          -
          public QueryResponse query(QueryRequest request)
-                    throws IOException
          -
          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.
          -
          Parameters:
          request - the QueryRequest specifying the object to be created.
          -
          Returns:
          the resulting QueryResponse
          -
          Throws:
          -
          IOException - if an error occurs during the query.
          -
          • -
        - - - - - - - -
          -
        • -

          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
          -
          • -
        - - - -
          -
        • -

          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
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    -
      -
    • Prev Class
      • -
    • Next Class
      • -
    - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/RallyRestApiTest.html b/src/main/resources/doc/com/rallydev/rest/RallyRestApiTest.html deleted file mode 100644 index 46f65b1..0000000 --- a/src/main/resources/doc/com/rallydev/rest/RallyRestApiTest.html +++ /dev/null @@ -1,567 +0,0 @@ - - - - - -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 deleted file mode 100644 index f181a80..0000000 --- a/src/main/resources/doc/com/rallydev/rest/RestApiFactory.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - -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 deleted file mode 100644 index 5651ee3..0000000 --- a/src/main/resources/doc/com/rallydev/rest/class-use/CollectionAddExample.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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 deleted file mode 100644 index b8b2403..0000000 --- a/src/main/resources/doc/com/rallydev/rest/class-use/CollectionQueryExample.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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 deleted file mode 100644 index c7bf7fb..0000000 --- a/src/main/resources/doc/com/rallydev/rest/class-use/CollectionSummaryExample.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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 deleted file mode 100644 index d803248..0000000 --- a/src/main/resources/doc/com/rallydev/rest/class-use/CrudExample.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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 deleted file mode 100644 index 1e4de46..0000000 --- a/src/main/resources/doc/com/rallydev/rest/class-use/QueryExample.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/RallyRestApiTest.html b/src/main/resources/doc/com/rallydev/rest/class-use/RallyRestApiTest.html deleted file mode 100644 index a1044f6..0000000 --- a/src/main/resources/doc/com/rallydev/rest/class-use/RallyRestApiTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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 deleted file mode 100644 index bfece53..0000000 --- a/src/main/resources/doc/com/rallydev/rest/class-use/RestApiFactory.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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 deleted file mode 100644 index 2579642..0000000 --- a/src/main/resources/doc/com/rallydev/rest/client/ApiKeyClient.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - -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 deleted file mode 100644 index 5063ad9..0000000 --- a/src/main/resources/doc/com/rallydev/rest/client/ApiKeyClientTest.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - - -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 deleted file mode 100644 index 0c0a069..0000000 --- a/src/main/resources/doc/com/rallydev/rest/client/BasicAuthClient.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - -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 deleted file mode 100644 index 0195145..0000000 --- a/src/main/resources/doc/com/rallydev/rest/client/BasicAuthClientTest.html +++ /dev/null @@ -1,368 +0,0 @@ - - - - - -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 deleted file mode 100644 index be69a93..0000000 --- a/src/main/resources/doc/com/rallydev/rest/client/HttpClient.html +++ /dev/null @@ -1,520 +0,0 @@ - - - - - -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 deleted file mode 100644 index a5b7d0b..0000000 --- a/src/main/resources/doc/com/rallydev/rest/client/HttpClientTest.html +++ /dev/null @@ -1,490 +0,0 @@ - - - - - -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/ApiKeyClientTest.html b/src/main/resources/doc/com/rallydev/rest/client/class-use/ApiKeyClientTest.html deleted file mode 100644 index ebb0f60..0000000 --- a/src/main/resources/doc/com/rallydev/rest/client/class-use/ApiKeyClientTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/BasicAuthClientTest.html b/src/main/resources/doc/com/rallydev/rest/client/class-use/BasicAuthClientTest.html deleted file mode 100644 index 2321610..0000000 --- a/src/main/resources/doc/com/rallydev/rest/client/class-use/BasicAuthClientTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/HttpClientTest.html b/src/main/resources/doc/com/rallydev/rest/client/class-use/HttpClientTest.html deleted file mode 100644 index 333d33c..0000000 --- a/src/main/resources/doc/com/rallydev/rest/client/class-use/HttpClientTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/matchers/HttpRequestBodyMatcher.html b/src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestBodyMatcher.html deleted file mode 100644 index 0b9e6f7..0000000 --- a/src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestBodyMatcher.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - -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 deleted file mode 100644 index 6aa62c7..0000000 --- a/src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestHeaderMatcher.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - -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 deleted file mode 100644 index f487b9b..0000000 --- a/src/main/resources/doc/com/rallydev/rest/matchers/HttpRequestUrlMatcher.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - -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 deleted file mode 100644 index ea1d659..0000000 --- a/src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestBodyMatcher.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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 deleted file mode 100644 index 2d0bb15..0000000 --- a/src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestHeaderMatcher.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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 deleted file mode 100644 index ae5f943..0000000 --- a/src/main/resources/doc/com/rallydev/rest/matchers/class-use/HttpRequestUrlMatcher.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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 deleted file mode 100644 index 6b1481a..0000000 --- a/src/main/resources/doc/com/rallydev/rest/matchers/package-frame.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - -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 deleted file mode 100644 index 4ac1875..0000000 --- a/src/main/resources/doc/com/rallydev/rest/matchers/package-summary.html +++ /dev/null @@ -1,141 +0,0 @@ - - - - - -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 deleted file mode 100644 index 644229c..0000000 --- a/src/main/resources/doc/com/rallydev/rest/matchers/package-tree.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - -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 deleted file mode 100644 index e2746d6..0000000 --- a/src/main/resources/doc/com/rallydev/rest/matchers/package-use.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/request/CollectionUpdateRequest.html b/src/main/resources/doc/com/rallydev/rest/request/CollectionUpdateRequest.html deleted file mode 100644 index 2de673f..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/CollectionUpdateRequest.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - -CollectionUpdateRequest (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.request
    -

    Class CollectionUpdateRequest

    -
    -
    - -
    -
      -
    • -
      -
      -
      public class CollectionUpdateRequest
-extends Request
      -
      Represents a WSAPI request to update a collection.
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          CollectionUpdateRequest

          -
          public CollectionUpdateRequest(JsonObject collection,
-                       JsonArray items,
-                       boolean add)
          -
          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.
          -
          Parameters:
          collection - the collection to be updated
          items - the items to be added or removed
          add - true if adding, false if removing
          -
          • -
        - - - -
          -
        • -

          CollectionUpdateRequest

          -
          public CollectionUpdateRequest(String collectionRef,
-                       JsonArray items,
-                       boolean adding)
          -
          Create a new update request for the specified collection and values.
          -
          Parameters:
          collectionRef - the ref of the collection to be updated. May be absolute or relative, e.g. "/defect/12345/tags"
          items - the items to be added or removed
          adding - true if adding, false if removing
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          getBody

          -
          public String getBody()
          -
          Get the JSON encoded string representation of the object to be updated.
          -
          Returns:
          the JSON encoded object
          -
          • -
        - - - -
          -
        • -

          getFetch

          -
          public Fetch getFetch()
          -

          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).
          -
          Returns:
          the current list of fields.
          -
          • -
        - - - -
          -
        • -

          setFetch

          -
          public void setFetch(Fetch fetch)
          -
          Set the current list of fields to be returned on the updated object.
          -
          Parameters:
          fetch - the list of fields to be returned.
          -
          • -
        - - - -
          -
        • -

          toUrl

          -
          public String toUrl()
          -

          Convert this request into a url compatible with the WSAPI.

          - The current fetch and any other parameters will be included.
          -
          -
          Specified by:
          -
          toUrl in class Request
          -
          Returns:
          the url representing this request.
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/request/CollectionUpdateRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/CollectionUpdateRequestTest.html deleted file mode 100644 index 8fb683a..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/CollectionUpdateRequestTest.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - -CollectionUpdateRequestTest (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.request
    -

    Class CollectionUpdateRequestTest

    -
    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.rallydev.rest.request.CollectionUpdateRequestTest
        • -
      -
      • -
    -
    -
      -
    • -
      -
      -
      public class CollectionUpdateRequestTest
-extends Object
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          CollectionUpdateRequestTest

          -
          public CollectionUpdateRequestTest()
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          shouldCreateACorrectBody

          -
          public void shouldCreateACorrectBody()
          -
          • -
        - - - -
          -
        • -

          shouldConstructTheCorrectUrlForAdds

          -
          public void shouldConstructTheCorrectUrlForAdds()
          -
          • -
        - - - -
          -
        • -

          shouldConstructTheCorrectUrlForRemoves

          -
          public void shouldConstructTheCorrectUrlForRemoves()
          -
          • -
        - - - -
          -
        • -

          shouldConstructTheCorrectUrlWithExtraParam

          -
          public void shouldConstructTheCorrectUrlWithExtraParam()
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/request/CreateRequest.html b/src/main/resources/doc/com/rallydev/rest/request/CreateRequest.html deleted file mode 100644 index 20067c9..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/CreateRequest.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - -CreateRequest (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.request
    -

    Class CreateRequest

    -
    -
    - -
    -
      -
    • -
      -
      -
      public class CreateRequest
-extends Request
      -
      Represents a WSAPI request to create an object.
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          CreateRequest

          -
          public CreateRequest(String type,
-             JsonObject obj)
          -
          Create a new create request with the specified type and values.
          -
          Parameters:
          type - the WSAPI object type to be created, e.g. Defect
          obj - the JSON representation of the values of the object
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          getBody

          -
          public String getBody()
          -
          Get the JSON encoded string representation of the object to be created.
          -
          Returns:
          the JSON encoded object
          -
          • -
        - - - -
          -
        • -

          getFetch

          -
          public Fetch getFetch()
          -

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

          - By default only the underscore fields such as _ref will be returned in the response.
          -
          Returns:
          the current list of fields.
          -
          • -
        - - - -
          -
        • -

          setFetch

          -
          public void setFetch(Fetch fetch)
          -
          Set the current list of fields to be returned on the created object.
          -
          Parameters:
          fetch - the list of fields to be returned.
          -
          • -
        - - - -
          -
        • -

          toUrl

          -
          public String toUrl()
          -

          Convert this request into a url compatible with the WSAPI.

          - The current fetch and any other parameters will be included.
          -
          -
          Specified by:
          -
          toUrl in class Request
          -
          Returns:
          the url representing this request.
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/request/CreateRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/CreateRequestTest.html deleted file mode 100644 index 687b063..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/CreateRequestTest.html +++ /dev/null @@ -1,321 +0,0 @@ - - - - - -CreateRequestTest (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.request
    -

    Class CreateRequestTest

    -
    -
    - -
    -
      -
    • -
      -
      -
      public class CreateRequestTest
-extends Object
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          CreateRequestTest

          -
          public CreateRequestTest()
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          shouldCreateACorrectBody

          -
          public void shouldCreateACorrectBody()
          -
          • -
        - - - -
          -
        • -

          shouldCreateACorrectBodyWithNullFields

          -
          public void shouldCreateACorrectBodyWithNullFields()
          -
          • -
        - - - -
          -
        • -

          shouldConstructTheCorrectUrl

          -
          public void shouldConstructTheCorrectUrl()
          -
          • -
        - - - -
          -
        • -

          shouldConstructTheCorrectDefaultFetchUrl

          -
          public void shouldConstructTheCorrectDefaultFetchUrl()
          -
          • -
        - - - -
          -
        • -

          shouldConstructTheCorrectUrlWithExtraParam

          -
          public void shouldConstructTheCorrectUrlWithExtraParam()
          -
          • -
        - - - -
          -
        • -

          shouldEncodeParamsUsingUtf8

          -
          public void shouldEncodeParamsUsingUtf8()
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/request/DeleteRequest.html b/src/main/resources/doc/com/rallydev/rest/request/DeleteRequest.html deleted file mode 100644 index 639dafb..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/DeleteRequest.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - -DeleteRequest (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.request
    -

    Class DeleteRequest

    -
    -
    - -
    -
      -
    • -
      -
      -
      public class DeleteRequest
-extends Request
      -
      Represents a WSAPI request to delete an object.
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          DeleteRequest

          -
          public DeleteRequest(String ref)
          -
          Createa new delete request for the specified object.
          -
          Parameters:
          ref - the ref of the WSAPI object to be created. May be absolute or relative, e.g. "/defect/12345"
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          toUrl

          -
          public String toUrl()
          -

          Convert this request into a url compatible with the WSAPI.

          - Any parameters set will be included.
          -
          -
          Specified by:
          -
          toUrl in class Request
          -
          Returns:
          the url representing this request.
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/request/DeleteRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/DeleteRequestTest.html deleted file mode 100644 index 8957e89..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/DeleteRequestTest.html +++ /dev/null @@ -1,282 +0,0 @@ - - - - - -DeleteRequestTest (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.request
    -

    Class DeleteRequestTest

    -
    -
    - -
    -
      -
    • -
      -
      -
      public class DeleteRequestTest
-extends Object
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          DeleteRequestTest

          -
          public DeleteRequestTest()
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          shouldConstructCorrectUrlWithAbsoluteRef

          -
          public void shouldConstructCorrectUrlWithAbsoluteRef()
          -
          • -
        - - - -
          -
        • -

          shouldConstructCorrectUrlWithRelativeRef

          -
          public void shouldConstructCorrectUrlWithRelativeRef()
          -
          • -
        - - - -
          -
        • -

          shouldConstructCorrectUrlWithExtraParam

          -
          public void shouldConstructCorrectUrlWithExtraParam()
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/request/GetRequest.html b/src/main/resources/doc/com/rallydev/rest/request/GetRequest.html deleted file mode 100644 index 84c4814..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/GetRequest.html +++ /dev/null @@ -1,317 +0,0 @@ - - - - - -GetRequest (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.request
    -

    Class GetRequest

    -
    -
    - -
    -
      -
    • -
      -
      -
      public class GetRequest
-extends Request
      -
      Represents a WSAPI request to retrieve a specific object.
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          GetRequest

          -
          public GetRequest(String ref)
          -
          Create a new get request for the specified object.
          -
          Parameters:
          ref - the ref of the WSAPI object to be retrieved. May be absolute or relative, e.g. "/defect/12345" - May also be "/user" or "/subscription" to get the current instances
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          getFetch

          -
          public Fetch getFetch()
          -

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

          - By default all fields will be returned in the response (fetch=true).
          -
          Returns:
          the current list of fields.
          -
          • -
        - - - -
          -
        • -

          setFetch

          -
          public void setFetch(Fetch fetch)
          -
          Set the current list of fields to be returned on the retrieved object.
          -
          Parameters:
          fetch - the list of fields to be returned.
          -
          • -
        - - - -
          -
        • -

          toUrl

          -
          public String toUrl()
          -

          Convert this request into a url compatible with the WSAPI.

          - The current fetch and any other parameters will be included.
          -
          -
          Specified by:
          -
          toUrl in class Request
          -
          Returns:
          the url representing this request.
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/request/GetRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/GetRequestTest.html deleted file mode 100644 index 7dea863..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/GetRequestTest.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - -GetRequestTest (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.request
    -

    Class GetRequestTest

    -
    -
    - -
    -
      -
    • -
      -
      -
      public class GetRequestTest
-extends Object
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          GetRequestTest

          -
          public GetRequestTest()
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          shouldReturnCorrectUrlWithAbsoluteRef

          -
          public void shouldReturnCorrectUrlWithAbsoluteRef()
          -
          • -
        - - - -
          -
        • -

          shouldReturnCorrectUrlWithRelativeRef

          -
          public void shouldReturnCorrectUrlWithRelativeRef()
          -
          • -
        - - - -
          -
        • -

          shouldReturnCorrectUrlWithFetchParams

          -
          public void shouldReturnCorrectUrlWithFetchParams()
          -
          • -
        - - - -
          -
        • -

          shouldReturnCorrectUrlForUser

          -
          public void shouldReturnCorrectUrlForUser()
          -
          • -
        - - - -
          -
        • -

          shouldReturnCorrectUrlForSubscription

          -
          public void shouldReturnCorrectUrlForSubscription()
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/request/QueryRequest.html b/src/main/resources/doc/com/rallydev/rest/request/QueryRequest.html deleted file mode 100644 index 9c1a0d4..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/QueryRequest.html +++ /dev/null @@ -1,673 +0,0 @@ - - - - - -QueryRequest (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.request
    -

    Class QueryRequest

    -
    -
    - -
    -
      -
    • -
      -
      All Implemented Interfaces:
      -
      Cloneable
      -
      -
      -
      -
      public class QueryRequest
-extends Request
-implements Cloneable
      -
      Represents a WSAPI request to retrieve all objects matching specified criteria.
      -
      • -
    -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Summary

        - - - - - - - - - - - -
        Constructors 
        Constructor and Description
        QueryRequest(JsonObject collection) -
        Create a new query request for the specified collection.
        -
        QueryRequest(String type) -
        Create a new query request for the specified type.
        -
        -
        • -
      - -
        -
      • - - -

        Method Summary

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        Methods 
        Modifier and TypeMethod and Description
        QueryRequestclone() -
        Clone this request.
        -
        FetchgetFetch() -
        Get the current list of fields to be returned on the matching objects.
        -
        intgetLimit() -
        Get the maximum number of records to be returned from the query.
        -
        StringgetOrder() -
        Set the order by which the result set will be sorted.
        -
        intgetPageSize() -
        Get the page size of the result set.
        -
        StringgetProject() -
        Get the project which the result set should be scoped to.
        -
        QueryFiltergetQueryFilter() -
        Get the filter by which the result set will be narrowed down.
        -
        intgetStart() -
        Get the start index of the result set.
        -
        StringgetWorkspace() -
        Get the workspace which the result set should be scoped to.
        -
        booleanisScopedDown() -
        If a project has been specified, get whether to include matching objects in child projects in the result set.
        -
        booleanisScopedUp() -
        If a project has been specified, get whether to include matching objects in parent projects in the result set.
        -
        voidsetFetch(Fetch fetch) -
        Set the current list of fields to be returned on the matching objects.
        -
        voidsetLimit(int limit) -
        Set the maximum number of records to be returned from the query.
        -
        voidsetOrder(String order) -
        Get the order by which the result set will be sorted.
        -
        voidsetPageSize(int pageSize) -
        Set the page size of the result set.
        -
        voidsetProject(String projectRef) -
        Specify the project which the result set should be scoped to.
        -
        voidsetQueryFilter(QueryFilter queryFilter) -
        Set a filter by which the result set will be narrowed down.
        -
        voidsetScopedDown(boolean scopeDown) -
        If a project has been specified, set whether to include matching objects in child projects in the result set.
        -
        voidsetScopedUp(boolean scopeUp) -
        If a project has been specified, set whether to include matching objects in parent projects in the result set.
        -
        voidsetStart(int start) -
        Set the 1-based start index of the result set.
        -
        voidsetWorkspace(String workspaceRef) -
        Specify the workspace which the result set should be scoped to.
        -
        StringtoUrl() -
        Convert this request into a url compatible with the WSAPI.
        -
        - - -
        • -
      -
      • -
    -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          QueryRequest

          -
          public QueryRequest(String type)
          -
          Create a new query request for the specified type.
          -
          Parameters:
          type - The WSAPI type to be queried, e.g. Defect
          -
          • -
        - - - -
          -
        • -

          QueryRequest

          -
          public QueryRequest(JsonObject collection)
          -
          Create a new query request for the specified collection. - Only supported in WSAPI v2.0 and above.
          -
          Parameters:
          collection - The collection to query. Should have a _ref property.
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          getQueryFilter

          -
          public QueryFilter getQueryFilter()
          -
          Get the filter by which the result set will be narrowed down.
          -
          Returns:
          the filter
          -
          • -
        - - - -
          -
        • -

          setQueryFilter

          -
          public void setQueryFilter(QueryFilter queryFilter)
          -
          Set a filter by which the result set will be narrowed down.
          -
          Parameters:
          queryFilter - the filter
          -
          • -
        - - - -
          -
        • -

          getOrder

          -
          public String getOrder()
          -
          Set the order by which the result set will be sorted. -

          The default is ObjectID ASC.

          -
          Returns:
          the order
          -
          • -
        - - - -
          -
        • -

          setOrder

          -
          public void setOrder(String order)
          -
          Get the order by which the result set will be sorted.
          -
          Parameters:
          order - the order
          -
          • -
        - - - -
          -
        • -

          getWorkspace

          -
          public String getWorkspace()
          -
          Get the workspace which the result set should be scoped to.
          -
          Returns:
          the project
          -
          • -
        - - - -
          -
        • -

          setWorkspace

          -
          public void setWorkspace(String workspaceRef)
          -

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

          - The default is the user's default workspace.
          -
          Parameters:
          workspaceRef - the ref of the workspace to scope to. May be an absolute or relative ref, e.g. /workspace/1234
          -
          • -
        - - - -
          -
        • -

          getProject

          -
          public String getProject()
          -
          Get the project which the result set should be scoped to.
          -
          Returns:
          the project
          -
          • -
        - - - -
          -
        • -

          setProject

          -
          public void setProject(String projectRef)
          -

          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.
          -
          Parameters:
          projectRef - the ref of the project to scope to. May be null or an absolute or relative ref, e.g. /project/1234
          -
          • -
        - - - -
          -
        • -

          isScopedUp

          -
          public boolean isScopedUp()
          -
          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.
          -
          • -
        - - - -
          -
        • -

          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.
          -
          Parameters:
          scopeUp - whether to include matching objects in parent projects
          -
          • -
        - - - -
          -
        • -

          isScopedDown

          -
          public boolean isScopedDown()
          -
          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.
          -
          • -
        - - - -
          -
        • -

          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.
          -
          Parameters:
          scopeDown - whether to include matching objects in child projects
          -
          • -
        - - - -
          -
        • -

          getStart

          -
          public int getStart()
          -
          Get the start index of the result set.
          -
          Returns:
          the start index
          -
          • -
        - - - -
          -
        • -

          setStart

          -
          public void setStart(int start)
          -
          Set the 1-based start index of the result set. - The default is 1.
          -
          Parameters:
          start - the start index
          -
          • -
        - - - -
          -
        • -

          getFetch

          -
          public Fetch getFetch()
          -

          Get the current list of fields to be returned on the matching objects.

          - By default all fields will be returned in the response (fetch=true).
          -
          Returns:
          the current list of fields.
          -
          • -
        - - - -
          -
        • -

          setFetch

          -
          public void setFetch(Fetch fetch)
          -
          Set the current list of fields to be returned on the matching objects.
          -
          Parameters:
          fetch - the list of fields to be returned.
          -
          • -
        - - - -
          -
        • -

          getPageSize

          -
          public int getPageSize()
          -
          Get the page size of the result set.
          -
          Returns:
          the page size
          -
          • -
        - - - -
          -
        • -

          setPageSize

          -
          public void setPageSize(int pageSize)
          -

          Set the page size of the result set.

          - The default is 200.
          -
          Parameters:
          pageSize - the new page size. Must be between 1 and 200 inclusive.
          -
          • -
        - - - -
          -
        • -

          getLimit

          -
          public int getLimit()
          -
          Get the maximum number of records to be returned from the query.
          -
          Returns:
          the maximum number of records
          -
          • -
        - - - -
          -
        • -

          setLimit

          -
          public void setLimit(int limit)
          -

          Set the maximum number of records to be returned from the query.

          - If not set only one page of data will be returned by RallyRestApi.query(com.rallydev.rest.request.QueryRequest)
          -
          Parameters:
          limit - the maximum number of records to be returned
          -
          • -
        - - - -
          -
        • -

          clone

          -
          public QueryRequest clone()
          -
          Clone this request.
          -
          -
          Overrides:
          -
          clone in class Object
          -
          Returns:
          the cloned instance of this request.
          -
          • -
        - - - -
          -
        • -

          toUrl

          -
          public String toUrl()
          -

          Convert this request into a url compatible with the WSAPI.

          - The current criteria set on this request and any other parameters will be included.
          -
          -
          Specified by:
          -
          toUrl in class Request
          -
          Returns:
          the url representing this request.
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/request/QueryRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/QueryRequestTest.html deleted file mode 100644 index a04fc4a..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/QueryRequestTest.html +++ /dev/null @@ -1,451 +0,0 @@ - - - - - -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 deleted file mode 100644 index e44dc85..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/Request.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - -Request (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.request
    -

    Class Request

    -
    -
    - -
    - -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          Request

          -
          public Request()
          -
          Create a new request.
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          getParams

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

          setParams

          -
          public void setParams(List<NameValuePair> params)
          -
          Set the list of additional parameters included in this request.
          -
          Parameters:
          params - The list of additional parameters
          -
          • -
        - - - -
          -
        • -

          addParam

          -
          public void addParam(String name,
-            String value)
          -
          Add the specified parameter to this request.
          -
          Parameters:
          name - the parameter name
          value - the parameter value
          -
          • -
        - - - -
          -
        • -

          getGsonBuilder

          -
          public GsonBuilder getGsonBuilder()
          -
          Get the Gson Builder used for JSON serialization in this request.
          -
          Returns:
          The Gson Builder used for JSON serialization
          -
          • -
        - - - -
          -
        • -

          setGsonBuilder

          -
          public void setGsonBuilder(GsonBuilder gsonBuilder)
          -
          Set the Gson Builder used for JSON serialization in this request.
          -
          Parameters:
          gsonBuilder - The Gson Builder used for JSON serialization
          -
          • -
        - - - -
          -
        • -

          toUrl

          -
          public abstract String toUrl()
          -

          Convert this request into a url compatible with the WSAPI.

          - Must be implemented by subclasses.
          -
          Returns:
          the url representing this request.
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/request/RequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/RequestTest.html deleted file mode 100644 index ba0ccc0..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/RequestTest.html +++ /dev/null @@ -1,282 +0,0 @@ - - - - - -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 deleted file mode 100644 index e200940..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/UpdateRequest.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - -UpdateRequest (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.request
    -

    Class UpdateRequest

    -
    -
    - -
    -
      -
    • -
      -
      -
      public class UpdateRequest
-extends Request
      -
      Represents a WSAPI request to update an object.
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          UpdateRequest

          -
          public UpdateRequest(String ref,
-             JsonObject obj)
          -
          Create a new update request for the specified object and values.
          -
          Parameters:
          ref - the ref of the WSAPI object to be created. May be absolute or relative, e.g. "/defect/12345"
          obj - the JSON representation of the values of the object
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          getBody

          -
          public String getBody()
          -
          Get the JSON encoded string representation of the object to be updated.
          -
          Returns:
          the JSON encoded object
          -
          • -
        - - - -
          -
        • -

          getFetch

          -
          public Fetch getFetch()
          -

          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).
          -
          Returns:
          the current list of fields.
          -
          • -
        - - - -
          -
        • -

          setFetch

          -
          public void setFetch(Fetch fetch)
          -
          Set the current list of fields to be returned on the updated object.
          -
          Parameters:
          fetch - the list of fields to be returned.
          -
          • -
        - - - -
          -
        • -

          toUrl

          -
          public String toUrl()
          -

          Convert this request into a url compatible with the WSAPI.

          - The current fetch and any other parameters will be included.
          -
          -
          Specified by:
          -
          toUrl in class Request
          -
          Returns:
          the url representing this request.
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/request/UpdateRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/UpdateRequestTest.html deleted file mode 100644 index e3b1a94..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/UpdateRequestTest.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - -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/CollectionUpdateRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/CollectionUpdateRequestTest.html deleted file mode 100644 index 88c7a95..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/CollectionUpdateRequestTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/CreateRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/CreateRequestTest.html deleted file mode 100644 index 73adbf2..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/CreateRequestTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/DeleteRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/DeleteRequestTest.html deleted file mode 100644 index 7b46d2b..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/DeleteRequestTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/GetRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/GetRequestTest.html deleted file mode 100644 index de16a8e..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/GetRequestTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/QueryRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/QueryRequestTest.html deleted file mode 100644 index 042b2a5..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/QueryRequestTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/RequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/RequestTest.html deleted file mode 100644 index a15c491..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/RequestTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/UpdateRequestTest.html b/src/main/resources/doc/com/rallydev/rest/request/class-use/UpdateRequestTest.html deleted file mode 100644 index 6098124..0000000 --- a/src/main/resources/doc/com/rallydev/rest/request/class-use/UpdateRequestTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/response/CollectionUpdateResponse.html b/src/main/resources/doc/com/rallydev/rest/response/CollectionUpdateResponse.html deleted file mode 100644 index 43bc7e4..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/CollectionUpdateResponse.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - -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 deleted file mode 100644 index b8ad46c..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/CollectionUpdateResponseTest.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - -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 deleted file mode 100644 index c8d3bf0..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/CreateResponse.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - -CreateResponse (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.response
    -

    Class CreateResponse

    -
    -
    - -
    -
      -
    • -
      -
      -
      public class CreateResponse
-extends Response
      -
      Represents a WSAPI response from creating an object
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          CreateResponse

          -
          public CreateResponse(String createResponse)
          -
          Create a new create response from the specified JSON encoded string.
          -
          Parameters:
          createResponse - the JSON encoded string
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          getObject

          -
          public JsonObject getObject()
          -
          Get the created object. -

          Returns null if the operation was not successful

          -
          Returns:
          the created object
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/response/CreateResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/CreateResponseTest.html deleted file mode 100644 index 1ba7a2c..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/CreateResponseTest.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - -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 deleted file mode 100644 index e01c4c7..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/DeleteResponse.html +++ /dev/null @@ -1,245 +0,0 @@ - - - - - -DeleteResponse (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    -
      -
    • Detail: 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    -
    - - -
    - - -
    -
    com.rallydev.rest.response
    -

    Class DeleteResponse

    -
    -
    - -
    -
      -
    • -
      -
      -
      public class DeleteResponse
-extends Response
      -
      Represents a WSAPI response from deleting an object
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          DeleteResponse

          -
          public DeleteResponse(String deleteResponse)
          -
          Create a new delete response from the specified JSON encoded string.
          -
          Parameters:
          deleteResponse - the JSON encoded string
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    -
      -
    • Detail: 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/response/DeleteResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/DeleteResponseTest.html deleted file mode 100644 index 6f1d878..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/DeleteResponseTest.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - -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 deleted file mode 100644 index 19787b5..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/GetResponse.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - -GetResponse (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.response
    -

    Class GetResponse

    -
    -
    - -
    -
      -
    • -
      -
      -
      public class GetResponse
-extends Response
      -
      Represents a WSAPI response from retrieving a single object.
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          GetResponse

          -
          public GetResponse(String getResponse)
          -
          Create a new get response from the specified JSON encoded string.
          -
          Parameters:
          getResponse - the JSON encoded string
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          getObject

          -
          public JsonObject getObject()
          -
          Get the retrieved object. -

          Returns null if the operation was not successful

          -
          Returns:
          the retrieved object
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/response/GetResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/GetResponseTest.html deleted file mode 100644 index a871147..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/GetResponseTest.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - -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 deleted file mode 100644 index 135ebf4..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/QueryResponse.html +++ /dev/null @@ -1,329 +0,0 @@ - - - - - -QueryResponse (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.response
    -

    Class QueryResponse

    -
    -
    - -
    -
      -
    • -
      -
      -
      public class QueryResponse
-extends Response
      -
      Represents a WSAPI response from querying for objects.
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          QueryResponse

          -
          public QueryResponse(String queryResponse)
          -
          Create a new query response from the specified JSON encoded string.
          -
          Parameters:
          queryResponse - the JSON encoded string
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          getTotalResultCount

          -
          public int getTotalResultCount()
          -
          Get the total number of objects that matched the query
          -
          Returns:
          the total number of objects
          -
          • -
        - - - -
          -
        • -

          getResults

          -
          public JsonArray getResults()
          -
          Get the results of the query -

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

          -
          Returns:
          the results
          -
          • -
        - - - -
          -
        • -

          getPageSize

          -
          public int getPageSize()
          -
          Get the page size of the results
          -
          Returns:
          the page size
          -
          • -
        - - - -
          -
        • -

          getStart

          -
          public int getStart()
          -
          Get the start index of the results
          -
          Returns:
          the start index
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/response/QueryResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/QueryResponseTest.html deleted file mode 100644 index 5044d45..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/QueryResponseTest.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - -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 deleted file mode 100644 index 5a0ac38..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/Response.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - -Response (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.response
    -

    Class Response

    -
    -
    - -
    - -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          Response

          -
          public Response(String response)
          -
          Create a new response from the specified JSON encoded string.
          -
          Parameters:
          response - the JSON encoded string
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          wasSuccessful

          -
          public boolean wasSuccessful()
          -
          Returns whether the response was successful (no errors)
          -
          Returns:
          whether the response was successful
          -
          • -
        - - - -
          -
        • -

          getErrors

          -
          public String[] getErrors()
          -
          Get any errors returned in the response.
          -
          Returns:
          the response errors
          -
          • -
        - - - -
          -
        • -

          getWarnings

          -
          public String[] getWarnings()
          -
          Get any warnings returned in the response.
          -
          Returns:
          the response warnings
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/response/ResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/ResponseTest.html deleted file mode 100644 index d0be7b3..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/ResponseTest.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - -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 deleted file mode 100644 index 6650fc1..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/UpdateResponse.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - -UpdateResponse (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.response
    -

    Class UpdateResponse

    -
    -
    - -
    -
      -
    • -
      -
      -
      public class UpdateResponse
-extends Response
      -
      Represents a WSAPI response from updating an object.
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          UpdateResponse

          -
          public UpdateResponse(String updateResponse)
          -
          Create a new update response from the specified JSON encoded string.
          -
          Parameters:
          updateResponse - the JSON encoded string
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          getObject

          -
          public JsonObject getObject()
          -
          Get the updated object. -

          Returns null if the operation was not successful

          -
          Returns:
          the updated object
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/response/UpdateResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/UpdateResponseTest.html deleted file mode 100644 index e215bc8..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/UpdateResponseTest.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - -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/CollectionUpdateResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/CollectionUpdateResponseTest.html deleted file mode 100644 index 4d94984..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/CollectionUpdateResponseTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/CreateResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/CreateResponseTest.html deleted file mode 100644 index af0035f..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/CreateResponseTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/DeleteResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/DeleteResponseTest.html deleted file mode 100644 index 9f4b573..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/DeleteResponseTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/GetResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/GetResponseTest.html deleted file mode 100644 index 92a4655..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/GetResponseTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/QueryResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/QueryResponseTest.html deleted file mode 100644 index a540259..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/QueryResponseTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/ResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/ResponseTest.html deleted file mode 100644 index eec3088..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/ResponseTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/UpdateResponseTest.html b/src/main/resources/doc/com/rallydev/rest/response/class-use/UpdateResponseTest.html deleted file mode 100644 index 1efc3e7..0000000 --- a/src/main/resources/doc/com/rallydev/rest/response/class-use/UpdateResponseTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/util/Fetch.html b/src/main/resources/doc/com/rallydev/rest/util/Fetch.html deleted file mode 100644 index 663f2cf..0000000 --- a/src/main/resources/doc/com/rallydev/rest/util/Fetch.html +++ /dev/null @@ -1,317 +0,0 @@ - - - - - -Fetch (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.util
    -

    Class Fetch

    -
    -
    - -
    - -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          Fetch

          -
          public Fetch(String... fetch)
          -
          Create a new fetch with the specified fields.
          -
          Parameters:
          fetch - one or more fields to be returned
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          toString

          -
          public String toString()
          -
          Get the comma separated list of fields to be returned. - If the list is empty true will be returned.
          -
          -
          Overrides:
          -
          toString in class AbstractCollection<String>
          -
          Returns:
          the comma separated list of fields to be returned
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/util/FetchTest.html b/src/main/resources/doc/com/rallydev/rest/util/FetchTest.html deleted file mode 100644 index 7e4f516..0000000 --- a/src/main/resources/doc/com/rallydev/rest/util/FetchTest.html +++ /dev/null @@ -1,282 +0,0 @@ - - - - - -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 deleted file mode 100644 index 66a585b..0000000 --- a/src/main/resources/doc/com/rallydev/rest/util/InvalidURLException.html +++ /dev/null @@ -1,255 +0,0 @@ - - - - - -InvalidURLException (Rally Rest API for Java 2.0) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    -
      -
    • Detail: 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    -
    - - -
    - - -
    -
    com.rallydev.rest.util
    -

    Class InvalidURLException

    -
    -
    - -
    - -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          InvalidURLException

          -
          public InvalidURLException(String msg)
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    -
      -
    • Detail: 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/util/QueryFilter.html b/src/main/resources/doc/com/rallydev/rest/util/QueryFilter.html deleted file mode 100644 index 8105a65..0000000 --- a/src/main/resources/doc/com/rallydev/rest/util/QueryFilter.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - -QueryFilter (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.util
    -

    Class QueryFilter

    -
    -
    - -
    -
      -
    • -
      -
      All Implemented Interfaces:
      -
      Cloneable
      -
      -
      -
      -
      public class QueryFilter
-extends Object
-implements Cloneable
      -
      Represents a query filter to be applied to query requests. -

      More on the WSAPI query syntax can be found here: http://rally1.rallydev.com/slm/doc/webservice

      -
      • -
    -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Summary

        - - - - - - - - -
        Constructors 
        Constructor and Description
        QueryFilter(String field, - String operator, - String value) -
        Create a new query filter with the specified options.
        -
        -
        • -
      - - -
      • -
    -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          QueryFilter

          -
          public QueryFilter(String field,
-           String operator,
-           String value)
          -
          Create a new query filter with the specified options.
          -
          Parameters:
          field - the object field to evaluate
          operator - the operator to use for evaluation
          value - the value to be evaluated
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          and

          -
          public QueryFilter and(QueryFilter q)
          -
          Get a query filter that is the ANDed combination of this filter and the specified one.
          -
          Parameters:
          q - the filter to be ANDed
          -
          Returns:
          the ANDed query filter
          -
          • -
        - - - -
          -
        • -

          or

          -
          public QueryFilter or(QueryFilter q)
          -
          Get a query filter that is the ORed combination of this filter and the specified one.
          -
          Parameters:
          q - the filter to be ORed
          -
          Returns:
          the ORed query filter
          -
          • -
        - - - -
          -
        • -

          toString

          -
          public String toString()
          -
          Get the string representation of this query filter. -

          Examples:

          -
            -
          • (ScheduleState = Accepted)
            • -
          • ((ScheduleState = Accepted) AND (Iteration.Name = "My Iteration"))
            • -
          -
          -
          Overrides:
          -
          toString in class Object
          -
          Returns:
          the string representation of this query filter.
          -
          • -
        - - - -
          -
        • -

          and

          -
          public static QueryFilter and(QueryFilter... queryFilters)
          -
          Get a query filter that is the ANDed combination of the specified filters.
          -
          Parameters:
          queryFilters - one or more query filters to be ANDed together
          -
          Returns:
          the ANDed query filter
          -
          • -
        - - - -
          -
        • -

          or

          -
          public static QueryFilter or(QueryFilter... queryFilters)
          -
          Get a query filter that is the ORed combination of the specified filters.
          -
          Parameters:
          queryFilters - one or more query filters to be ORed together
          -
          Returns:
          the ORed query filter
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/util/QueryFilterTest.html b/src/main/resources/doc/com/rallydev/rest/util/QueryFilterTest.html deleted file mode 100644 index 298197c..0000000 --- a/src/main/resources/doc/com/rallydev/rest/util/QueryFilterTest.html +++ /dev/null @@ -1,360 +0,0 @@ - - - - - -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 deleted file mode 100644 index 8af4b78..0000000 --- a/src/main/resources/doc/com/rallydev/rest/util/Ref.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - -Ref (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.rallydev.rest.util
    -

    Class Ref

    -
    -
    - -
    -
      -
    • -
      -
      -
      public class Ref
-extends Object
      -
      Provides utility methods for working with ref URLs.
      -
      • -
    -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          Ref

          -
          public Ref()
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          isRef

          -
          public static boolean isRef(String ref)
          -
          Determine whether the specified string is a valid ref url.
          -
          Parameters:
          ref - the string to be tested. May be either absolute or relative, e.g. /defect/1234
          -
          Returns:
          whether the specified string is a valid ref url
          -
          • -
        - - - -
          -
        • -

          getRelativeRef

          -
          public static String getRelativeRef(String ref)
          -
          Create a relative ref url from the specified ref
          -
          Parameters:
          ref - the ref url to be made relative
          -
          Returns:
          the relative ref url or null if the specified ref was not valid
          -
          • -
        - - - -
          -
        • -

          getTypeFromRef

          -
          public static String getTypeFromRef(String ref)
          -
          Get the type from the specified ref url
          -
          Parameters:
          ref - the ref url to extract the type from
          -
          Returns:
          the extracted type or null if the specified ref was not valid
          -
          • -
        - - - -
          -
        • -

          getOidFromRef

          -
          public static String getOidFromRef(String ref)
          -
          Get the ObjectID from the specified ref url
          -
          Parameters:
          ref - the ref url to extract the ObjectID from
          -
          Returns:
          the extracted ObjectID or null if the specified ref was not valid
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/com/rallydev/rest/util/RefTest.html b/src/main/resources/doc/com/rallydev/rest/util/RefTest.html deleted file mode 100644 index b92af81..0000000 --- a/src/main/resources/doc/com/rallydev/rest/util/RefTest.html +++ /dev/null @@ -1,451 +0,0 @@ - - - - - -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/FetchTest.html b/src/main/resources/doc/com/rallydev/rest/util/class-use/FetchTest.html deleted file mode 100644 index a2e9385..0000000 --- a/src/main/resources/doc/com/rallydev/rest/util/class-use/FetchTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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 deleted file mode 100644 index a535b87..0000000 --- a/src/main/resources/doc/com/rallydev/rest/util/class-use/InvalidURLException.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -Uses of Class com.rallydev.rest.util.InvalidURLException (Rally Rest API for Java 2.0) - - - - - - - -
    - - - - - -
    -
    -
      -
    • Prev
      • -
    • Next
      • -
    - - -
    - -
    - - -
    - -
    -

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

    -
    -
    No usage of com.rallydev.rest.util.InvalidURLException
    - -
    - - - - - -
    -
    -
      -
    • Prev
      • -
    • Next
      • -
    - - -
    - -
    - - -
    - - - 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 deleted file mode 100644 index 81cbeaf..0000000 --- a/src/main/resources/doc/com/rallydev/rest/util/class-use/QueryFilterTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/RefTest.html b/src/main/resources/doc/com/rallydev/rest/util/class-use/RefTest.html deleted file mode 100644 index 0fa1f85..0000000 --- a/src/main/resources/doc/com/rallydev/rest/util/class-use/RefTest.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -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/constant-values.html b/src/main/resources/doc/constant-values.html deleted file mode 100644 index 7cea976..0000000 --- a/src/main/resources/doc/constant-values.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -Constant Field Values (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    -
      -
    • Prev
      • -
    • Next
      • -
    - - -
    - -
    - - -
    - -
    -

    Constant Field Values

    -

    Contents

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

    A

    -
    -
    addParam(String, String) - Method in class com.rallydev.rest.request.Request
    -
    -
    Add the specified parameter to this request.
    -
    -
    and(QueryFilter) - Method in class com.rallydev.rest.util.QueryFilter
    -
    -
    Get a query filter that is the ANDed combination of this filter and the specified one.
    -
    -
    and(QueryFilter...) - Static method in class com.rallydev.rest.util.QueryFilter
    -
    -
    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 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 deleted file mode 100644 index 1e2159a..0000000 --- a/src/main/resources/doc/index-files/index-10.html +++ /dev/null @@ -1,150 +0,0 @@ - - - - - -Q-Index (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    - - -
    - -
    A B C D F G H I O Q R S T U W  - - -

    Q

    -
    -
    query(QueryRequest) - Method in class com.rallydev.rest.RallyRestApi
    -
    -
    Query for objects matching the specified request.
    -
    -
    QueryFilter - Class in com.rallydev.rest.util
    -
    -
    Represents a query filter to be applied to query requests.
    -
    -
    QueryFilter(String, String, String) - Constructor for class com.rallydev.rest.util.QueryFilter
    -
    -
    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.
    -
    -
    -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 deleted file mode 100644 index 8da52d0..0000000 --- a/src/main/resources/doc/index-files/index-11.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - -R-Index (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    - - -
    - -
    A B C D F G H I O Q R S T U W  - - -

    R

    -
    -
    RallyRestApi - Class in com.rallydev.rest
    -
    -
    The main interface to the Rest API.
    -
    -
    RallyRestApi(URI, String, String) - Constructor for class com.rallydev.rest.RallyRestApi
    -
    -
    Deprecated. -
    Use the api key constructor instead.
    -
    -
    -
    RallyRestApi(URI, String) - Constructor for class com.rallydev.rest.RallyRestApi
    -
    -
    Creates a new instance for the specified server using the specified API Key.
    -
    -
    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.
    -
    -
    -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 deleted file mode 100644 index 0b6de81..0000000 --- a/src/main/resources/doc/index-files/index-12.html +++ /dev/null @@ -1,230 +0,0 @@ - - - - - -S-Index (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    - - -
    - -
    A B C D F G H I O Q R S T U W  - - -

    S

    -
    -
    setApplicationName(String) - Method in class com.rallydev.rest.client.HttpClient
    -
    -
    Set the value of the X-RallyIntegrationName header included on all requests.
    -
    -
    setApplicationName(String) - Method in class com.rallydev.rest.RallyRestApi
    -
    -
    Set the value of the X-RallyIntegrationName header included on all requests.
    -
    -
    setApplicationVendor(String) - Method in class com.rallydev.rest.client.HttpClient
    -
    -
    Set the value of the X-RallyIntegrationVendor header included on all requests.
    -
    -
    setApplicationVendor(String) - Method in class com.rallydev.rest.RallyRestApi
    -
    -
    Set the value of the X-RallyIntegrationVendor header included on all requests.
    -
    -
    setApplicationVersion(String) - Method in class com.rallydev.rest.client.HttpClient
    -
    -
    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 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 deleted file mode 100644 index 4b55239..0000000 --- a/src/main/resources/doc/index-files/index-13.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - -T-Index (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    - - -
    - -
    A B C D F G H I O Q R S T U W  - - -

    T

    -
    -
    toString() - Method in class com.rallydev.rest.util.Fetch
    -
    -
    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 B C D F G H I O Q R S T U W 
    - -
    - - - - - -
    -
    - - - -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/index-files/index-14.html b/src/main/resources/doc/index-files/index-14.html deleted file mode 100644 index f6fa8aa..0000000 --- a/src/main/resources/doc/index-files/index-14.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - -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 deleted file mode 100644 index 199a2f1..0000000 --- a/src/main/resources/doc/index-files/index-15.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - -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 deleted file mode 100644 index 394260d..0000000 --- a/src/main/resources/doc/index-files/index-16.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - -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 deleted file mode 100644 index db6ee4e..0000000 --- a/src/main/resources/doc/index-files/index-2.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - -B-Index (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    - - -
    - -
    A B C D F G H I O Q R S T U W  - - -

    B

    -
    -
    BasicAuthClient - Class in com.rallydev.rest.client
    -
    -
    A HttpClient which authenticates using basic authentication (username/password).
    -
    -
    BasicAuthClient(URI, String, String) - Constructor for class com.rallydev.rest.client.BasicAuthClient
    -
    -
    Construct a new client.
    -
    -
    -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 deleted file mode 100644 index a646ab9..0000000 --- a/src/main/resources/doc/index-files/index-3.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - -C-Index (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    - - -
    - -
    A B C D F G H I O Q R S T U W  - - -

    C

    -
    -
    clone() - Method in class com.rallydev.rest.request.QueryRequest
    -
    -
    Clone this request.
    -
    -
    close() - Method in class com.rallydev.rest.client.HttpClient
    -
    -
    Release all resources associated with this instance.
    -
    -
    close() - Method in class com.rallydev.rest.RallyRestApi
    -
    -
    Release all resources associated with this instance.
    -
    -
    CollectionUpdateRequest - Class in com.rallydev.rest.request
    -
    -
    Represents a WSAPI request to update a collection.
    -
    -
    CollectionUpdateRequest(JsonObject, JsonArray, boolean) - Constructor for class com.rallydev.rest.request.CollectionUpdateRequest
    -
    -
    Create a new update request for the specified collection and values.
    -
    -
    CollectionUpdateRequest(String, JsonArray, boolean) - Constructor for class com.rallydev.rest.request.CollectionUpdateRequest
    -
    -
    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 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 deleted file mode 100644 index 240383b..0000000 --- a/src/main/resources/doc/index-files/index-4.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - -D-Index (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    - - -
    - -
    A B C D F G H I O Q R S T U W  - - -

    D

    -
    -
    delete(DeleteRequest) - Method in class com.rallydev.rest.RallyRestApi
    -
    -
    Delete the specified object.
    -
    -
    DeleteRequest - Class in com.rallydev.rest.request
    -
    -
    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 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 deleted file mode 100644 index 8bb31b2..0000000 --- a/src/main/resources/doc/index-files/index-5.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - -F-Index (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    - - -
    - -
    A B C D F G H I O Q R S T U W  - - -

    F

    -
    -
    Fetch - Class in com.rallydev.rest.util
    -
    -
    Represents a list of fields to be returned in responses from the WSAPI.
    -
    -
    Fetch(String...) - Constructor for class com.rallydev.rest.util.Fetch
    -
    -
    Create a new fetch with the specified fields.
    -
    -
    -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 deleted file mode 100644 index f29e8a1..0000000 --- a/src/main/resources/doc/index-files/index-6.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - -G-Index (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    - - -
    - -
    A B C D F G H I O Q R S T U W  - - -

    G

    -
    -
    get(GetRequest) - Method in class com.rallydev.rest.RallyRestApi
    -
    -
    Get the specified object.
    -
    -
    getBody() - Method in class com.rallydev.rest.request.CollectionUpdateRequest
    -
    -
    Get the JSON encoded string representation of the object to be updated.
    -
    -
    getBody() - Method in class com.rallydev.rest.request.CreateRequest
    -
    -
    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 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 deleted file mode 100644 index 75d60ce..0000000 --- a/src/main/resources/doc/index-files/index-7.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - -H-Index (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    - - -
    - -
    A B C D F G H I O Q R S T U W  - - -

    H

    -
    -
    HttpClient - Class in com.rallydev.rest.client
    -
    -
    A HttpClient implementation providing connectivity to Rally.
    -
    -
    -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 deleted file mode 100644 index 3d17aef..0000000 --- a/src/main/resources/doc/index-files/index-8.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - -I-Index (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    - - -
    - -
    A B C D F G H I O Q R S T U W  - - -

    I

    -
    -
    isRef(String) - Static method in class com.rallydev.rest.util.Ref
    -
    -
    Determine whether the specified string is a valid ref url.
    -
    -
    isScopedDown() - Method in class com.rallydev.rest.request.QueryRequest
    -
    -
    If a project has been specified, get whether to include matching objects in child projects in the result set.
    -
    -
    isScopedUp() - Method in class com.rallydev.rest.request.QueryRequest
    -
    -
    If a project has been specified, get whether to include matching objects in parent projects in the result set.
    -
    -
    -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 deleted file mode 100644 index dd6835e..0000000 --- a/src/main/resources/doc/index-files/index-9.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - -O-Index (Rally Rest API for Java 2.2) - - - - - - - -
    - - - - - -
    -
    - - - -
    - -
    - - -
    - -
    A B C D F G H I O Q R S T U W  - - -

    O

    -
    -
    or(QueryFilter) - Method in class com.rallydev.rest.util.QueryFilter
    -
    -
    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 B C D F G H I O Q R S T U W 
    - -
    - - - - - -
    -
    - - - -
    - -
    - - -
    - - - diff --git a/src/main/resources/doc/resources/background.gif b/src/main/resources/doc/resources/background.gif deleted file mode 100644 index f471940fde2f39ef8943a6af9569bcf986b1579b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2313 zcmV+k3HJ6!Nk%w1VKM-40OkMy00030|NlK(aXwsfKV5S}VtGJbbVOr%L0@%CZH88Q zl{{NzcR^uxNo<2iYk@pjY)*5FJz8x~bc{)B zfk z+1T6M-s9WdW8dcJ-wO*3@9+W*5AY543-j^$^!EPz_4eHZ2#>)41`h@dc!2OAgN6$a zCS2I?;lqgx6IR4nkpTe;1RN0f=zxMq2O=q`94V5d$&e>Unta)^<;;^G3>e7yp=ZvW z6DIW3xpSvaogXF?_4%`@(V;s}NR^5J!3hrtJV@1QRV&r5S*L!zYE|rss${iFkg&!? zTN5V#)~=bmMorwgZsEpdOE)iExo+FO-8;8Kga{=HbSQCnF=E6W3?o*|ID%uwi5**> zJXy127Y9m+=HQ|PhXWi+xNwoWv}n_%Pq%(e+H~mGqhq5kv4Mo|-n~g|7!F*xZ{xv< zCpXS~dGg^IGK?4@J-T%b(XnUHFul6n<@2&4)zzyO2) z3Q8`i0+UKY*`$}e9mmp;tg*))`|PsK1|hAo%u0K$vDwm4gaSkm0j{`26k#qAKmbuhxZ#cquDR>B zD{s8+&TH-uNg$C#68QG}1HMBHfrP&L@@w$F_!itRzXdCN@V|LDAu%3!IDtq1#1UV7 z#1RxvT=B(DWbCoU5l=ia$Pp`Hgb_?Mp@hmtxZDI2N-)v#$}PXVvdm1d>@v(v`0TUJ zF)Pu89(q`zv=w^nVTIF3@3BYIPA}c`(@ZCAwbNBEt@PDUKe5CTR8aB66IE1!w%Amt zy+jpcn~k>GZpVFg+H6x{_uOksvBlq0OyT$6TyQZ37k(cOxZr|JEx1sGm<(M9gH z-~PMqyn|tT=))UN`|-FFFUA#KToK0fUOaz=7}Z~KeHhVC&%O27cTfHQ^WBU8z4p&T zp#>D|V}XShTD;Hx745Iz{`>K-Z$A|7!*Boo{mY;G21vjH8t{M!OrQc6$iN0V@PQDF zpadsK!3tXNf*8!81~qnXWuHZ)kytd=_y+ADWvw31ouV;CdZ#ya*(l7-A-C-Y^+iit8O zBy3*`Ls$|5Hn4m_^I^|C7{m7EFn|5vTk;|oywIgCc9Bb*=L+Y$)M>9GC<|HGs@6NB zHLY%03!dDf=eDRt2O6lVSFRcsuWZEwU?=z$CZ0W?#VJfdN>HG(l%oKpyiftJc|Y)xkjSJYCrQal-0PC~()T9xwF!Jf zVi1UA#3BBbh(i8r5&v#Pz!cF41KjbCc?4u2@@Q~oKLirt2TM30;y6b+zyX2`Yl9u; z`0$3;v0-YUp&7NdPT#q`cZlbij$jvbRk6R>8g*>}*b9E+WDwmpHAAxYzyT aU_pX{M6b8i>#Dq3onfZy}_nli%!Q$ZV%e&!tN2 zX3B0NWXQ443Eo1rUP86rLU>O>oTp%wt3Z{Tz&P*)Iraq^_@X;RtUFY!JxH|4U!>kw zxXwqo&R3Y=EsXaR!ng@y+y$%L1P3FZ4@N!j3m5MW74HcC->_JFuvlxLXiI=-OQ2|@ zpGc#>2-aN)<1RE9^`bB0`65VSK2>5m>CHs^YZCC)NX*NfbeT1%)Cxpu2_(6cCbLvjLY`hf1%*q}QO*%V4SfOu5Nqg~`-+(-76= za<`RA&(qDB^S!nIS^od5|Nk$KPXD8(qSB!f`M*{E?A^&yOW$08V^iNPK!%UNJ-@xmz>`pG2_%4I3QWk4UdtwP!GH$C%mo2K|$Ap=_)Y!#O($1@ohsUtR1k%wI*) z4*X&g==oWh`j{uP=HFm;Ye>0>UbDdtSp^~MaQ!L9I#)Ga?q}{@T#|qec*FkMLDenm zj^sCgk!^O^3o|vG!~2$$$7`C#4Ry zdQ!tui+J1*HyavK+4{`r+zvYHj9IsRt~@uEBOreWS8~2rXAR3!|7aTdr+x4|>@$Az z)b1t$gSB~6USxpfLmy^|_J_eNt*PI=ScO1SVH895N#`ef%IOh&o-2GIjK1s-JzkyZ z@r7O%hChz}kMHCM@Wqi^R-9t&%Fh^#9dVB0%ej@$=OjXA%XZdzCXf}c>SW26_z-Te z5b{}XWg&rELM=N*%aimp)k04t2c+`WAS>ZFIPWKvtyOI))HzpRA!T!b{tv?4NzF1v zNlP%#{&p@lFFEKvcroMAsI)mq?&`!e%l+-y&j9ZqhN}oG&dB=Pw09r+Q%m0cMujS# zs$a7!9VH`CC7k{!bV(J`rm%Jpj6&nLtWhPcy$onn$8G#ZdD9hxO<9k67Ya>K_7W~3 z&KYf14fq<{qHA7u6;>AOcomhdg?ianjr9uINt}*7w?g%z9{Q`(qRo@hDwSpGmxz&h&>%G%T(URL~=c>C{>y$K?+wLFp zy*M1@FTUKYV>8DeDIAIKM+!T5c-k&C4?Y~y^E zQCIc-=9~DiPtfVZB=_c3`qH3h|NXd^BcOQG`funSe)i5!NoA_r{b6PwzSDIXG+!(F z9CqJgo&~#7^VZHWj{u23q+NDCHn}GeWDC*(SW%{f4WMtP3l2jsO7*M)EX)#NLlsNnU4q@#jn0r#rsWsf^ngE0&ambG1f;Rj zfOk#_>1|25Z%?iI{0Yv8)DQfk>m1td?~}m0N%^k^u%EuUCc#ItmlY|epQ3YLWehYw zRU0qpPb#X&WU*UOU8et(s8x~WyYWYsgJCF+;U6@*nICY8)dk}IG+(#_Bz8zURd3HZ6qPE68U1%S{wL0 z;K{PDw2iRFIGG?(UiE9kT9?siuv4O{ z`dX2-eiXU3N)H2nT4V=AO^~J}sw+gr{&~qx%$$wlMv_JCWAMfcjYl}*Cfcf!adOY8 z8oLmJ{%49e+nLiVo#H9}wRk?UCzDz^>9TDxreVHzl~R*)?YU>Uu;J2eQ27O5`&X^8 z`94{)YWJQa#l0Fbz0N6B>j&8J;<%VuG6OYM9&QIdtueWjI3X;*dEtGiF@1AcvN4U> zG5SXIEXxB>)!mtQOztJLyeF78S*kLiU-!>PtQ_s~OMl~&y(hVVe$A5 zwo}E-DJ6${QP75?LsQ}Wl@MXwXMT4d>|?rD!g?jE>J^N*y;X}5FLe%d0_ zZ>eIBK6l@jkfw{p_YiDP;MS{jww{%j#?rk2z1J!HqE;Vd!TrCl_7UPef8;edI}wD6 zT&12Bxj&q}d4%$GHq+$~UYtWv`wI9k`89oKkCEK_E;-+O)(rhThjOM|kXDn{!W1Lo z`_?yQv=lp=-w()R<=0&c5%RWHY_fw@qb}uwFuPAGkl~@Kis}eE%MY@~6ZyWcF+llM zGyK`)(vn1F%%z=W7-Y=1$`w0Mv+-|#d};%JjCmw)Y1hOxwA|{}P%6LS4X`jQCGh`mR@=hGrr|cXa^Ipj;Mh)6mTqd1s_HmP0IxXT!w7YhoIHT>Hm#!;c@|L9OjV zsTlHE{Z;HWeM9^tPm-`|&nnl$%DRtNG1~?npUvgKPwKlaccEe4q!7YU3zykJnu6Sr z()LMXs_)^~u-ds7+wMff)RAJF?2?1H`_wDnt%MssYeB5;q~ojgVm6OHA6B>FG2erv z8&`|6<`=!EPKR^8Qlp5MiKwfxy4D`mN> ze$RKh_6*YJd4y0nnUZvwN%iY&^9xk@cM|5g#pZkc#N*(PH?^w&?ilTDMXFcd0`5!E zvgHS`=Lc|~1aO=L@L~eE*aP{90lc7qXY7GOs)3JH14T{(`K1D%tpvUT1-?F^1d4_S zJ#7yXkP3Q37bJlRQfv=mV-J3B8O*m5B%L3uW)S>|Jwy`|s6iK`sv0Z-3NcU(0knrG z5ChFXA@A9PUSdLI+(VU!!J1Mbw!~0VP^jZci2X|Nx0BF!24ObrAr>b=QtlyN4TAhn z!mQncJm~^m4MIafVLt_ewDUtO+e5w*!`(6A&H^F7i9s4t5&uBpNvh$nlTZjqTM5krNRRQ zqP)VR!|9@H>7qN_!+-)&_9s!^;gOvy5s~iEB&qP8{77&2NJMzZcsnJgSt_bYDzYU% zxQ#uuk3D*e7_*d5^?HW(^(WxICGf-mcmM((VStzIz%zFsm0;ZI3h=5OciJ#a%7I(IeGbFv+PP^?^sKBPrRBl<+qK^o%3fi=L9`la>-l4~p|hzAl~W zf=%(|NHgF7r5dJD+Cf08q-c(m;Epsldaz4cqHzTHT>)4xEe(cE0i~tf{Y0xs_1~Kv z+BYQ-TpEOch13;5YC9nHYEXhSv{ew=LV~nQL%UBQEgaDL2m?9u~v zEQmOvM=aB)Z$+eE38rs%AZR_)4>@2raqwH#Fji#xoLc&PS_TU^W8W(M0GqLdO~1yF z{sfHZ_sC#FX58(}d>RSkKZCz8%D7{cC3Z$Zh@52{31&V*W-@s~Z<8~aBeNcNW?e&O zsR(7fHOf}B&fsRqdZ(WK1e~s*o^uD6{YX9QJvqyWAqQXt*E>r$V94YK=X@8+{1cg> z*_i`a%alCJvbD~lCg&Q1Gk=|BzY)sejf9EHJ{s7lu4?ExCWR3jgTiET;exy{sW!Mg zuj*_YOf0@ScN~X0$7V6&KpL172rf|rA8?K<2+GelXw)NUk#@b4aT5MO%1ip4*ym}B-JI__S1R?CK z<4eW~bH;@H@tR55x}&JNSw_NvEPk)6E>XDt7*)4sgWuw+_vNZzmaS(tsi(57zcjA9 z@~XcHtzYq~IX|z*Md9mh>W~`sk3<^s7;EmyH4wcTdAo5NkUA2ofeG69{Gx7#i_*lt zQ7;N@xEo#nNRj&SbDHNnP0w#OE0{DZ$~7ySG%IN~zwd5Vu4&dnH>*OMb>&*VL^tbA zG;7y1t9dsYU$p3pw0x6mwGe6fjBYWsZ8e3q8f~-~cefgHxBangajI$kv(c*W-DZGp zbM$UgnP{_MYPXYX|6$u^deIhE(-xuGX2RVXqS+o~(iSV%;ZW1=Zqkut(r&xak^pT> zsp*I@X|-eOd^gb+sM(%3(E$|c47Y91mTU99Xe;4vFOTl5gmwVB+fvc3n2pwK?~Xd# zwrY{?CUj@~Msr?wXU0WKv2A$hq z`$V^gNq4(<*C=;4e4}$*uIC$5&uUHkM08J~N$>VV*VpdmLCuc!?!J9=-)VH;fo9)| zNN4m#^Kb9|`RF!^ZAT-z=bC8$do8~Tjc^o-aQjyc2(TW*d50E1#NW0pKb^~tf&OUlS+W}>0!m@!~1 z&TdSLhm`0u99c-z=oxYL8IFaGCDoFwFUP!1iJ%xF1UC4hhv*VR2451Pc0+kQGC)39C5 za81oV=$+xzZNYhn=RB-CTZ>Bevj)A3mi9|OS(dcy=N#Zm=Dza|z4Jd<=3IQ2CB>FiwH7{4Ej#+oa>M67 z!56)Km&2xJ|H7B;%~rJDuJ{rbZQiaX*e^$DEt~T$#h9(y#jg6>uX?boq!N}Q;EQth zYo1rjc15dETPw~*Ymu=lreoE9g^wb)ZcRe1yp1(Eo(rmqUYZXOU$BC_| zX{{&qE?E06wXm#v#cpKwE)jaydSaI`TkCCClr_lKMzPkyFT!R%VRn&sZSrchKx&4e~pJQcfViQxxl=T=7}#gYz7Pvoh`T#Jbab%2A2m zxh?A<`}A?8_GumBEcL;$x%gQb@PZ(If%ZE~D?ax#Km4a~+GV~!;Bb~qxxh@HHc|H6 zr%$^c9Dw~UQFWJv+81rCXS1vqqLfQ~-BtO63xCArGVA4T-}xPXYGHqB5h^+n5%$24 z(BROpi13J@*qFfR$oRMHel`=(zy zovs-UKHD3VkJ?hVeq!aA+8Fh4+NIlFhcC~UrR{4I#}K*u&z%68+P1*=q0B1r*2MY> z!9gYs*vlTO5v#8S>c#3goFmp>3iVKdU)NkjNV(s7tO4Wq?2M}o5Cj-*7;S=fEshOA zR*4$dm{ROvUamG%xL_tSW6}U$Nl=@91T;nC11o-iIVyVrfkd) zTCp;^tOy|_kuOFV$Nn=$AQJO9;&sZ&eDs^!r*m;Hw!)vpO1vcfj2EV{dJ?7ap0tq6 z$SwUVM*Vt+MS_`;bas-svPV|3POQi8G~?f^KOx4hg1He+Wd*s3Hl1{TfJS-+zv6vc zPoKiwr?7wECbub(IdB)9f_!kmUjBR*KY_z4E8_QA9xSr#G&@i5y^H`jB^I{|akh>W z%Cn3luOVY|8P>u>e^~#{$kmgX&-q>k{#pFbm2({(rtG<%nb0UCQ0%{Cy`F&~7}*we z@Of>ND_)V&XwN_+n~KjVorUQWZ*B6cld7ymQl{;rwlHl34K#}2YWxE+4CX@P&u6AfCda`&ZT1MOY69e-L@gNcAvwx8%1Z7lB4zc=_Cpt~&s ze%?;){1DB(PSK!^za967qF?lIjB~&06}Lf`cgh2qUiI^|$-VCTNE=hp&Ij}^A9&|* zQQrSqo3gn#_=z9j(y6f@T|OkJYv(fjwpz}$*U$|nLH2F zPNMuTS4g8 z*^hOlRh6~Mk}58;d477R>F^~aLO$dOXmhA*6zwIaHK()t2zKjo?j^NOJbh_=+71xg zO{Mgp7x?Z-1MKzoQ<+V2g#|e}|JawOPJZBL{o~PYdtWDX?jl##!Aiq|w>)vGJLipp zBK1xGhcvgSsQ;rn>+`>UmxlID{<~}7{y>SO^cyktN^Fsz!Z|B4?p*RKQG*8}SYBt{ zuFO{vJ?jgL{gUzYsnv(io}c0vlCp#*1vE?}KL^UZ&VF^TK+D;40CxX%j);%dCt;Z{ zAeMXC9JPWvKGwsCxx4w2iv_wNGG8l16AVI93rmc^c1>r(P||YE zpXa+=-&k995hfykL^J5S&vJF^ljR&`FE#ppNMM3%Omc!F)Mn{{&Ip#)JegbEJxud2 zn`wDVB~DMii5|H%m~51YeU1juNG3!+&?*uC#q@)z8q~`4yEL5I8}PtyA1IZ=52P$x zX)KhZt z7czUXBsy-8d`GVQ`90`wIh(Xt7v5j7h0t&ET~2M!Tb~4rN-xtK@8@mB*c(6QTwOS- z%9445_WY|cfm4?$nX$72&{~^mu}an^x^Da%=UU6YI;ur3+9L6I>raW5!=-Nzy(F2Z zwZlg7aM3NN5b{K|FB>s4R}|&Lr32_Ys{wwkECxo|rV@;5aHB25iUs7(6@dDpjN{Y%?C~UGp>*Q}K?)KKk64 zAn;@-dER}QG0L${jQ1cR75eM3-~ZTltTQ8%sm9x4Y`ve@ekMuvpA#Rh51@s6;6^&Q z!&M7^b%cea7FlZkPV9}@!bPBBfB&~XvGlE2T7V?IpM~OBmuK;OSt{~N`rL5c_I^de z9n*=@p|l;d`b_YIn8Aem1t7pp0=2-MCTIcJHlY z6x+mNLgi{JpwP)y(yzAFL2A#>bI&EwZE`PGvd*FQ!rx~6bUN&+Ij3)L;=595L#G;m8*^e?ap1`J5w7-q)*iUT_W9w8 z&xS-`i++HpWzY-a-)CWd0(pLW$A85P{Dy9r-=uPekNpN^yA}pJ7yWTZ>3iw4d6+IK zF%1XXkGcJm{0*vhSG5R1ySW;jctk9O==1-Mk?=Bl<{HE1p_@tx1s^+GoczYxj#B=i=kwQvEPrOt`<4W*pJw zbNjEqpr7B|Llc%m{V*QssV)im;pb00LUob=yFaU4`P_}ywU zt*QZl-bUsmh@L&zQaX4uHL&7YD(BOb9hH;;y;O-b-_O$4EFi1vCrMlz`dN|u?}HNO^aFQV{UZg_yy%nf>IXpulip!cR8|vNu7P*; zQye@}Qmj%(TB6`5E=c~w=LITF266XJ6X5xA7!OM1SE=~N*o3EP5Qqx!W<_+EMSLGo zqkC18AQ=0AK9=hgGQtrTovYc5^?Z^RLX?hlO-j&e1MXTTbfm>MS^=}!p>C>icUKdZ zBcNOb(6IJ!kq*e7N8Fx!!kPyn+2B2^2hd00+W^PUA&+S63jFE)bP5Tv+L5l~n(pu? zbeO|+K{{?pEow3?j0+dGVu)a6(0r{1Uj7{3 zxSsZ|BdMk>1-S}-;+`pk{Q5>H=tLRx+YqeenaSRsEX@gtPzz>j1A9g!C9kGtspY(- z%YL>NkVDE2z@}*;Q{=&5)yS;NupAmmibGUE4qte7aY6PcnXJgw>}ad(SW;@HtNurF ziV0_yHz=;Di%Tki6DW^tjkL`t%Ktct(ay zvuAOYoCu!Pm~@P5CIjk$bp`_iv{^l*Au{fB8mJK1>Macv?GL)**8*+JNvySIH5Y7i#1;!%NT!efc z;Z0*AOM&1VpR+6wIQxBM{xf`8T1V@#e<#QL}=YRwMkWG8%1(Fgj{iX)N zup{Txko(DqJWf=#Oi?Z!nra-?C{);TP`w|4>L+EKx1&P3swX<*#_50F!lD_$nQyuK??!UwA-{y)^QmMxoK1xIJ~uML{u;5!Z5tQyEL>;KaUd!_9FP zl2$QOI6V1`QdF|8gkdZsSpUqCjSBu(1H)r*vL#PEy)@Px>5TIk7_9o#Bj zzD&<1_k(ejk%qO6ak=GMmG5b7LTAA^KKq-Ey#z8(2wy2;Ot^oZI(MG@)~iY$RAnJt zu`ioyvR?Vws_tuK9hDqmel+)bP0kyxJV{7t=&3{b(@Hs1fs$9n45aq)IKknZa2H*7 z^P-ZDyOMdMj&-9{(-?dqo5I3Gy=K$!L%q>3^0N~o^2i0^_@^2nQv>S4B&=5_8^a^V zaY!NjyA5QgO&r#^CJcp&=!))MZ*CC&hvLEzWU*!IO=aYo{_yG+53H$XOAIQWnG`uD zLuuwTY6e8N^m5^AHQa}Y5Z#SdbEY;+x{oW?g;ie4CNYomRyQd2mv^L}T!>a5<*wTh>@>Qtwp~nejn`~DcZJI+QC-xU zoxz=5z0k%1;jBrGI%Th~FQElrAPr?E-Fv9|o09dPk=?>f)jFKL8PK|;w(cVDq>YWP zEfL7RGBv|<>f4IccND3wCi*V8`>#a$FPZu&a{V`W`me+Kuf_CJ)%IV%?5ByL^#3Q{ z&uBM5|34IKI>0_Tz{5OngXe#6w*N6;;5PH%9n%56%RaWA{wJ4%515Apdj`a62bp<> zM12OuV+QZ^55ATkViO(UWgg}%9C}kb^r~=BiDyWIXZWM&kb>Q?dd$#W`4KU|2#4qh zz;sZ>ZqS5h#Kdk$&1c9AHmDUdtmHE)CqH0RIAZEE;t(^+RXF+*FlJyk;?6Vn{&MsO zZ0HwY)b4Va!F1#s^N5$-s9(&mPa*Lu4>4SxXm~l|3?PR2jB1J!Q|(4#0i$lFME^-r zA~Q(2O+PHOdcVN((R8zqi>%+yx4PA5u&+jI zZ?)Fm8m-+`n!Bnrx0PvZE7!Q)Z+NTE@K(R!nO40sZF(n~bq_b_9H`UYU#q>pPJ3UC z_UeU>J7qcy%%`ks9)BNcS^GDOn z?oKkjHNoWO1e2?M#vd12e^_AscAnLnc~-CISiYWX`D%{k^H~<37unpMYJYdSv=Om2vbAM@`Qp{{SI=yP zj6WN*eEt0G$9EPX6FU%)-ho>hWTW!yzXBIo73<0umM-=@eG&niY^` zlG(|vuCl_x(X^Fob@=i{8+M5vWf7Bz=#aHGTNA;fZQyfbfueI8Z^639n`(DI%w^-^ zl`=@!u)r~Xf920-xd$Ab+S&PJY%K0H8a_J8uN3^_!K1_NV$*e#*Y*6|)XpiW=9H`*`Xx7W%v@7{XDma1?v0a%(K6rI&1!a YpWXKgmku8Vj|K)Vje`mzEKCg608Q#dYybcN diff --git a/src/main/resources/examples/com/rallydev/rest/CollectionAddExample.java b/src/main/resources/examples/com/rallydev/rest/CollectionAddExample.java deleted file mode 100644 index 70617c4..0000000 --- a/src/main/resources/examples/com/rallydev/rest/CollectionAddExample.java +++ /dev/null @@ -1,63 +0,0 @@ -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 deleted file mode 100644 index 91c31df..0000000 --- a/src/main/resources/examples/com/rallydev/rest/CollectionQueryExample.java +++ /dev/null @@ -1,56 +0,0 @@ -package com.rallydev.rest; - -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -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.URISyntaxException; - -public class CollectionQueryExample { - - 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 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)); - - //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 { - //Release resources - restApi.close(); - } - } -} diff --git a/src/main/resources/examples/com/rallydev/rest/CollectionSummaryExample.java b/src/main/resources/examples/com/rallydev/rest/CollectionSummaryExample.java deleted file mode 100644 index 2601e5c..0000000 --- a/src/main/resources/examples/com/rallydev/rest/CollectionSummaryExample.java +++ /dev/null @@ -1,54 +0,0 @@ -package com.rallydev.rest; - -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -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.URISyntaxException; -import java.util.Map; - -public class CollectionSummaryExample { - - 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 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("\nBy State:"); - JsonObject stateSummary = defectSummary.getAsJsonObject("State"); - for(Map.Entry summaryItem : stateSummary.entrySet()) { - System.out.println(String.format("\t%s - %d", summaryItem.getKey(), summaryItem.getValue().getAsInt())); - } - - } finally { - //Release resources - restApi.close(); - } - } -} diff --git a/src/main/resources/examples/com/rallydev/rest/CrudExample.java b/src/main/resources/examples/com/rallydev/rest/CrudExample.java deleted file mode 100644 index 58d168f..0000000 --- a/src/main/resources/examples/com/rallydev/rest/CrudExample.java +++ /dev/null @@ -1,63 +0,0 @@ -package com.rallydev.rest; - -import com.google.gson.JsonObject; -import com.rallydev.rest.request.*; -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.URISyntaxException; - -public class CrudExample { - - 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 - 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(); - } - } -} diff --git a/src/main/resources/examples/com/rallydev/rest/QueryExample.java b/src/main/resources/examples/com/rallydev/rest/QueryExample.java deleted file mode 100644 index d1eb302..0000000 --- a/src/main/resources/examples/com/rallydev/rest/QueryExample.java +++ /dev/null @@ -1,59 +0,0 @@ -package com.rallydev.rest; - -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -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.URISyntaxException; - -public class QueryExample { - - 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 { - - 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(); - } - } -} diff --git a/src/main/resources/examples/com/rallydev/rest/RestApiFactory.java b/src/main/resources/examples/com/rallydev/rest/RestApiFactory.java deleted file mode 100644 index 35554ed..0000000 --- a/src/main/resources/examples/com/rallydev/rest/RestApiFactory.java +++ /dev/null @@ -1,50 +0,0 @@ -package com.rallydev.rest; - -import java.net.URI; -import java.net.URISyntaxException; - -public class RestApiFactory { - - //Specify your Rally server - private static final String SERVER = "https://rally1.rallydev.com"; - - //Specify your WSAPI version - private static final String WSAPI_VERSION = "v2.0"; - - //Specify your Rally username - private static final String USERNAME = ""; - - //Specify your Rally 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; - - //If using an authenticated proxy server specify the username and password - private static final String PROXY_USERNAME = null; - private static final String PROXY_PASSWORD = null; - - public static RallyRestApi getRestApi() throws URISyntaxException { - 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) { - restApi.setProxy(uri, PROXY_USERNAME, PROXY_PASSWORD); - } else { - restApi.setProxy(uri); - } - } - - restApi.setWsapiVersion(WSAPI_VERSION); - - return restApi; - } -} diff --git a/src/test/java/com/rallydev/rest/RallyRestApiTest.java b/src/test/java/com/rallydev/rest/RallyRestApiTest.java deleted file mode 100644 index eba2d1c..0000000 --- a/src/test/java/com/rallydev/rest/RallyRestApiTest.java +++ /dev/null @@ -1,301 +0,0 @@ -package com.rallydev.rest; - -import com.google.gson.Gson; -import com.google.gson.JsonArray; -import com.google.gson.JsonObject; -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.net.URI; - -import static org.mockito.Mockito.anyString; -import static org.mockito.Mockito.doReturn; -import static org.mockito.Mockito.spy; -import static org.mockito.Mockito.times; -import static org.mockito.Mockito.verify; -import static org.testng.Assert.assertEquals; - -@Test -public class RallyRestApiTest { - private RallyRestApi api; - private URI server; - - @BeforeMethod - protected void setUp() throws Exception { - server = new URI("https://someServer.rallydev.com"); - api = new RallyRestApi(server, "_1adfkj234fjlk"); - api.client = spy(api.client); - - } - - public void shouldInitializeBasicAuthClient() { - RallyRestApi basicAuthApi = new RallyRestApi(server, "username", "password"); - Assert.assertTrue(basicAuthApi.getClient() instanceof BasicAuthClient); - } - - public void shouldInitializeApiKeyClient() { - RallyRestApi apiKeyApi = new RallyRestApi(server, "apiKey"); - Assert.assertTrue(apiKeyApi.getClient() instanceof ApiKeyClient); - } - - public void shouldSetProxy() throws Exception { - URI proxy = new URI("http://my.proxy.com:8000"); - api.setProxy(proxy); - verify(api.client).setProxy(proxy); - } - - 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 shouldSetVendor() throws Exception { - api.setApplicationVendor("fooVendor"); - verify(api.client).setApplicationVendor("fooVendor"); - } - - public void shouldSetVersion() throws Exception { - api.setApplicationVersion("fooVersion"); - verify(api.client).setApplicationVersion("fooVersion"); - } - - public void shouldSetName() throws Exception { - api.setApplicationName("fooName"); - verify(api.client).setApplicationName("fooName"); - } - - public void shouldGetWsapiVersion() { - Assert.assertEquals(api.getWsapiVersion(), api.client.getWsapiVersion()); - } - - public void shouldSetWsapiVersion() { - api.setWsapiVersion("1.43"); - Assert.assertEquals(api.getWsapiVersion(), api.client.getWsapiVersion()); - Assert.assertEquals(api.getWsapiVersion(), "1.43"); - } - - 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 shouldUpdate() throws Exception { - JsonObject response = new JsonObject(); - 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); - - 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(api.client).doPost(request.toUrl(), request.getBody()); - Assert.assertTrue(updateResponse.wasSuccessful()); - JsonObject obj = updateResponse.getObject(); - assertEquals(obj.get("_ref").getAsString(), "/defect/1234"); - } - - 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 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()); - - DeleteRequest request = new DeleteRequest("/defect/1234"); - doReturn(new Gson().toJson(response)).when(api.client).doDelete(request.toUrl()); - DeleteResponse deleteResponse = api.delete(request); - - verify(api.client).doDelete(request.toUrl()); - Assert.assertTrue(deleteResponse.wasSuccessful()); - } - - 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"); - - GetRequest request = new GetRequest("/defect/1234"); - doReturn(new Gson().toJson(response)).when(api.client).doGet(request.toUrl()); - GetResponse getResponse = api.get(request); - - verify(api.client).doGet(request.toUrl()); - Assert.assertTrue(getResponse.wasSuccessful()); - JsonObject obj = getResponse.getObject(); - assertEquals(obj.get("_ref").getAsString(), "/defect/1234"); - } - - public void shouldQueryOnePage() throws Exception { - JsonObject response = buildQueryResponse(5); - QueryRequest request = new QueryRequest("Defect"); - request.setPageSize(1); - doReturn(new Gson().toJson(response)).when(api.client).doGet(request.toUrl()); - QueryResponse queryResponse = api.query(request); - - verify(api.client, times(1)).doGet(anyString()); - verify(api.client).doGet(request.toUrl()); - Assert.assertTrue(queryResponse.wasSuccessful()); - assertEquals(queryResponse.getTotalResultCount(), 5); - } - - public void shouldQueryAllPages() throws Exception { - JsonObject response = buildQueryResponse(5); - QueryRequest request = new QueryRequest("Defect"); - request.setPageSize(1); - request.setLimit(Integer.MAX_VALUE); - 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 shouldQuerySomePages() throws Exception { - JsonObject response = buildQueryResponse(5); - - QueryRequest request = new QueryRequest("Defect"); - request.setPageSize(2); - request.setLimit(4); - doReturn(new Gson().toJson(response)).when(api.client).doGet(anyString()); - api.query(request); - - String requestUrl = request.toUrl(); - - 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 shouldQueryNoPages() throws Exception { - JsonObject response = buildQueryResponse(0); - - QueryRequest request = new QueryRequest("Defect"); - request.setPageSize(1); - request.setLimit(4); - doReturn(new Gson().toJson(response)).when(api.client).doGet(anyString()); - api.query(request); - - verify(api.client, times(1)).doGet(anyString()); //make sure 1 get - verify(api.client).doGet(request.toUrl()); - } - - public void shouldQuerySomePagesWithNonStandardStart() throws Exception { - JsonObject response = buildQueryResponse(10); - - QueryRequest request = new QueryRequest("Defect"); - request.setPageSize(1); - request.setStart(5); - request.setLimit(4); - doReturn(new Gson().toJson(response)).when(api.client).doGet(anyString()); - api.query(request); - - String requestUrl = request.toUrl(); - - 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 shouldQueryAllPagesWithNonStandardStart() throws Exception { - JsonObject response = buildQueryResponse(10); - - QueryRequest request = new QueryRequest("Defect"); - request.setPageSize(1); - request.setStart(5); - request.setLimit(Integer.MAX_VALUE); - 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("QueryResult", queryResult); - queryResult.add("Errors", new JsonArray()); - queryResult.add("Warnings", new JsonArray()); - queryResult.add("Results", new JsonArray()); - queryResult.addProperty("TotalResultCount", totalResultCount); - return response; - } - -} diff --git a/src/test/java/com/rallydev/rest/client/ApiKeyClientTest.java b/src/test/java/com/rallydev/rest/client/ApiKeyClientTest.java deleted file mode 100644 index 84ca9e6..0000000 --- a/src/test/java/com/rallydev/rest/client/ApiKeyClientTest.java +++ /dev/null @@ -1,40 +0,0 @@ -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 deleted file mode 100644 index e661892..0000000 --- a/src/test/java/com/rallydev/rest/client/BasicAuthClientTest.java +++ /dev/null @@ -1,92 +0,0 @@ -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 deleted file mode 100644 index 54d1e1c..0000000 --- a/src/test/java/com/rallydev/rest/client/HttpClientTest.java +++ /dev/null @@ -1,162 +0,0 @@ -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.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); - Assert.assertEquals(client.getParams().getParameter(ConnRoutePNames.DEFAULT_PROXY), - new HttpHost(proxy.getHost(), proxy.getPort(), proxy.getScheme())); - } - - @Test - public void shouldSetProxyWithCredentials() throws Exception { - URI proxy = new URI("http://my.proxy.com:8000"); - client.setProxy(proxy, "username", "password"); - Assert.assertEquals(client.getParams().getParameter(ConnRoutePNames.DEFAULT_PROXY), - new HttpHost(proxy.getHost(), proxy.getPort(), proxy.getScheme())); - verify(client).setClientCredentials(proxy, "username", "password"); - } - - @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 DecompressingHttpClient); - 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 HttpResponse createMockResponse(String responseText) throws Exception { - HttpResponse response = mock(HttpResponse.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 deleted file mode 100644 index 9577bdb..0000000 --- a/src/test/java/com/rallydev/rest/matchers/HttpRequestBodyMatcher.java +++ /dev/null @@ -1,27 +0,0 @@ -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 deleted file mode 100644 index a941d12..0000000 --- a/src/test/java/com/rallydev/rest/matchers/HttpRequestHeaderMatcher.java +++ /dev/null @@ -1,24 +0,0 @@ -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 deleted file mode 100644 index 7be5fc1..0000000 --- a/src/test/java/com/rallydev/rest/matchers/HttpRequestUrlMatcher.java +++ /dev/null @@ -1,22 +0,0 @@ -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 deleted file mode 100644 index 2fb7fc4..0000000 --- a/src/test/java/com/rallydev/rest/request/CollectionUpdateRequestTest.java +++ /dev/null @@ -1,45 +0,0 @@ -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 deleted file mode 100644 index 9fc8a6e..0000000 --- a/src/test/java/com/rallydev/rest/request/CreateRequestTest.java +++ /dev/null @@ -1,61 +0,0 @@ -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; -import org.testng.Assert; -import org.testng.annotations.Test; - -public class CreateRequestTest { - - @Test - public void shouldCreateACorrectBody() { - JsonObject body = new JsonObject(); - body.addProperty("Name", "My Story"); - CreateRequest req = new CreateRequest("HierarchicalRequirement", body); - 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(); - CreateRequest req = new CreateRequest("Defect", body); - req.setFetch(new Fetch("Name", "Description")); - Assert.assertEquals(req.toUrl(), "/defect/create.js?fetch=Name%2CDescription"); - } - - @Test - public void shouldConstructTheCorrectDefaultFetchUrl() { - JsonObject body = new JsonObject(); - CreateRequest req = new CreateRequest("Defect", body); - Assert.assertEquals(req.toUrl(), "/defect/create.js?fetch=true"); - } - - @Test - public void shouldConstructTheCorrectUrlWithExtraParam() { - JsonObject body = new JsonObject(); - CreateRequest req = new CreateRequest("Defect", body); - req.addParam("foo", "Bar"); - Assert.assertEquals(req.toUrl(), "/defect/create.js?foo=Bar&fetch=true"); - } - - @Test - public void shouldEncodeParamsUsingUtf8() { - JsonObject body = new JsonObject(); - CreateRequest req = new CreateRequest("Defect", body); - req.addParam("foo", "备"); - Assert.assertEquals(req.toUrl(), "/defect/create.js?" + - URLEncodedUtils.format(req.getParams(), "utf-8") + "&fetch=true"); - } -} diff --git a/src/test/java/com/rallydev/rest/request/DeleteRequestTest.java b/src/test/java/com/rallydev/rest/request/DeleteRequestTest.java deleted file mode 100644 index 10f7cd9..0000000 --- a/src/test/java/com/rallydev/rest/request/DeleteRequestTest.java +++ /dev/null @@ -1,26 +0,0 @@ -package com.rallydev.rest.request; - -import org.testng.Assert; -import org.testng.annotations.Test; - -public class DeleteRequestTest { - - @Test - public void shouldConstructCorrectUrlWithAbsoluteRef() { - DeleteRequest req = new DeleteRequest("https://rally1.rallydev.com/slm/webservice/1.32/defect/1234.js"); - Assert.assertEquals(req.toUrl(), "/defect/1234.js"); - } - - @Test - public void shouldConstructCorrectUrlWithRelativeRef() { - DeleteRequest req = new DeleteRequest("/defect/1234.js"); - Assert.assertEquals(req.toUrl(), "/defect/1234.js"); - } - - @Test - public void shouldConstructCorrectUrlWithExtraParam() { - DeleteRequest req = new DeleteRequest("/defect/1234.js"); - req.addParam("foo", "Bar"); - Assert.assertEquals(req.toUrl(), "/defect/1234.js?foo=Bar"); - } -} diff --git a/src/test/java/com/rallydev/rest/request/GetRequestTest.java b/src/test/java/com/rallydev/rest/request/GetRequestTest.java deleted file mode 100644 index 05a7ec8..0000000 --- a/src/test/java/com/rallydev/rest/request/GetRequestTest.java +++ /dev/null @@ -1,45 +0,0 @@ -package com.rallydev.rest.request; - -import com.rallydev.rest.util.Fetch; -import org.testng.Assert; -import org.testng.annotations.Test; - -public class GetRequestTest { - - @Test - public void shouldReturnCorrectUrlWithAbsoluteRef() { - GetRequest req = new GetRequest("https://rally1.rallydev.com/slm/webservice/1.32/defect/1234.js"); - Assert.assertEquals(req.toUrl(), "/defect/1234.js?fetch=true"); - } - - @Test - public void shouldReturnCorrectUrlWithRelativeRef() { - GetRequest req = new GetRequest("/defect/1234.js"); - Assert.assertEquals(req.toUrl(), "/defect/1234.js?fetch=true"); - } - - @Test - public void shouldReturnCorrectUrlWithFetchParams() { - GetRequest req = new GetRequest("https://rally1.rallydev.com/slm/webservice/1.32/defect/1234.js"); - req.setFetch(new Fetch("Name", "Description")); - Assert.assertEquals(req.toUrl(), "/defect/1234.js?fetch=Name%2CDescription"); - } - - @Test - public void shouldReturnCorrectUrlForUser() { - Assert.assertEquals(new GetRequest("User").toUrl(), "/user.js?fetch=true"); - Assert.assertEquals(new GetRequest("user").toUrl(), "/user.js?fetch=true"); - Assert.assertEquals(new GetRequest("/user").toUrl(), "/user.js?fetch=true"); - Assert.assertEquals(new GetRequest("/user.js").toUrl(), "/user.js?fetch=true"); - Assert.assertEquals(new GetRequest("/user/12345.js").toUrl(), "/user/12345.js?fetch=true"); - } - - @Test - public void shouldReturnCorrectUrlForSubscription() { - Assert.assertEquals(new GetRequest("Subscription").toUrl(), "/subscription.js?fetch=true"); - Assert.assertEquals(new GetRequest("subscription").toUrl(), "/subscription.js?fetch=true"); - Assert.assertEquals(new GetRequest("/subscription").toUrl(), "/subscription.js?fetch=true"); - Assert.assertEquals(new GetRequest("/subscription.js").toUrl(), "/subscription.js?fetch=true"); - Assert.assertEquals(new GetRequest("/subscription/12345.js").toUrl(), "/subscription/12345.js?fetch=true"); - } -} diff --git a/src/test/java/com/rallydev/rest/request/QueryRequestTest.java b/src/test/java/com/rallydev/rest/request/QueryRequestTest.java deleted file mode 100644 index ad61c4f..0000000 --- a/src/test/java/com/rallydev/rest/request/QueryRequestTest.java +++ /dev/null @@ -1,165 +0,0 @@ -package com.rallydev.rest.request; - -import com.google.gson.JsonObject; -import com.rallydev.rest.util.Fetch; -import com.rallydev.rest.util.QueryFilter; -import org.apache.http.client.utils.URLEncodedUtils; -import org.testng.Assert; -import org.testng.annotations.Test; - -public class QueryRequestTest { - - @Test - public void shouldCreateCorrectDefaultQuery() { - - QueryRequest q = new QueryRequest("Defect"); - - Assert.assertEquals(q.getPageSize(), 200); - Assert.assertEquals(q.getStart(), 1); - Assert.assertEquals(q.getOrder(), "ObjectID"); - Assert.assertEquals(q.toUrl(), "/defect.js?start=1&pagesize=200&fetch=true&order=ObjectID"); - } - - @Test - public void shouldCreateCorrectDefaultQueryWithExtraParam() { - - QueryRequest q = new QueryRequest("Defect"); - q.addParam("foo", "Bar"); - Assert.assertEquals(q.toUrl(), "/defect.js?foo=Bar&start=1&pagesize=200&fetch=true&order=ObjectID"); - } - - @Test - public void shouldEncodeParamsUsingUtf8() { - - QueryRequest q = new QueryRequest("Defect"); - q.addParam("foo", "备"); - Assert.assertTrue(q.toUrl().contains(URLEncodedUtils.format(q.getParams(), "utf-8"))); - } - - @Test - public void shouldCreateCorrectQueryWithFetch() { - - QueryRequest q = new QueryRequest("Defect"); - q.setFetch(new Fetch("Name", "Description")); - Assert.assertTrue(q.toUrl().contains("fetch=Name%2CDescription")); - } - - @Test - public void shouldCreateCorrectQueryWithDefaultOrder() { - - QueryRequest q = new QueryRequest("Defect"); - Assert.assertTrue(q.toUrl().contains("order=ObjectID")); - } - - @Test - public void shouldCreateCorrectQueryWithSpecifiedOrder() { - - QueryRequest q = new QueryRequest("Defect"); - q.setOrder("Name"); - Assert.assertTrue(q.toUrl().contains("order=Name%2CObjectID")); - } - - @Test - public void shouldCreateCorrectQueryWithPageSize() { - - QueryRequest q = new QueryRequest("Defect"); - q.setPageSize(1); - Assert.assertTrue(q.toUrl().contains("pagesize=1")); - } - - @Test - public void shouldCreateCorrectQueryWithStart() { - - QueryRequest q = new QueryRequest("Defect"); - q.setStart(50); - Assert.assertTrue(q.toUrl().contains("start=50")); - } - - @Test - public void shouldCreateCorrectQueryWithQuery() { - - QueryRequest q = new QueryRequest("Defect"); - q.setQueryFilter(new QueryFilter("State", "=", "Fixed")); - Assert.assertTrue(q.toUrl().contains("query=%28State+%3D+Fixed%29")); - } - - @Test - public void shouldCreateCorrectQueryWithWorkspace() { - - QueryRequest q = new QueryRequest("Defect"); - q.setWorkspace("/workspace/1234"); - Assert.assertTrue(q.toUrl().contains("workspace=%2Fworkspace%2F1234")); - } - - @Test - public void shouldCreateCorrectQueryWithProject() { - - QueryRequest q = new QueryRequest("Defect"); - q.setProject("/project/1234"); - Assert.assertTrue(q.toUrl().contains("project=%2Fproject%2F1234")); - Assert.assertTrue(q.toUrl().contains("projectScopeUp=false")); - Assert.assertTrue(q.toUrl().contains("projectScopeDown=true")); - - q.setScopedDown(false); - q.setScopedUp(true); - Assert.assertTrue(q.toUrl().contains("projectScopeUp=true")); - Assert.assertTrue(q.toUrl().contains("projectScopeDown=false")); - - } - - @Test - public void shouldCreateCorrectQueryWithNullProject() { - - QueryRequest q = new QueryRequest("Defect"); - q.setProject(null); - Assert.assertTrue(q.toUrl().contains("project=null")); - Assert.assertFalse(q.toUrl().contains("projectScopeUp")); - Assert.assertFalse(q.toUrl().contains("projectScopeDown")); - - } - - @Test - public void shouldCloneCorrectly() { - - QueryRequest q = new QueryRequest("Defect"); - q.setProject("/project/1234"); - q.setProject("/workspace/2345"); - q.setScopedDown(false); - q.setScopedUp(true); - q.setFetch(new Fetch("Name", "Description")); - q.setQueryFilter(new QueryFilter("State", "=", "Fixed")); - q.setPageSize(5); - q.setOrder("Name"); - q.setStart(10); - q.addParam("foo", "Bar"); - - QueryRequest q2 = q.clone(); - Assert.assertEquals(q.toUrl(), q2.toUrl()); - - } - - @Test - public void shouldCreateCorrectUrlForSubscription() { - - QueryRequest q = new QueryRequest("Subscription"); - - Assert.assertEquals(q.toUrl(), "/subscriptions.js?start=1&pagesize=200&fetch=true&order=ObjectID"); - } - - @Test - public void shouldCreateCorrectUrlForUser() { - - QueryRequest q = new QueryRequest("User"); - - Assert.assertEquals(q.toUrl(), "/users.js?start=1&pagesize=200&fetch=true&order=ObjectID"); - } - - @Test - public void shouldCreateCorrectUrlForCollection() { - JsonObject collection = new JsonObject(); - collection.addProperty("_ref", "/defect/1234/tasks"); - - QueryRequest q = new QueryRequest(collection); - Assert.assertEquals(q.toUrl(), "/defect/1234/tasks?start=1&pagesize=200&fetch=true&order=ObjectID"); - } -} diff --git a/src/test/java/com/rallydev/rest/request/RequestTest.java b/src/test/java/com/rallydev/rest/request/RequestTest.java deleted file mode 100644 index 68086b5..0000000 --- a/src/test/java/com/rallydev/rest/request/RequestTest.java +++ /dev/null @@ -1,64 +0,0 @@ -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; -import org.testng.annotations.Test; - -import java.util.ArrayList; -import java.util.List; - -public class RequestTest { - - private Request createRequest() { - return new Request() { - @Override - public String toUrl() { - return ""; - } - }; - } - - @Test - public void shouldBeAbleToAddParams() { - Request r = createRequest(); - Assert.assertEquals(r.getParams().size(), 0); - - r.addParam("Name", "Value"); - Assert.assertEquals(r.getParams().size(), 1); - - r.addParam("Name2", "Value2"); - Assert.assertEquals(r.getParams().size(), 2); - - r.getParams().clear(); - Assert.assertEquals(r.getParams().size(), 0); - } - - @Test - public void shouldBeAbleToSetParams() { - Request r = createRequest(); - Assert.assertEquals(r.getParams().size(), 0); - - List params = new ArrayList(); - params.add(new BasicNameValuePair("Name", "Value")); - r.setParams(params); - 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 deleted file mode 100644 index df8f72f..0000000 --- a/src/test/java/com/rallydev/rest/request/UpdateRequestTest.java +++ /dev/null @@ -1,50 +0,0 @@ -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; -import org.testng.annotations.Test; - -public class UpdateRequestTest { - - @Test - public void shouldCreateACorrectBody() { - JsonObject body = new JsonObject(); - body.addProperty("Name", "My Story"); - UpdateRequest req = new UpdateRequest("https://rally1.rallydev.com/slm/webservice/1.32/hierarchicalrequirement/1234.js", body); - 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(); - UpdateRequest req= new UpdateRequest("/defect/1234.js", body); - req.setFetch(new Fetch("Name", "Description")); - Assert.assertEquals(req.toUrl(), "/defect/1234.js?fetch=Name%2CDescription"); - } - - @Test - public void shouldConstructTheCorrectDefaultFetchUrl() { - JsonObject body = new JsonObject(); - UpdateRequest req= new UpdateRequest("/defect/1234.js", body); - Assert.assertEquals(req.toUrl(), "/defect/1234.js?fetch=true"); - } - - @Test - public void shouldConstructTheCorrectUrlWithExtraParam() { - JsonObject body = new JsonObject(); - UpdateRequest req= new UpdateRequest("https://rally1.rallydev.com/slm/webservice/1.32/defect/1234.js", body); - req.addParam("foo", "Bar"); - Assert.assertEquals(req.toUrl(), "/defect/1234.js?foo=Bar&fetch=true"); - } -} diff --git a/src/test/java/com/rallydev/rest/response/CollectionUpdateResponseTest.java b/src/test/java/com/rallydev/rest/response/CollectionUpdateResponseTest.java deleted file mode 100644 index 093e9ec..0000000 --- a/src/test/java/com/rallydev/rest/response/CollectionUpdateResponseTest.java +++ /dev/null @@ -1,43 +0,0 @@ -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/CreateResponseTest.java b/src/test/java/com/rallydev/rest/response/CreateResponseTest.java deleted file mode 100644 index 59ffd61..0000000 --- a/src/test/java/com/rallydev/rest/response/CreateResponseTest.java +++ /dev/null @@ -1,32 +0,0 @@ -package com.rallydev.rest.response; - -import com.google.gson.Gson; -import org.testng.Assert; -import org.testng.annotations.Test; - -public class CreateResponseTest { - private CreateResponse createResponse(String[] errors, String result) { - return new CreateResponse("{\"CreateResult\": { \"Errors\": " + new Gson().toJson(errors) + ", \"Warnings\": [], \"Object\": " + - result + "}}"); - } - - @Test - public void shouldReturnCreatedObject() { - CreateResponse createResponse = createResponse(new String[]{}, "{\"Foo\": 7}"); - - Assert.assertEquals(createResponse.getErrors().length, 0, "Error length correct"); - Assert.assertEquals(createResponse.getWarnings().length, 0, "Warning length correct"); - Assert.assertNotNull(createResponse.getObject()); - Assert.assertEquals(createResponse.getObject().get("Foo").getAsInt(), 7); - Assert.assertTrue(createResponse.wasSuccessful()); - } - - @Test - public void shouldReturnErrors() { - CreateResponse createResponse = createResponse(new String[]{"Foo"}, "{}"); - String[] errors = createResponse.getErrors(); - Assert.assertEquals(errors.length, 1, "Error length correct"); - Assert.assertFalse(createResponse.wasSuccessful()); - Assert.assertNull(createResponse.getObject()); - } -} diff --git a/src/test/java/com/rallydev/rest/response/DeleteResponseTest.java b/src/test/java/com/rallydev/rest/response/DeleteResponseTest.java deleted file mode 100644 index d8c736d..0000000 --- a/src/test/java/com/rallydev/rest/response/DeleteResponseTest.java +++ /dev/null @@ -1,31 +0,0 @@ -package com.rallydev.rest.response; - -import com.google.gson.Gson; -import org.testng.Assert; -import org.testng.annotations.Test; - -public class DeleteResponseTest { - - private DeleteResponse createResponse(String[] errors) { - return new DeleteResponse("{\"OperationResult\": { \"Errors\": " + new Gson().toJson(errors) + "}}"); - } - - @Test - public void shouldReturnErrors() { - DeleteResponse r = createResponse(new String[]{"Foo", "Bar"}); - String[] errors = r.getErrors(); - Assert.assertEquals(errors.length, 2, "Error length correct"); - Assert.assertFalse(r.wasSuccessful(), "Successful correct"); - Assert.assertEquals(errors[0], "Foo", "First error correct"); - Assert.assertEquals(errors[1], "Bar", "Second error correct"); - } - - @Test - public void shouldReturnNoErrors() { - DeleteResponse r = createResponse(new String[]{}); - String[] errors = r.getErrors(); - Assert.assertEquals(errors.length, 0, "Error length correct"); - Assert.assertTrue(r.wasSuccessful(), "Successful correct"); - } - -} diff --git a/src/test/java/com/rallydev/rest/response/GetResponseTest.java b/src/test/java/com/rallydev/rest/response/GetResponseTest.java deleted file mode 100644 index 9f70a0c..0000000 --- a/src/test/java/com/rallydev/rest/response/GetResponseTest.java +++ /dev/null @@ -1,35 +0,0 @@ -package com.rallydev.rest.response; - -import com.google.gson.Gson; -import org.testng.Assert; -import org.testng.annotations.Test; - -public class GetResponseTest { - - private GetResponse createResponse(String[] errors) { - return new GetResponse("{\"" + (errors.length > 0 ? "OperationResult" : "Defect") + - "\": { \"Errors\": " + new Gson().toJson(errors) + ", \"Foo\": \"Bar\"}}"); - } - - @Test - public void shouldReturnErrors() { - GetResponse r = createResponse(new String[]{"Foo", "Bar"}); - String[] errors = r.getErrors(); - Assert.assertEquals(errors.length, 2, "Error length correct"); - Assert.assertFalse(r.wasSuccessful(), "Successful correct"); - Assert.assertEquals(errors[0], "Foo", "First error correct"); - Assert.assertEquals(errors[1], "Bar", "Second error correct"); - Assert.assertNull(r.getObject()); - } - - @Test - public void shouldReturnNoErrors() { - GetResponse r = createResponse(new String[]{}); - String[] errors = r.getErrors(); - Assert.assertEquals(errors.length, 0, "Error length correct"); - Assert.assertTrue(r.wasSuccessful(), "Successful correct"); - Assert.assertNotNull(r.getObject()); - Assert.assertEquals(r.getObject().get("Foo").getAsString(), "Bar"); - } - -} diff --git a/src/test/java/com/rallydev/rest/response/QueryResponseTest.java b/src/test/java/com/rallydev/rest/response/QueryResponseTest.java deleted file mode 100644 index c4b7c04..0000000 --- a/src/test/java/com/rallydev/rest/response/QueryResponseTest.java +++ /dev/null @@ -1,47 +0,0 @@ -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 QueryResponseTest { - private QueryResponse createResponse(String[] errors, JsonArray results) { - return new QueryResponse("{\"QueryResult\": { \"Errors\": " + new Gson().toJson(errors) + ", \"Warnings\": [], \"TotalResultCount\": " + - results.size() + ", \"Results\": " + new Gson().toJson(results) + ", \"PageSize\": 20, \"StartIndex\": 1}}"); - } - - @Test - public void shouldReturnResults() { - JsonArray results = new JsonArray(); - JsonObject r1 = new JsonObject(); - r1.addProperty("Foo", 7); - results.add(r1); - JsonObject r2 = new JsonObject(); - r2.addProperty("Foo", 1); - results.add(r2); - - QueryResponse r = createResponse(new String[]{}, results); - - 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 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); - } - - @Test - public void shouldReturnNoErrors() { - QueryResponse 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.getTotalResultCount(), 0); - Assert.assertEquals(r.getResults().size(), 0); - } -} diff --git a/src/test/java/com/rallydev/rest/response/ResponseTest.java b/src/test/java/com/rallydev/rest/response/ResponseTest.java deleted file mode 100644 index 180acfb..0000000 --- a/src/test/java/com/rallydev/rest/response/ResponseTest.java +++ /dev/null @@ -1,50 +0,0 @@ -package com.rallydev.rest.response; - -import org.testng.Assert; -import org.testng.annotations.Test; - -public class ResponseTest { - - private Response createResponse(String response) { - return new Response("{\"Root\": " + response + "}") { - @Override - public String getRoot() { - return "Root"; - } - }; - } - - @Test - public void shouldReturnErrors() { - Response r = createResponse("{\"Errors\": [\"Foo\", \"Bar\"]}"); - String[] errors = r.getErrors(); - Assert.assertEquals(errors.length, 2, "Error length correct"); - Assert.assertFalse(r.wasSuccessful(), "Successful correct"); - Assert.assertEquals(errors[0], "Foo", "First error correct"); - Assert.assertEquals(errors[1], "Bar", "Second error correct"); - } - - @Test - public void shouldReturnNoErrors() { - Response r = createResponse("{\"Errors\": []}"); - String[] errors = r.getErrors(); - Assert.assertEquals(errors.length, 0, "Error length correct"); - Assert.assertTrue(r.wasSuccessful(), "Successful correct"); - } - - @Test - public void shouldReturnWarnings() { - Response r = createResponse("{\"Warnings\": [\"Foo\", \"Bar\"]}"); - String[] warnings = r.getWarnings(); - Assert.assertEquals(warnings.length, 2, "Error length correct"); - Assert.assertEquals(warnings[0], "Foo", "First error correct"); - Assert.assertEquals(warnings[1], "Bar", "Second error correct"); - } - - @Test - public void shouldReturnNoWarnings() { - Response r = createResponse("{\"Warnings\": []}"); - String[] warnings = r.getWarnings(); - Assert.assertEquals(warnings.length, 0, "Warning length correct"); - } -} diff --git a/src/test/java/com/rallydev/rest/response/UpdateResponseTest.java b/src/test/java/com/rallydev/rest/response/UpdateResponseTest.java deleted file mode 100644 index 82c08eb..0000000 --- a/src/test/java/com/rallydev/rest/response/UpdateResponseTest.java +++ /dev/null @@ -1,32 +0,0 @@ -package com.rallydev.rest.response; - -import com.google.gson.Gson; -import org.testng.Assert; -import org.testng.annotations.Test; - -public class UpdateResponseTest { - private UpdateResponse UpdateResponse(String[] errors, String result) { - return new UpdateResponse("{\"OperationResult\": { \"Errors\": " + new Gson().toJson(errors) + ", \"Warnings\": [], \"Object\": " + - result + "}}"); - } - - @Test - public void shouldReturnUpdatedObject() { - UpdateResponse UpdateResponse = UpdateResponse(new String[]{}, "{\"Foo\": 7}"); - - Assert.assertEquals(UpdateResponse.getErrors().length, 0, "Error length correct"); - Assert.assertEquals(UpdateResponse.getWarnings().length, 0, "Warning length correct"); - Assert.assertNotNull(UpdateResponse.getObject()); - Assert.assertEquals(UpdateResponse.getObject().get("Foo").getAsInt(), 7); - Assert.assertTrue(UpdateResponse.wasSuccessful()); - } - - @Test - public void shouldReturnErrors() { - UpdateResponse UpdateResponse = UpdateResponse(new String[]{"Foo"}, "{}"); - String[] errors = UpdateResponse.getErrors(); - Assert.assertEquals(errors.length, 1, "Error length correct"); - Assert.assertFalse(UpdateResponse.wasSuccessful()); - Assert.assertNull(UpdateResponse.getObject()); - } -} diff --git a/src/test/java/com/rallydev/rest/util/FetchTest.java b/src/test/java/com/rallydev/rest/util/FetchTest.java deleted file mode 100644 index d13e6d6..0000000 --- a/src/test/java/com/rallydev/rest/util/FetchTest.java +++ /dev/null @@ -1,31 +0,0 @@ -package com.rallydev.rest.util; - -import org.testng.Assert; -import org.testng.annotations.Test; - -public class FetchTest { - - @Test - public void shouldProvideCorrectDefaultFetch() { - Fetch f = new Fetch(); - Assert.assertEquals(f.toString(), "true"); - } - - @Test - public void shouldProvideCorrectFetch() { - Fetch f = new Fetch("Name", "Description", "ScheduleState"); - Assert.assertEquals(f.toString(), "Name,Description,ScheduleState"); - } - - @Test - public void shouldBeAbleToAddRemoveFetch() { - Fetch f = new Fetch("Name", "Description", "ScheduleState"); - String fetch = f.toString(); - f.add("Foo"); - Assert.assertEquals(f.toString(), fetch + ",Foo"); - f.remove("Foo"); - Assert.assertEquals(f.toString(), fetch); - f.clear(); - Assert.assertEquals(f.toString(), "true"); - } -} diff --git a/src/test/java/com/rallydev/rest/util/QueryFilterTest.java b/src/test/java/com/rallydev/rest/util/QueryFilterTest.java deleted file mode 100644 index 10cc106..0000000 --- a/src/test/java/com/rallydev/rest/util/QueryFilterTest.java +++ /dev/null @@ -1,72 +0,0 @@ -package com.rallydev.rest.util; - -import org.testng.Assert; -import org.testng.annotations.Test; - -public class QueryFilterTest { - - @Test - public void shouldCreateCorrectQueryForString() { - QueryFilter q = new QueryFilter("Foo", "=", "Bar"); - Assert.assertEquals(q.toString(), "(Foo = Bar)", "String value query correct"); - } - - @Test - public void shouldCreateCorrectQueryForNull() { - QueryFilter q = new QueryFilter("Foo", "=", null); - Assert.assertEquals(q.toString(), "(Foo = null)", "Null value query correct"); - } - - @Test - public void shouldCreateQuotedQueryForStringWithSpaces() { - QueryFilter q = new QueryFilter("Foo", "=", "Bar Baz"); - Assert.assertEquals(q.toString(), "(Foo = \"Bar Baz\")", "String value with spaces query correct"); - } - - @Test - public void shouldCreateCorrectQueryForRef() { - String relativeRef = "/hierarchicalrequirement/1234"; - QueryFilter q = new QueryFilter("Parent", "=", relativeRef); - QueryFilter q2 = new QueryFilter("Parent", "=", "https://rally1.rallydev.com/slm/webservice/1.32" + relativeRef); - Assert.assertEquals(q.toString(), "(Parent = " + relativeRef + ")", "Relative ref value correct"); - Assert.assertEquals(q2.toString(), "(Parent = " + relativeRef + ")", "Absolute ref value correct"); - } - - @Test - public void shouldCreateCorrectQueryForNumber() { - QueryFilter q = new QueryFilter("Foo", ">", "6"); - Assert.assertEquals(q.toString(), "(Foo > 6)", "Numeric value with spaces query correct"); - } - - @Test - public void shouldCreateCorrectAndedQuery() { - QueryFilter q = new QueryFilter("Foo", "=", "Bar"); - QueryFilter q2 = q.and(new QueryFilter("Bar", "=", "Baz")); - Assert.assertEquals(q2.toString(), "((Foo = Bar) AND (Bar = Baz))"); - } - - @Test - public void shouldCreateCorrectStaticAndedQuery() { - QueryFilter q = new QueryFilter("Foo", "=", "Bar"); - QueryFilter q2 = new QueryFilter("Bar", "=", "Baz"); - QueryFilter q3 = new QueryFilter("Baz", "=", "Foo"); - Assert.assertEquals(QueryFilter.and(q, q2, q3).toString(), "(((Foo = Bar) AND (Bar = Baz)) AND (Baz = Foo))"); - Assert.assertNull(QueryFilter.and()); - } - - @Test - public void shouldCreateCorrectOredQuery() { - QueryFilter q = new QueryFilter("Foo", "=", "Bar"); - QueryFilter q2 = q.or(new QueryFilter("Bar", "=", "Baz")); - Assert.assertEquals(q2.toString(), "((Foo = Bar) OR (Bar = Baz))"); - } - - @Test - public void shouldCreateCorrectStaticOredQuery() { - QueryFilter q = new QueryFilter("Foo", "=", "Bar"); - QueryFilter q2 = new QueryFilter("Bar", "=", "Baz"); - QueryFilter q3 = new QueryFilter("Baz", "=", "Foo"); - Assert.assertEquals(QueryFilter.or(q, q2, q3).toString(), "(((Foo = Bar) OR (Bar = Baz)) OR (Baz = Foo))"); - Assert.assertNull(QueryFilter.or()); - } -} diff --git a/src/test/java/com/rallydev/rest/util/RefTest.java b/src/test/java/com/rallydev/rest/util/RefTest.java deleted file mode 100644 index 272a895..0000000 --- a/src/test/java/com/rallydev/rest/util/RefTest.java +++ /dev/null @@ -1,125 +0,0 @@ -package com.rallydev.rest.util; - -import org.testng.Assert; -import org.testng.annotations.Test; - -public class RefTest { - - @Test - 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"); - } - - @Test - public void shouldDetectValidDynatypeRefs() { - Assert.assertTrue(Ref.isRef("/portfolioitem/feature/1234"), "Valid relative ref"); - Assert.assertTrue(Ref.isRef("/portfolioitem/feature/1234.js"), "Valid relative ref w/ extension"); - Assert.assertTrue(Ref.isRef("https://rally1.rallydev.com/slm/webservice/1.32/portfolioitem/feature/1234"), "Valid absolute ref"); - Assert.assertTrue(Ref.isRef("http://rally1.rallydev.com/slm/webservice/1.32/portfolioitem/feature/1234.js"), "Valid absolute ref w/ extension"); - } - - @Test - public void shouldDetectInvalidRefs() { - Assert.assertFalse(Ref.isRef("/defect"), "Invalid ref"); - Assert.assertFalse(Ref.isRef("https://rally1.rallydev.com/slm/webservice/1.32/defect/abc.js"), "Invalid ref"); - Assert.assertFalse(Ref.isRef(null), "A null ref"); - Assert.assertFalse(Ref.isRef(""), "An empty string"); - } - - @Test - public void shouldReturnValidRelativeRefs() { - Assert.assertEquals(Ref.getRelativeRef("/defect/1234"), "/defect/1234", "Already relative ref"); - Assert.assertEquals(Ref.getRelativeRef("/defect/1234.js"), "/defect/1234", "Already relative ref"); - Assert.assertEquals(Ref.getRelativeRef("https://rally1.rallydev.com/slm/webservice/1.32/defect/1234"), "/defect/1234", "Absolute ref"); - } - - @Test - public void shouldReturnValidDynatypeRelativeRefs() { - Assert.assertEquals(Ref.getRelativeRef("/portfolioitem/feature/1234"), "/portfolioitem/feature/1234", "Already relative ref"); - Assert.assertEquals(Ref.getRelativeRef("/portfolioitem/feature/1234.js"), "/portfolioitem/feature/1234", "Already relative ref"); - Assert.assertEquals(Ref.getRelativeRef("https://rally1.rallydev.com/slm/webservice/1.32/portfolioitem/feature/1234"), "/portfolioitem/feature/1234", "Absolute ref"); - } - - @Test - public void shouldReturnNullRelativeRefs() { - Assert.assertNull(Ref.getRelativeRef("blah"), "Not a ref"); - Assert.assertNull(Ref.getRelativeRef(""), "Empty ref"); - Assert.assertNull(Ref.getRelativeRef(null), "null ref"); - } - - @Test - public void shouldReturnTypesFromRefs() { - Assert.assertEquals(Ref.getTypeFromRef("/defect/1234"), "defect", "Relative ref"); - Assert.assertEquals(Ref.getTypeFromRef("/defect/1234.js"), "defect", "Relative ref with extension"); - Assert.assertEquals(Ref.getTypeFromRef("https://rally1.rallydev.com/slm/webservice/1.32/defect/1234"), "defect", "Valid absolute ref"); - } - - @Test - public void shouldReturnTypesFromDynatypeRefs() { - Assert.assertEquals(Ref.getTypeFromRef("/portfolioitem/feature/1234"), "portfolioitem/feature", "Relative ref"); - Assert.assertEquals(Ref.getTypeFromRef("/portfolioitem/feature/1234.js"), "portfolioitem/feature", "Relative ref with extension"); - Assert.assertEquals(Ref.getTypeFromRef("https://rally1.rallydev.com/slm/webservice/1.32/portfolioitem/feature/1234"), "portfolioitem/feature", "Valid absolute ref"); - } - - @Test - public void shouldReturnNullTypesFromRefs() { - Assert.assertNull(Ref.getTypeFromRef("blah"), "Not a ref"); - Assert.assertNull(Ref.getTypeFromRef(""), "Empty ref"); - Assert.assertNull(Ref.getTypeFromRef(null), "null ref"); - } - - @Test - 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"); - } - - @Test - public void shouldReturnOidsFromDynatypeRefs() { - Assert.assertEquals(Ref.getOidFromRef("/portfolioitem/feature/1234"), "1234", "Relative ref"); - Assert.assertEquals(Ref.getOidFromRef("/portfolioitem/feature/1234.js"), "1234", "Relative ref with extension"); - Assert.assertEquals(Ref.getOidFromRef("https://rally1.rallydev.com/slm/webservice/1.32/portfolioitem/feature/1234"), "1234", "Valid absolute ref"); - } - - @Test - public void shouldReturnNullOidsFromRefs() { - Assert.assertNull(Ref.getOidFromRef("blah"), "Not a ref"); - Assert.assertNull(Ref.getOidFromRef(""), "Empty ref"); - Assert.assertNull(Ref.getOidFromRef(null), "null ref"); - } - - @Test - public void shouldSupportWsapiVersionXinRefs() { - Assert.assertEquals(Ref.getRelativeRef("https://rally1.rallydev.com/slm/webservice/x/portfolioitem/feature/1234"), "/portfolioitem/feature/1234", "Valid absolute version x dynatype ref"); - Assert.assertEquals(Ref.getRelativeRef("https://rally1.rallydev.com/slm/webservice/x/defect/1234"), "/defect/1234", "Valid absolute version x ref"); - } - - @Test - public void shouldSupportWorkspacePermissionRefs() { - Assert.assertEquals(Ref.getRelativeRef("https://rally1.rallydev.com/slm/webservice/1.38/workspacepermission/123u456w1"), "/workspacepermission/123u456w1", "Valid workspace permission ref"); - Assert.assertEquals(Ref.getOidFromRef("/workspacepermission/123u456w1.js"), "123u456w1", "Get oid from workspace permission ref"); - Assert.assertEquals(Ref.getTypeFromRef("/workspacepermission/123u456w1.js"), "workspacepermission", "Get type from workspace permission ref"); - } - - @Test - public void shouldSupportProjectPermissionRefs() { - Assert.assertEquals(Ref.getRelativeRef("https://rally1.rallydev.com/slm/webservice/1.38/projectpermission/123u456p1"), "/projectpermission/123u456p1", "Valid project permission ref"); - Assert.assertEquals(Ref.getOidFromRef("/projectpermission/123u456p1.js"), "123u456p1", "Get oid from project permission ref"); - Assert.assertEquals(Ref.getTypeFromRef("/projectpermission/123u456p1.js"), "projectpermission", "Get type from project permission ref"); - } - - @Test - public void shouldSupportCollectionRefs() { - Assert.assertEquals(Ref.getRelativeRef("https://rally1.rallydev.com/slm/webservice/1.38/defect/1234/tasks"), "/defect/1234/tasks", "Valid collection ref"); - Assert.assertEquals(Ref.getRelativeRef("/defect/1234/tasks"), "/defect/1234/tasks", "Valid relative collection ref"); - Assert.assertEquals(Ref.getRelativeRef("https://rally1.rallydev.com/slm/webservice/1.38/portfolioitem/feature/1234/children"), "/portfolioitem/feature/1234/children", "Valid dynatype collection ref"); - Assert.assertEquals(Ref.getRelativeRef("/portfolioitem/feature/1234/children"), "/portfolioitem/feature/1234/children", "Valid dynatype relative collection ref"); - Assert.assertEquals(Ref.getRelativeRef("/typedefinition/-12345/attributes"), "/typedefinition/-12345/attributes", "Valid built-in type def attributes relative collection ref"); - } -} diff --git a/src/main/resources/doc/stylesheet.css b/stylesheet.css similarity index 50% rename from src/main/resources/doc/stylesheet.css rename to stylesheet.css index 0aeaa97..cebb4fd 100644 --- a/src/main/resources/doc/stylesheet.css +++ b/stylesheet.css @@ -2,16 +2,19 @@ /* Overall document style */ + +@import url('resources/fonts/dejavu.css'); + body { background-color:#ffffff; color:#353833; - font-family:Arial, Helvetica, sans-serif; - font-size:76%; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; margin:0; } a:link, a:visited { text-decoration:none; - color:#4c6b87; + color:#4A6782; } a:hover, a:focus { text-decoration:none; @@ -19,7 +22,7 @@ a:hover, a:focus { } a:active { text-decoration:none; - color:#4c6b87; + color:#4A6782; } a[name] { color:#353833; @@ -29,41 +32,51 @@ a[name]:hover { color:#353833; } pre { - font-size:1.3em; + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; } h1 { - font-size:1.8em; + font-size:20px; } h2 { - font-size:1.5em; + font-size:18px; } h3 { - font-size:1.4em; + font-size:16px; + font-style:italic; } h4 { - font-size:1.3em; + font-size:13px; } h5 { - font-size:1.2em; + font-size:12px; } h6 { - font-size:1.1em; + font-size:11px; } ul { list-style-type:disc; } code, tt { - font-size:1.2em; + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; } dt code { - font-size:1.2em; + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; } table tr td dt code { - font-size:1.2em; + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; vertical-align:top; + padding-top:4px; } sup { - font-size:.6em; + font-size:8px; } /* Document title and Copyright styles @@ -76,9 +89,9 @@ Document title and Copyright styles .aboutLanguage { float:right; padding:0px 21px; - font-size:.8em; + font-size:11px; z-index:200; - margin-top:-7px; + margin-top:-9px; } .legalCopy { margin-left:.5em; @@ -92,9 +105,6 @@ Document title and Copyright styles } .tab { background-color:#0066FF; - background-image:url(resources/titlebar.gif); - background-position:left top; - background-repeat:no-repeat; color:#ffffff; padding:8px; width:5em; @@ -104,17 +114,15 @@ Document title and Copyright styles Navigation bar styles */ .bar { - background-image:url(resources/background.gif); - background-repeat:repeat-x; + background-color:#4D7A97; color:#FFFFFF; padding:.8em .5em .4em .8em; height:auto;/*height:1.8em;*/ - font-size:1em; + font-size:11px; margin:0; } .topNav { - background-image:url(resources/background.gif); - background-repeat:repeat-x; + background-color:#4D7A97; color:#FFFFFF; float:left; padding:0; @@ -123,11 +131,11 @@ Navigation bar styles height:2.8em; padding-top:10px; overflow:hidden; + font-size:12px; } .bottomNav { margin-top:10px; - background-image:url(resources/background.gif); - background-repeat:repeat-x; + background-color:#4D7A97; color:#FFFFFF; float:left; padding:0; @@ -136,18 +144,20 @@ Navigation bar styles height:2.8em; padding-top:10px; overflow:hidden; + font-size:12px; } .subNav { background-color:#dee3e9; - border-bottom:1px solid #9eadc0; float:left; width:100%; overflow:hidden; + font-size:12px; } .subNav div { clear:left; float:left; padding:0 0 5px 6px; + text-transform:uppercase; } ul.navList, ul.subNavList { float:left; @@ -157,27 +167,33 @@ ul.navList, ul.subNavList { ul.navList li{ list-style:none; float:left; - padding:3px 6px; + padding: 5px 6px; + text-transform:uppercase; } ul.subNavList li{ list-style:none; float:left; - font-size:90%; } .topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { color:#FFFFFF; text-decoration:none; + text-transform:uppercase; } .topNav a:hover, .bottomNav a:hover { text-decoration:none; color:#bb7a2a; + text-transform:uppercase; } .navBarCell1Rev { - background-image:url(resources/tab.gif); - background-color:#a88834; - color:#FFFFFF; + background-color:#F8981D; + color:#253441; margin: auto 5px; - border:1px solid #c9aa44; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; } /* Page header and footer styles @@ -191,8 +207,11 @@ Page header and footer styles margin:10px; position:relative; } +.indexHeader span{ + margin-right:15px; +} .indexHeader h1 { - font-size:1.3em; + font-size:13px; } .title { color:#2c4557; @@ -202,7 +221,7 @@ Page header and footer styles margin:5px 0 0 0; } .header ul { - margin:0 0 25px 0; + margin:0 0 15px 0; padding:0; } .footer ul { @@ -210,24 +229,22 @@ Page header and footer styles } .header ul li, .footer ul li { list-style:none; - font-size:1.2em; + font-size:13px; } /* Heading styles */ div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { background-color:#dee3e9; - border-top:1px solid #9eadc0; - border-bottom:1px solid #9eadc0; + border:1px solid #d0d9e0; margin:0 0 6px -8px; - padding:2px 5px; + padding:7px 5px; } ul.blockList ul.blockList ul.blockList li.blockList h3 { background-color:#dee3e9; - border-top:1px solid #9eadc0; - border-bottom:1px solid #9eadc0; + border:1px solid #d0d9e0; margin:0 0 6px -8px; - padding:2px 5px; + padding:7px 5px; } ul.blockList ul.blockList li.blockList h3 { padding:0; @@ -247,10 +264,10 @@ Page layout container styles .indexContainer { margin:10px; position:relative; - font-size:1.0em; + font-size:12px; } .indexContainer h2 { - font-size:1.1em; + font-size:13px; padding:0 0 3px 0; } .indexContainer ul { @@ -259,15 +276,18 @@ Page layout container styles } .indexContainer ul li { list-style:none; + padding-top:2px; } .contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { - font-size:1.1em; + font-size:12px; font-weight:bold; margin:10px 0 0 0; color:#4E4E4E; } .contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { - margin:10px 0 10px 20px; + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; } .serializedFormContainer dl.nameValue dt { margin-left:1px; @@ -306,25 +326,24 @@ ul.blockList, ul.blockListLast { } ul.blockList li.blockList, ul.blockListLast li.blockList { list-style:none; - margin-bottom:25px; + margin-bottom:15px; + line-height:1.4; } ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { padding:0px 20px 5px 10px; - border:1px solid #9eadc0; - background-color:#f9f9f9; + border:1px solid #ededed; + background-color:#f8f8f8; } ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { padding:0 0 5px 8px; background-color:#ffffff; - border:1px solid #9eadc0; - border-top:none; + border:none; } ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { margin-left:0; padding-left:0; padding-bottom:15px; border:none; - border-bottom:1px solid #9eadc0; } ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { list-style:none; @@ -338,107 +357,155 @@ table tr td dl, table tr td dl dt, table tr td dl dd { /* Table styles */ -.contentContainer table, .classUseContainer table, .constantValuesContainer table { - border-bottom:1px solid #9eadc0; - width:100%; -} -.contentContainer ul li table, .classUseContainer ul li table, .constantValuesContainer ul li table { +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; } -.contentContainer .description table, .contentContainer .details table { - border-bottom:none; -} -.contentContainer ul li table th.colOne, .contentContainer ul li table th.colFirst, .contentContainer ul li table th.colLast, .classUseContainer ul li table th, .constantValuesContainer ul li table th, .contentContainer ul li table td.colOne, .contentContainer ul li table td.colFirst, .contentContainer ul li table td.colLast, .classUseContainer ul li table td, .constantValuesContainer ul li table td{ - vertical-align:top; - padding-right:20px; -} -.contentContainer ul li table th.colLast, .classUseContainer ul li table th.colLast,.constantValuesContainer ul li table th.colLast, -.contentContainer ul li table td.colLast, .classUseContainer ul li table td.colLast,.constantValuesContainer ul li table td.colLast, -.contentContainer ul li table th.colOne, .classUseContainer ul li table th.colOne, -.contentContainer ul li table td.colOne, .classUseContainer ul li table td.colOne { - padding-right:3px; +.overviewSummary, .memberSummary { + padding:0px; } -.overviewSummary caption, .packageSummary caption, .contentContainer ul.blockList li.blockList caption, .summary caption, .classUseContainer caption, .constantValuesContainer caption { +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { position:relative; text-align:left; background-repeat:no-repeat; - color:#FFFFFF; + color:#253441; font-weight:bold; clear:none; overflow:hidden; padding:0px; + padding-top:10px; + padding-left:1px; margin:0px; -} -caption a:link, caption a:hover, caption a:active, caption a:visited { + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { color:#FFFFFF; } -.overviewSummary caption span, .packageSummary caption span, .contentContainer ul.blockList li.blockList caption span, .summary caption span, .classUseContainer caption span, .constantValuesContainer caption span { +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { white-space:nowrap; - padding-top:8px; - padding-left:8px; - display:block; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; float:left; - background-image:url(resources/titlebar.gif); - height:18px; + background-color:#F8981D; + border: none; + height:16px; } -.overviewSummary .tabEnd, .packageSummary .tabEnd, .contentContainer ul.blockList li.blockList .tabEnd, .summary .tabEnd, .classUseContainer .tabEnd, .constantValuesContainer .tabEnd { - width:10px; - background-image:url(resources/titlebar_end.gif); - background-repeat:no-repeat; - background-position:top right; - position:relative; +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; float:left; + background-color:#F8981D; + height:16px; } -ul.blockList ul.blockList li.blockList table { - margin:0 0 12px 0px; - width:100%; +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; } -.tableSubHeadingColor { - background-color: #EEEEFF; +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; } -.altColor { - background-color:#eeeeef; +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; } -.rowColor { - background-color:#ffffff; +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + } -.overviewSummary td, .packageSummary td, .contentContainer ul.blockList li.blockList td, .summary td, .classUseContainer td, .constantValuesContainer td { +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { text-align:left; - padding:3px 3px 3px 7px; + padding:0px 0px 12px 10px; + width:100%; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; } -th.colFirst, th.colLast, th.colOne, .constantValuesContainer th { +th.colFirst, th.colLast, th.colOne, .constantsSummary th { background:#dee3e9; - border-top:1px solid #9eadc0; - border-bottom:1px solid #9eadc0; text-align:left; - padding:3px 3px 3px 7px; -} -td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { - font-weight:bold; + padding:8px 3px 3px 7px; } td.colFirst, th.colFirst { - border-left:1px solid #9eadc0; white-space:nowrap; + font-size:13px; } td.colLast, th.colLast { - border-right:1px solid #9eadc0; + font-size:13px; } td.colOne, th.colOne { - border-right:1px solid #9eadc0; - border-left:1px solid #9eadc0; + font-size:13px; } -table.overviewSummary { - padding:0px; - margin-left:0px; -} -table.overviewSummary td.colFirst, table.overviewSummary th.colFirst, -table.overviewSummary td.colOne, table.overviewSummary th.colOne { +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ width:25%; - vertical-align:middle; + vertical-align:top; } -table.packageSummary td.colFirst, table.overviewSummary th.colFirst { - width:25%; - vertical-align:middle; +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; } /* Content styles @@ -453,6 +520,24 @@ Content styles .docSummary { padding:0; } + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} /* Formatting effect styles */ @@ -463,12 +548,27 @@ Formatting effect styles h1.hidden { visibility:hidden; overflow:hidden; - font-size:.9em; + font-size:10px; } .block { display:block; - margin:3px 0 0 0; + margin:3px 10px 2px 0px; + color:#474747; } -.strong { +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { font-weight:bold; } +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +}