com.perfectomobile.perfectomobilejenkins.connection.rest

Class RestServices

java.lang.Object

com.perfectomobile.perfectomobilejenkins.connection.rest.RestServices

public class RestServices
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RestServices()

Method Summary

Methods

Modifier and Type	Method and Description
com.sun.jersey.api.client.ClientResponse	downloadExecutionReport(String url, String accessId, String secretKey, String reportKey) Gets the status of the running or recently completed execution Request/Response Example: -Request: https://mycloud.perfectomobile.com/services/reports/? operation=download&user=value&password=value
com.sun.jersey.api.client.ClientResponse	executeScript(String url, String accessId, String secretKey, String script, String optinalParameters) Starts a new asynchronous execution of the specified script and returns immediately with the response data.
com.sun.jersey.api.client.ClientResponse	getExecutionStatus(String url, String accessId, String secretKey, String executionId) Gets the status of the running or recently completed execution Request/Response Example: -Request: https://mycloud.perfectomobile.com/services/executions/? operation=status&user=value&password=value -Response: {"failedValidations":"0","flowEndCode":"Failed","reason":"ParseError" ,"status":"Completed", "description":"Completed","failedActions":"0", "executionId" :"jenkins@perfectomobile.com_variables_13-12-23_12_59_54_8082", "reportKey":"PRIVATE:variables_13-12-23_12_59_54_8082.xml", "completionDescription":"variable/parameter DUT has no value", "progressPercentage" :"0.0","user":"jenkins@perfectomobile.com","completed":"true"}
com.sun.jersey.api.client.ClientResponse	getHandsets(String url, String accessId, String secretKey) Get List of available devices.
static RestServices	getInstance()
javax.ws.rs.core.MultivaluedMap<String,String>	getQueryParamForOptinalParameters(String optinalParameters) This method gets parameters as they appears in Jenkins textarea field and returns Map object that holds parameter name and parameter value.
com.sun.jersey.api.client.ClientResponse	getRepoScripts(String url, String accessId, String secretKey) Get list of available scripts Example: https://www.perfectomobile.com/services/repositories/scripts? operation=list &user=jenkins@perfectomobile.com&password=Perfecto1&responseFormat=xml
com.sun.jersey.api.client.ClientResponse	getRepoScriptsItems(String url, String accessId, String secretKey, String script) Get script variables Example: https://www.perfectomobile.com/services/repositories /scripts/PRIVATE:variables.xml? operation=download&user=jenkins@perfectomobile.com&password=Perfecto1
void	setLogger(PrintStream logger)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestServices

protected RestServices()

Method Detail

getInstance

public static RestServices getInstance()

setLogger

public void setLogger(PrintStream logger)

getHandsets

public com.sun.jersey.api.client.ClientResponse getHandsets(String url,
                                                   String accessId,
                                                   String secretKey)
                                                     throws IOException,
                                                            javax.servlet.ServletException

Get List of available devices.

Parameters:

url -

accessId -

secretKey -

Returns:

Throws:

IOException

javax.servlet.ServletException

getRepoScripts

public com.sun.jersey.api.client.ClientResponse getRepoScripts(String url,
                                                      String accessId,
                                                      String secretKey)
                                                        throws IOException,
                                                               javax.servlet.ServletException

Get list of available scripts Example: https://www.perfectomobile.com/services/repositories/scripts? operation=list &user=jenkins@perfectomobile.com&password=Perfecto1&responseFormat=xml

Parameters:

url -

accessId -

secretKey -

Returns:

Throws:

IOException

javax.servlet.ServletException

getRepoScriptsItems

public com.sun.jersey.api.client.ClientResponse getRepoScriptsItems(String url,
                                                           String accessId,
                                                           String secretKey,
                                                           String script)
                                                             throws IOException,
                                                                    javax.servlet.ServletException

Get script variables Example: https://www.perfectomobile.com/services/repositories /scripts/PRIVATE:variables.xml? operation=download&user=jenkins@perfectomobile.com&password=Perfecto1

Parameters:

url -

accessId -

secretKeyprintRequest -

script -

Returns:

Throws:

IOException

javax.servlet.ServletException

executeScript

public com.sun.jersey.api.client.ClientResponse executeScript(String url,
                                                     String accessId,
                                                     String secretKey,
                                                     String script,
                                                     String optinalParameters)
                                                       throws IOException,
                                                              javax.servlet.ServletException

Starts a new asynchronous execution of the specified script and returns immediately with the response data. Request/Response Example: -Request: https://mycloud.perfectomobile.com/services/executions? operation=execute& scriptKey=value&user=value&password=value[&optionalParameter=value] -Response: {"executionId": "jenkins@perfectomobile.com_variables_13-12-23_12_59_54_8082", "reportKey":"PRIVATE:variables_13-12-23_12_59_54_8082.xml"}

Parameters:

url -

accessId -

secretKey -

script -

optinalParameters -

Returns:

Throws:

IOException

javax.servlet.ServletException

See Also:

http://help.perfectomobile.com/article/AA-00209/0

getExecutionStatus

public com.sun.jersey.api.client.ClientResponse getExecutionStatus(String url,
                                                          String accessId,
                                                          String secretKey,
                                                          String executionId)
                                                            throws IOException,
                                                                   javax.servlet.ServletException

Gets the status of the running or recently completed execution Request/Response Example: -Request: https://mycloud.perfectomobile.com/services/executions/? operation=status&user=value&password=value -Response: {"failedValidations":"0","flowEndCode":"Failed","reason":"ParseError" ,"status":"Completed", "description":"Completed","failedActions":"0", "executionId" :"jenkins@perfectomobile.com_variables_13-12-23_12_59_54_8082", "reportKey":"PRIVATE:variables_13-12-23_12_59_54_8082.xml", "completionDescription":"variable/parameter DUT has no value", "progressPercentage" :"0.0","user":"jenkins@perfectomobile.com","completed":"true"}

Parameters:

url -

accessId -

secretKey -

executionId -

Returns:

Throws:

IOException

javax.servlet.ServletException

See Also:

://help.perfectomobile.com/article/AA-00303/51/Guides-Documentation /HTTP-API/Operations/Script-Operations/02.-Get-Execution-Status.html

downloadExecutionReport

public com.sun.jersey.api.client.ClientResponse downloadExecutionReport(String url,
                                                               String accessId,
                                                               String secretKey,
                                                               String reportKey)
                                                                 throws IOException,
                                                                        javax.servlet.ServletException

Gets the status of the running or recently completed execution Request/Response Example: -Request: https://mycloud.perfectomobile.com/services/reports/? operation=download&user=value&password=value

Parameters:

url -

accessId -

secretKey -

reportKey -

Returns:

Throws:

IOException

javax.servlet.ServletException

See Also:

http://help.perfectomobile.com/article/AA-00308/0

getQueryParamForOptinalParameters

public javax.ws.rs.core.MultivaluedMap<String,String> getQueryParamForOptinalParameters(String optinalParameters)

This method gets parameters as they appears in Jenkins textarea field and returns Map object that holds parameter name and parameter value. Each parameter has a prefix of "param."

Parameters:

optinalParameters -

Returns:

Map object that holds parameter name and parameter value. For example "param.timeout=10"