HTTP (Selenified Testing Framework 3.0.0-SNAPSHOT API)

java.lang.Object
- com.coveros.selenified.services.HTTP

```
public class HTTP
extends Object
```
A class designed to make HTTP calls. This is wrapped by the Action and Assert classes to ensure calls are properly written to logs, and data can be easily accessed

Version:

3.0.0

Author:

Max Saperstone

Constructor Summary

Constructors
Constructor and Description
`HTTP(String serviceBaseUrl)` Instantiates a HTTP session for making web service calls without any authentication
`HTTP(String serviceBaseUrl, String user, String pass)` Instantiates a HTTP session for making web service calls with basic username/password authentication

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Response`	`delete(String service)` A basic http delete call
`Response`	`delete(String service, Request request)` A basic http delete call
`Response`	`get(String service)` A basic http get call
`Response`	`get(String service, Request request)` A basic http get call
`String`	`getPass()` Retrieves the password used for authentication with the application.
`String`	`getServiceBaseUrl()` Retrieves the base url of the services location
`String`	`getUser()` Retrieves the username used for authentication with the application.
`Response`	`patch(String service, Request request)` A basic http patch call
`Response`	`post(String service, Request request)` A basic http post call
`Response`	`put(String service, Request request)` A basic http put call
`boolean`	`useCredentials()` Determines whether or not authentication should be used, by checking to see if both username and password are set

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

- Constructor Detail
  - HTTP
```
public HTTP(String serviceBaseUrl)
```
    Instantiates a HTTP session for making web service calls without any authentication
    
    Parameters:
    
    serviceBaseUrl - - the base url of the services location
  - HTTP
```
public HTTP(String serviceBaseUrl,
            String user,
            String pass)
```
    Instantiates a HTTP session for making web service calls with basic username/password authentication
    
    Parameters:
    
    serviceBaseUrl - - the base url of the services location
    
    user - - the username required for authentication
    
    pass - - the password required for authentication
- Method Detail
  - getServiceBaseUrl
```
public String getServiceBaseUrl()
```
    Retrieves the base url of the services location
    
    Returns:
    
    String: the base url of the services location
  - getUser
```
public String getUser()
```
    Retrieves the username used for authentication with the application. If none was set, an empty string will be returned
    
    Returns:
    
    user: the username required for authentication
  - getPass
```
public String getPass()
```
    Retrieves the password used for authentication with the application. If none was set, an empty string will be returned
    
    Returns:
    
    pass: the password required for authentication
  - useCredentials
```
public boolean useCredentials()
```
    Determines whether or not authentication should be used, by checking to see if both username and password are set
    
    Returns:
    
    Boolean: are both the username and password set
  - get
```
public Response get(String service)
```
    A basic http get call
    
    Parameters:
    
    service - - the endpoint of the service under test
    
    Returns:
    
    Response: the response provided from the http call
  - get
```
public Response get(String service,
                    Request request)
```
    A basic http get call
    
    Parameters:
    
    service - - the endpoint of the service under test
    
    request - - the parameters to be passed to the endpoint for the service call
    
    Returns:
    
    Response: the response provided from the http call
  - post
```
public Response post(String service,
                     Request request)
```
    A basic http post call
    
    Parameters:
    
    service - - the endpoint of the service under test
    
    request - - the parameters to be passed to the endpoint for the service call
    
    Returns:
    
    Response: the response provided from the http call
  - put
```
public Response put(String service,
                    Request request)
```
    A basic http put call
    
    Parameters:
    
    service - - the endpoint of the service under test
    
    request - - the parameters to be passed to the endpoint for the service call
    
    Returns:
    
    Response: the response provided from the http call
  - patch
```
public Response patch(String service,
                      Request request)
```
    A basic http patch call
    
    Parameters:
    
    service - - the endpoint of the service under test
    
    request - - the parameters to be passed to the endpoint for the service call
    
    Returns:
    
    Response: the response provided from the http call
  - delete
```
public Response delete(String service)
```
    A basic http delete call
    
    Parameters:
    
    service - - the endpoint of the service under test
    
    Returns:
    
    Response: the response provided from the http call
  - delete
```
public Response delete(String service,
                       Request request)
```
    A basic http delete call
    
    Parameters:
    
    service - - the endpoint of the service under test
    
    request - - the parameters to be passed to the endpoint for the service call
    
    Returns:
    
    Response: the response provided from the http call

Class HTTP

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HTTP

HTTP

Method Detail

getServiceBaseUrl

getUser

getPass

useCredentials

get

get

post

put

patch

delete

delete