WsStep (QAF Web Services Support

java.lang.Object
- com.qmetry.qaf.automation.step.WsStep

```
public final class WsStep
extends java.lang.Object
```
com.qmetry.qaf.automation.step.CommonStep.java

Author:

chirag

Constructor Summary

Constructors
Constructor and Description

WsStep()

Constructors
Constructor and Description
`WsStep()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`downloadFileFromResponse(java.lang.String name, com.sun.jersey.api.client.ClientResponse response)` This method downloads and save file from the response in report directory for current execution.
`static com.sun.jersey.api.client.ClientResponse`	`request(WsRequestBean bean)`
`static void`	`responseHasNotValueAtXpath(java.lang.Object val, java.lang.String xpath)` This is assertion method to check value is not at XPATH in response status of web service.
`static void`	`responseHasNotXpath(java.lang.String xpath)` This assertion method check given Xpath is not there in response status of web service.
`static void`	`responseHasValueAtJsonpath(java.lang.Object val, java.lang.String jsonpath)` This is assertion method to check value at jsonpath in response status of web service.
`static void`	`responseHasValueAtXpath(java.lang.Object val, java.lang.String xpath)` This is assertion method to check value at XPATH in response status of web service.
`static void`	`responseHasValueNotAtJsonpath(java.lang.Object val, java.lang.String jsonpath)` This is assertion method to check value is not at jsonpath in response status of web service.
`static void`	`responseHasXpath(java.lang.String xpath)` This assertion method check given Xpath is there in response status of web service.
`static void`	`responseShouldGreaterThan(double expectedValue, java.lang.String path)` This method validates that value at jsonpath should be greater than expectedvalue
`static void`	`responseShouldGreaterThanOrEqualsTo(double expectedValue, java.lang.String path)` This method validates that value at jsonpath should be greater than or equal to expectedvalue
`static void`	`responseShouldHaveHeader(java.lang.String header)` This method check given header is there in response of web service
`static void`	`responseShouldHaveHeaderWithValue(java.lang.String header, java.lang.String value)` This method check given header with specific value present in response of web service
`static void`	`responseShouldHaveJsonPath(java.lang.String path)` This method check given jsonpath is there in response of web service
`static void`	`responseShouldHaveKeyAndValueContains(java.lang.String value, java.lang.String path)` This method validates value of jsonpath contains expected value or not
`static void`	`responseShouldHaveKeyWithValue(java.lang.Object expectedValue, java.lang.String path)` This method validates value for given jsonpath
`static void`	`responseShouldHaveStatus(java.lang.String status)` This method check for the response status of web service
`static void`	`responseShouldHaveStatusCode(int statusCode)` This method check for the response status of web service
`static void`	`responseShouldHaveValueAtJsonpath(java.lang.Object val, java.lang.String jsonpath)` This is verification method to check value at jsonpath in response status of web service.
`static void`	`responseShouldHaveValueAtXpath(java.lang.Object val, java.lang.String xpath)` This is verification method to check value at XPATH in response status of web service.
`static void`	`responseShouldHaveValueContainsIgnoringCase(java.lang.String expectedValue, java.lang.String path)` This method validates value at jsonpath contains expected value with ignoring case or not
`static void`	`responseShouldHaveValueIgnoringCase(java.lang.String expectedValue, java.lang.String path)` This method validates value at jsonpath equals to expected value with ignoring case or not
`static void`	`responseShouldHaveValueMatchesWith(java.lang.String regEx, java.lang.String path)` This method validates value of jsonpath matches with regEx value or not
`static void`	`responseShouldHaveXpath(java.lang.String xpath)` This is verification method to check given Xpath is there in response status of web service.
`static void`	`responseShouldLessThan(double expectedValue, java.lang.String path)` This method validates that value at jsonpath should be less than expectedvalue
`static void`	`responseShouldLessThanOrEqualsTo(double expectedValue, java.lang.String path)` This method validates that value at jsonpath should be less than or equal to expectedvalue
`static void`	`responseShouldNotHaveJsonPath(java.lang.String path)` This method check given jsonpath is not in response of web service
`static void`	`responseShouldNotHaveValue(java.lang.Object expectedValue, java.lang.String path)` This method validates value of jsonpath is not equal to expected value
`static void`	`responseShouldNotHaveValueAtJsonpath(java.lang.Object val, java.lang.String jsonpath)` This is verification method to check value is not at jsonpath in response status of web service.
`static void`	`responseShouldNotHaveValueAtXpath(java.lang.Object val, java.lang.String xpath)` This is verification method to check value at XPATH in response status of web service.
`static void`	`responseShouldNotHaveXpath(java.lang.String xpath)` This is verification method to check given Xpath is not there in response status of web service.
`static void`	`sayValueAtJsonPath(java.lang.String variable, java.lang.String path)` This method store value of given json path to `ConfigurationManager`
`static void`	`sayValueAtXPath(java.lang.String variable, java.lang.String path)` This method store value of given xpath to `ConfigurationManager`
`static void`	`storeResponseBodyto(java.lang.String path, java.lang.String variable)` Deprecated. user `sayValueAtJsonPath(String, String)`
`static void`	`storeResponseHeaderTo(java.lang.String header, java.lang.String property)` This method store value of given header to `ConfigurationManager`
`static com.sun.jersey.api.client.ClientResponse`	`userRequests(java.lang.Object request)` This method request for the given parameters
`static com.sun.jersey.api.client.ClientResponse`	`userRequests(java.lang.Object request, java.util.Map<java.lang.String,java.lang.Object> data)` This method request for given parameters with given dataset
`static boolean`	`verifyResponseSchema(java.lang.String requestKey)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WsStep
```
public WsStep()
```
- Method Detail
  - responseShouldHaveStatus
```
public static void responseShouldHaveStatus(java.lang.String status)
```
    This method check for the response status of web service
    Example:
    BDD
    response should have status 'ResponceStatus'
    KWD
    
    Parameters:
    
    status - : {0} : Status String for Exampe: OK, CREATED
    
    See Also:
    
    ClientResponse.Status
  - responseShouldHaveStatusCode
```
public static void responseShouldHaveStatusCode(int statusCode)
```
    This method check for the response status of web service
    Example:
    BDD
    response should have status 'ResponceStatus'
    KWD
    
    Parameters:
    
    status - : {0} : Status code, for example 200, 301
    
    See Also:
    
    ClientResponse.Status
  - userRequests
```
public static com.sun.jersey.api.client.ClientResponse userRequests(java.lang.Object request)
```
    This method request for the given parameters
    
    Parameters:
    
    request - key or map
    
    Returns:
  - userRequests
```
public static com.sun.jersey.api.client.ClientResponse userRequests(java.lang.Object request,
                                                                    java.util.Map<java.lang.String,java.lang.Object> data)
```
    This method request for given parameters with given dataset
    
    Parameters:
    
    request - key or map
    
    data - data set of key value pair
    
    Returns:
  - responseShouldHaveHeader
```
public static void responseShouldHaveHeader(java.lang.String header)
```
    This method check given header is there in response of web service
    Example:
    BDD
    response should have header 'Content-Type'
    
    Parameters:
    
    header - : header to be verified in respose
  - responseShouldHaveHeaderWithValue
```
public static void responseShouldHaveHeaderWithValue(java.lang.String header,
                                                     java.lang.String value)
```
    This method check given header with specific value present in response of web service
    Example:
    BDD
    response should have header 'Content-Type' with value 'application/json'
    
    Parameters:
    
    header - : header to be present in respose
    
    value - : value to be verified for header
  - responseShouldHaveJsonPath
```
public static void responseShouldHaveJsonPath(java.lang.String path)
```
    This method check given jsonpath is there in response of web service
    Example:
    response should have 'user.username'
    
    Parameters:
    
    path - : jsonpath
  - responseShouldNotHaveJsonPath
```
public static void responseShouldNotHaveJsonPath(java.lang.String path)
```
    This method check given jsonpath is not in response of web service
    Example:
    response should not have 'user.username'
    
    Parameters:
    
    path - : jsonpath
  - responseShouldHaveKeyWithValue
```
public static void responseShouldHaveKeyWithValue(java.lang.Object expectedValue,
                                                  java.lang.String path)
```
    This method validates value for given jsonpath
    Example:
    response should have 'admin' at 'user.username'
    
    Parameters:
    
    expectedValue - : expected value
    
    path - : jsonpath
  - storeResponseBodyto
```
public static void storeResponseBodyto(java.lang.String path,
                                       java.lang.String variable)
```
    Deprecated. user sayValueAtJsonPath(String, String)
    
    This method store value of given json path to ConfigurationManager
    Example:
    store response body 'user.username' to 'loginuser'
    
    Parameters:
    
    path - jsonpath
    
    variable - variable that can be use later
  - responseShouldHaveKeyAndValueContains
```
public static void responseShouldHaveKeyAndValueContains(java.lang.String value,
                                                         java.lang.String path)
```
    This method validates value of jsonpath contains expected value or not
    Example:
    response should have value contains 'admin' at 'user.username'
    
    Parameters:
    
    value - : expected value
    
    path - : jsonpath
  - storeResponseHeaderTo
```
public static void storeResponseHeaderTo(java.lang.String header,
                                         java.lang.String property)
```
    This method store value of given header to ConfigurationManager
    Example:
    store response header 'X-Auth-token' to 'token'
    
    Parameters:
    
    header - header
    
    property - variable that can be use later
  - responseShouldLessThan
```
public static void responseShouldLessThan(double expectedValue,
                                          java.lang.String path)
```
    This method validates that value at jsonpath should be less than expectedvalue
    Example:
    response should be less than 500 at 'student.totalmarks'
    
    Parameters:
    
    value - : expected value
    
    path - : jsonpath
  - downloadFileFromResponse
```
public static void downloadFileFromResponse(java.lang.String name,
                                            com.sun.jersey.api.client.ClientResponse response)
                                     throws java.io.IOException
```
    This method downloads and save file from the response in report directory for current execution.
    BDD Example:
```
 
    Given user requests "download.file.req"
    And store into 'file.response'
    Then save file as "logo.png" from "${file.response}"
 
 
```
    Java Example:
```
 
    ClientResponse response  = userRequests("download.file.req");
    downloadFileFromResponse("logo.png", response);
 
 
```
    Parameters:
    
    name -
    
    response -
    
    Throws:
    
    java.io.IOException
  - responseShouldLessThanOrEqualsTo
```
public static void responseShouldLessThanOrEqualsTo(double expectedValue,
                                                    java.lang.String path)
```
    This method validates that value at jsonpath should be less than or equal to expectedvalue
    Example:
    response should be less than or equals to 500 at 'student.totalmarks'
    
    Parameters:
    
    value - : expected value
    
    path - : jsonpath
  - responseShouldGreaterThan
```
public static void responseShouldGreaterThan(double expectedValue,
                                             java.lang.String path)
```
    This method validates that value at jsonpath should be greater than expectedvalue
    Example:
    response should be greater than 500 at 'student.totalmarks'
    
    Parameters:
    
    value - : expected value
    
    path - : jsonpath
  - responseShouldGreaterThanOrEqualsTo
```
public static void responseShouldGreaterThanOrEqualsTo(double expectedValue,
                                                       java.lang.String path)
```
    This method validates that value at jsonpath should be greater than or equal to expectedvalue
    Example:
    response should be greater than or equals to 500 at 'student.totalmarks'
    
    Parameters:
    
    value - : expected value
    
    path - : jsonpath
  - responseShouldHaveValueIgnoringCase
```
public static void responseShouldHaveValueIgnoringCase(java.lang.String expectedValue,
                                                       java.lang.String path)
```
    This method validates value at jsonpath equals to expected value with ignoring case or not
    Example:
    response should have value ignoring case 'admin' at 'user.username'
    
    Parameters:
    
    value - : expected value
    
    path - : jsonpath
  - responseShouldHaveValueContainsIgnoringCase
```
public static void responseShouldHaveValueContainsIgnoringCase(java.lang.String expectedValue,
                                                               java.lang.String path)
```
    This method validates value at jsonpath contains expected value with ignoring case or not
    Example:
    response should have value contains ignoring case 'admin' at 'user.username'
    
    Parameters:
    
    value - : expected value
    
    path - : jsonpath
  - responseShouldHaveValueMatchesWith
```
public static void responseShouldHaveValueMatchesWith(java.lang.String regEx,
                                                      java.lang.String path)
```
    This method validates value of jsonpath matches with regEx value or not
    Example:
    response should have value matches with '[a-z]*' at 'user.username'
    
    Parameters:
    
    value - : expected value
    
    path - : jsonpath
  - responseShouldNotHaveValue
```
public static void responseShouldNotHaveValue(java.lang.Object expectedValue,
                                              java.lang.String path)
```
    This method validates value of jsonpath is not equal to expected value
    Example:
    response should not have value 'admin' at 'user.username'
    
    Parameters:
    
    value - : expected value
    
    path - : jsonpath
  - verifyResponseSchema
```
public static boolean verifyResponseSchema(java.lang.String requestKey)
```
  - responseShouldHaveValueAtJsonpath
```
public static void responseShouldHaveValueAtJsonpath(java.lang.Object val,
                                                     java.lang.String jsonpath)
```
    This is verification method to check value at jsonpath in response status of web service. It will continue test case even if failure. It uses StringMatcher to match expected vs actual values. You can specify matcher by providing prefix separated by ':', For example, 'containsIgnoringCase:someValue' will use StringMatcher.containsIgnoringCase(String) Default is StringMatcher.exact(String)
    Example:
    BDD
    response should have value '1.90' at jsonpath '$.Price' response should have value 'gte:1.90' at jsonpath '$.Price'
    KWD
    
    Parameters:
    
    val - : {val} : value to be verified in response
    
    jsonpath - : {jsonpath} : jsonpath to look value in response
  - responseShouldNotHaveValueAtJsonpath
```
public static void responseShouldNotHaveValueAtJsonpath(java.lang.Object val,
                                                        java.lang.String jsonpath)
```
    This is verification method to check value is not at jsonpath in response status of web service. It will continue test case even if failure. It uses StringMatcher to match expected vs actual values. You can specify matcher by providing prefix separated by ':', For example, 'containsIgnoringCase:someValue' will use StringMatcher.containsIgnoringCase(String) Default is StringMatcher.exact(String)
    Example:
    BDD
    response should not have value '1.90' at jsonpath '$.Price' response should not have value 'gte:1.90' at jsonpath '$.Price'
    KWD
    
    Parameters:
    
    val - : {val} : value to be verified in response
    
    jsonpath - : {jsonpath} : jsonpath to look value in response
  - responseHasValueAtJsonpath
```
public static void responseHasValueAtJsonpath(java.lang.Object val,
                                              java.lang.String jsonpath)
```
    This is assertion method to check value at jsonpath in response status of web service. It will break test case on failure. It uses StringMatcher to match expected vs actual values. You can specify matcher by providing prefix separated by ':', For example, 'containsIgnoringCase:someValue' will use StringMatcher.containsIgnoringCase(String) Default is StringMatcher.exact(String)
    Example:
    BDD
    response has value '1.90' at jsonpath '$.Price' response has value 'gte:1.90' at jsonpath '$.Price'
    KWD
    
    Parameters:
    
    val - : {val} : value to be verified in response
    
    jsonpath - : {jsonpath} : jsonpath to look value in response
  - responseHasValueNotAtJsonpath
```
public static void responseHasValueNotAtJsonpath(java.lang.Object val,
                                                 java.lang.String jsonpath)
```
    This is assertion method to check value is not at jsonpath in response status of web service. It will break test case on failure. It uses StringMatcher to match expected vs actual values. You can specify matcher by providing prefix separated by ':', For example, 'containsIgnoringCase:someValue' will use StringMatcher.containsIgnoringCase(String) Default is StringMatcher.exact(String)
    Example:
    BDD
    response has not value '1.90' at jsonpath '$.Price' response has not value 'gte:1.90' at jsonpath '$.Price'
    KWD
    
    Parameters:
    
    val - : {val} : value to be verified in response
    
    jsonpath - : {jsonpath} : jsonpath to look value in response
  - sayValueAtJsonPath
```
public static void sayValueAtJsonPath(java.lang.String variable,
                                      java.lang.String path)
```
    This method store value of given json path to ConfigurationManager
    Example:
    say 'loginuser' is value at jsonpath 'user.username'
    
    Parameters:
    
    variable - variable that can be use later
    
    path - jsonpath
  - responseShouldHaveXpath
```
public static void responseShouldHaveXpath(java.lang.String xpath)
```
    This is verification method to check given Xpath is there in response status of web service. It will continue test case even if failure.
    Example:
    BDD
    response should have xpath 'Xpath String'
    KWD
    
    Parameters:
    
    xpath - : {0} : xpath string to be verified in response
  - responseShouldNotHaveXpath
```
public static void responseShouldNotHaveXpath(java.lang.String xpath)
```
    This is verification method to check given Xpath is not there in response status of web service. It will continue test case even if failure.
    Example:
    BDD
    response should not have xpath 'Xpath String'
    KWD
    
    Parameters:
    
    xpath - : {0} : xpath to be verified in response
  - responseShouldHaveValueAtXpath
```
public static void responseShouldHaveValueAtXpath(java.lang.Object val,
                                                  java.lang.String xpath)
```
    This is verification method to check value at XPATH in response status of web service. It will continue test case even if failure. It uses StringMatcher to match expected vs actual values. You can specify matcher by providing prefix separated by ':', For example, 'containsIgnoringCase:someValue' will use StringMatcher.containsIgnoringCase(String) Default is StringMatcher.exact(String)
    Example:
    BDD
    response should have value '1.90' at xpath '//Price' response should have value 'gte:1.90' at xpath '//Price'
    KWD
    
    Parameters:
    
    val - : {val} : value to be verified in response
    
    xpath - : {xpath} : xpath to look value in response
  - responseShouldNotHaveValueAtXpath
```
public static void responseShouldNotHaveValueAtXpath(java.lang.Object val,
                                                     java.lang.String xpath)
```
    This is verification method to check value at XPATH in response status of web service. It will continue test case even if failure. It uses StringMatcher to match expected vs actual values. You can specify matcher by providing prefix separated by ':', For example, 'containsIgnoringCase:someValue' will use StringMatcher.containsIgnoringCase(String) Default is StringMatcher.exact(String)
    Example:
    BDD
    response should have value '1.90' at xpath '//Price' response should have value 'gte:1.90' at xpath '//Price'
    KWD
    
    Parameters:
    
    val - : {val} : value to be verified in response
    
    xpath - : {xpath} : xpath to look value in response
  - responseHasXpath
```
public static void responseHasXpath(java.lang.String xpath)
```
    This assertion method check given Xpath is there in response status of web service. It will break test case on failure.
    Example:
    BDD
    response should have xpath 'Xpath String'
    KWD
    
    Parameters:
    
    xpath - : {0} : xpath string to be verified in response
  - responseHasNotXpath
```
public static void responseHasNotXpath(java.lang.String xpath)
```
    This assertion method check given Xpath is not there in response status of web service. It will break test case on failure.
    Example:
    BDD
    response has not xpath 'Xpath String'
    KWD
    
    Parameters:
    
    xpath - : {0} : xpath to be verified in response
  - responseHasValueAtXpath
```
public static void responseHasValueAtXpath(java.lang.Object val,
                                           java.lang.String xpath)
```
    This is assertion method to check value at XPATH in response status of web service. It will break test case on failure. It uses StringMatcher to match expected vs actual values. You can specify matcher by providing prefix separated by ':', For example, 'containsIgnoringCase:someValue' will use StringMatcher.containsIgnoringCase(String) Default is StringMatcher.exact(String)
    Example:
    BDD
    response has value '1.90' at xpath '//Price' response has value 'gte:1.90' at xpath '//Price'
    KWD
    
    Parameters:
    
    val - : {val} : value to be verified in response
    
    xpath - : {xpath} : xpath to look value in response
  - responseHasNotValueAtXpath
```
public static void responseHasNotValueAtXpath(java.lang.Object val,
                                              java.lang.String xpath)
```
    This is assertion method to check value is not at XPATH in response status of web service. It will break test case on failure. It uses StringMatcher to match expected vs actual values. You can specify matcher by providing prefix separated by ':', For example, 'containsIgnoringCase:someValue' will use StringMatcher.containsIgnoringCase(String) Default is StringMatcher.exact(String)
    Example:
    BDD
    response has not value '1.90' at xpath '//Price' response has not value 'gte:1.90' at xpath '//Price'
    KWD
    
    Parameters:
    
    val - : {val} : value to be verified in response
    
    xpath - : {xpath} : xpath to look value in response
  - sayValueAtXPath
```
public static void sayValueAtXPath(java.lang.String variable,
                                   java.lang.String path)
```
    This method store value of given xpath to ConfigurationManager
    Example:
    say 'loginuser' is value at xpath '//user/username'
    
    Parameters:
    
    variable - variable that can be use later
    
    path - xpath
  - request
```
public static com.sun.jersey.api.client.ClientResponse request(WsRequestBean bean)
```

Class WsStep

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WsStep

Method Detail

responseShouldHaveStatus

responseShouldHaveStatusCode

userRequests

userRequests

responseShouldHaveHeader

responseShouldHaveHeaderWithValue

responseShouldHaveJsonPath

responseShouldNotHaveJsonPath

responseShouldHaveKeyWithValue

storeResponseBodyto

responseShouldHaveKeyAndValueContains

storeResponseHeaderTo

responseShouldLessThan

downloadFileFromResponse

responseShouldLessThanOrEqualsTo

responseShouldGreaterThan

responseShouldGreaterThanOrEqualsTo

responseShouldHaveValueIgnoringCase

responseShouldHaveValueContainsIgnoringCase

responseShouldHaveValueMatchesWith

responseShouldNotHaveValue

verifyResponseSchema

responseShouldHaveValueAtJsonpath

responseShouldNotHaveValueAtJsonpath

responseHasValueAtJsonpath

responseHasValueNotAtJsonpath

sayValueAtJsonPath

responseShouldHaveXpath

responseShouldNotHaveXpath

responseShouldHaveValueAtXpath

responseShouldNotHaveValueAtXpath

responseHasXpath

responseHasNotXpath

responseHasValueAtXpath

responseHasNotValueAtXpath

sayValueAtXPath

request