com.atlassian.jira.webtest.webdriver.tests.plugin.auditing.fixtures

Class RestSupport.RestClient

java.lang.Object

com.atlassian.jira.webtest.webdriver.tests.plugin.auditing.fixtures.RestSupport.RestClient

Enclosing class:

RestSupport

protected class RestSupport.RestClient
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RestClient()

Method Summary

Modifier and Type	Method and Description
RestSupport.RestClient	as(String user, String password) Allows you to connect as a named user
RestSupport.RestClient	asAdmin() Allows you to connect admin/admin
RestSupport.RestClient	asFred()
org.codehaus.jackson.JsonNode	deleteJSON(String urlPath) Allows you to DELETE a resource on the URL path without a response
org.codehaus.jackson.JsonNode	deleteJSON(String urlPath, org.codehaus.jackson.JsonNode deleteJSON) Allows you to DELETE a resource on the URL path and return the JSON response
org.codehaus.jackson.JsonNode	deleteJSONWithContent(String urlPath) Allows you to DELETE a resource on the URL path and return the error JSON response
org.codehaus.jackson.JsonNode	deleteJSONWithError(String urlPath, org.codehaus.jackson.JsonNode deleteJSON, Integer statusCode) Allows you to DELETE a resource on the URL path and return the JSON response
org.codehaus.jackson.JsonNode	getJSON(String urlPath, Map<String,String> param) Allows you to GET a JSON AST from the resource on the URL path and return the JSON response
RestSupport.JsonOrStatusCode	getJSONOrStatusCode(String urlPath) Allows you to GET a JSON AST from the resource on the URL path and return the JSON response If the HTTP response code isn't 200, returns a pair of (HTTP_code, None)
org.codehaus.jackson.JsonNode	getJSONWithError(String urlPath, Integer statusCode) Allows you to GET a JSON AST from the resource on the URL path and return the error JSON response
String	getString(String urlPath) Allows you to GET a string from the resource on the URL path and return the String
org.codehaus.jackson.JsonNode	postJSON(String urlPath) Allows you to POST JSON to a resource on the URL path and return the JSON response
org.codehaus.jackson.JsonNode	postJSON(String urlPath, org.codehaus.jackson.JsonNode postJSON) Allows you to POST JSON to a resource on the URL path and return the JSON response
org.codehaus.jackson.JsonNode	postJSONWithError(String urlPath, org.codehaus.jackson.JsonNode postJSON, Integer statusCode) Allows you to POST JSON to a resource on the URL path and return the error JSON response
org.codehaus.jackson.JsonNode	putJSON(String urlPath) Allows you to PUT JSON to a resource on the URL path and return the JSON response
org.codehaus.jackson.JsonNode	putJSON(String urlPath, org.codehaus.jackson.JsonNode putJSON) Allows you to PUT JSON to a resource on the URL path and return the JSON response
org.codehaus.jackson.JsonNode	putJSONWithError(String urlPath, org.codehaus.jackson.JsonNode putJSON, Integer statusCode) Allows you to PUT JSON to a resource on the URL path and return the error JSON response
com.sun.jersey.api.client.WebResource	resource(String urlPath, Map<String,String> param) Allows you to obtain a resource for the URL path so you can work on it, for example GETing it or POSTing to it

Methods inherited from class java.lang.Object

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

Constructor Detail

RestClient

protected RestClient()

Method Detail

as

public RestSupport.RestClient as(String user,
                                 String password)

Allows you to connect as a named user

Parameters:

user - who to connect as

password - their password

Returns:

itself

asAdmin

public RestSupport.RestClient asAdmin()

Allows you to connect admin/admin

asFred

public RestSupport.RestClient asFred()

resource

public com.sun.jersey.api.client.WebResource resource(String urlPath,
                                                      Map<String,String> param)

Allows you to obtain a resource for the URL path so you can work on it, for example GETing it or POSTing to it

Parameters:

urlPath - this does NOT include the host name or context path

Returns:

a http resource

getJSON

public org.codehaus.jackson.JsonNode getJSON(String urlPath,
                                             Map<String,String> param)

Allows you to GET a JSON AST from the resource on the URL path and return the JSON response

Parameters:

urlPath - this does NOT include the host name or context path

Returns:

a parsed JSON Ast

Throws:

ParsingException - is if the JSON cannot be parsed

getJSONOrStatusCode

public RestSupport.JsonOrStatusCode getJSONOrStatusCode(String urlPath)

Allows you to GET a JSON AST from the resource on the URL path and return the JSON response If the HTTP response code isn't 200, returns a pair of (HTTP_code, None)

getString

public String getString(String urlPath)

Allows you to GET a string from the resource on the URL path and return the String

Parameters:

urlPath - this does NOT include the host name or context path

Returns:

a parsed JSON Ast

Throws:

ParsingException - is if the JSON cannot be parsed

getJSONWithError

public org.codehaus.jackson.JsonNode getJSONWithError(String urlPath,
                                                      Integer statusCode)

Allows you to GET a JSON AST from the resource on the URL path and return the error JSON response

Parameters:

urlPath - this does NOT include the host name or context path

Returns:

a parsed JSON Ast

Throws:

ParsingException - is if the JSON cannot be parsed

deleteJSON

public org.codehaus.jackson.JsonNode deleteJSON(String urlPath,
                                                org.codehaus.jackson.JsonNode deleteJSON)

Allows you to DELETE a resource on the URL path and return the JSON response

Parameters:

urlPath - this does NOT include the host name or context path

deleteJSON - the json to send to the DELETE method

Returns:

a parsed JSON AST response

Throws:

ParsingException - is if the JSON cannot be parsed

deleteJSON

public org.codehaus.jackson.JsonNode deleteJSON(String urlPath)

Allows you to DELETE a resource on the URL path without a response

Parameters:

urlPath - this does NOT include the host name or context path

Throws:

ParsingException - is if the JSON cannot be parsed

deleteJSONWithContent

public org.codehaus.jackson.JsonNode deleteJSONWithContent(String urlPath)

Allows you to DELETE a resource on the URL path and return the error JSON response

Parameters:

urlPath - this does NOT include the host name or context path

Returns:

a parsed JSON AST response

Throws:

ParsingException - is if the JSON cannot be parsed

deleteJSONWithError

public org.codehaus.jackson.JsonNode deleteJSONWithError(String urlPath,
                                                         org.codehaus.jackson.JsonNode deleteJSON,
                                                         Integer statusCode)

Allows you to DELETE a resource on the URL path and return the JSON response

Parameters:

urlPath - this does NOT include the host name or context path

Returns:

a parsed JSON AST response

Throws:

ParsingException - is if the JSON cannot be parsed

postJSON

public org.codehaus.jackson.JsonNode postJSON(String urlPath)

Allows you to POST JSON to a resource on the URL path and return the JSON response

Parameters:

urlPath - this does NOT include the host name or context path

Returns:

a parsed JSON AST response

Throws:

ParsingException - is if the JSON cannot be parsed

postJSON

public org.codehaus.jackson.JsonNode postJSON(String urlPath,
                                              org.codehaus.jackson.JsonNode postJSON)

Allows you to POST JSON to a resource on the URL path and return the JSON response

Parameters:

urlPath - this does NOT include the host name or context path

postJSON - the json to post

Returns:

a parsed JSON AST response

Throws:

ParsingException - is if the JSON cannot be parsed

postJSONWithError

public org.codehaus.jackson.JsonNode postJSONWithError(String urlPath,
                                                       org.codehaus.jackson.JsonNode postJSON,
                                                       Integer statusCode)

Allows you to POST JSON to a resource on the URL path and return the error JSON response

Parameters:

urlPath - this does NOT include the host name or context path

postJSON - the json to post

Returns:

a parsed JSON AST response

Throws:

ParsingException - is if the JSON cannot be parsed

putJSON

public org.codehaus.jackson.JsonNode putJSON(String urlPath)

Allows you to PUT JSON to a resource on the URL path and return the JSON response

Parameters:

urlPath - this does NOT include the host name or context path

Returns:

a parsed JSON AST response

Throws:

ParsingException - is if the JSON cannot be parsed

putJSON

public org.codehaus.jackson.JsonNode putJSON(String urlPath,
                                             org.codehaus.jackson.JsonNode putJSON)

Allows you to PUT JSON to a resource on the URL path and return the JSON response

Parameters:

urlPath - this does NOT include the host name or context path

putJSON - the json to put

Returns:

a parsed JSON AST response

Throws:

ParsingException - is if the JSON cannot be parsed

putJSONWithError

public org.codehaus.jackson.JsonNode putJSONWithError(String urlPath,
                                                      org.codehaus.jackson.JsonNode putJSON,
                                                      Integer statusCode)

Allows you to PUT JSON to a resource on the URL path and return the error JSON response

Parameters:

urlPath - this does NOT include the host name or context path

putJSON - the json to put

Returns:

a parsed JSON AST response

Throws:

ParsingException - is if the JSON cannot be parsed