HttpRequest (qtest-sdk-java 1.4.10 API)

All Known Implementing Classes:

AbstractHttpRequest, HttpUrlConnectionRequest
```
public interface HttpRequest<T>
```
HttpRequest

Since:

1.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addParameter(java.lang.String name, java.lang.String value)` Adds the specified request parameter to this request.
`java.io.InputStream`	`getContent()`
`int`	`getContentLength()`
`java.lang.String`	`getContentType()`
`java.net.URI`	`getEndpoint()`
`java.util.Map<java.lang.String,java.lang.String>`	`getHeaders()`
`HttpMethod`	`getHttpMethod()`
`ApiServiceRequest`	`getOriginalRequest()` Returns the original, user facing request object which this basic request object is representing.
`java.util.Map<java.lang.String,java.lang.String>`	`getParameters()`
`java.lang.String`	`getResourcePath()`
`java.lang.String`	`getServiceName()`
`int`	`getTimeOffset()`
`T`	`getUnderlying()`
`void`	`setContent(java.io.InputStream content)` Sets the optional stream containing the payload data to include for this request.
`void`	`setHeader(java.lang.String name, java.lang.String value)` Adds the specified header to this request.
`void`	`setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)` Sets all headers, clearing any existing ones.
`void`	`setHttpMethod(HttpMethod httpMethod)` Sets the HTTP method to use when sending this request.
`void`	`setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)` Sets all parameters, clearing any existing values.
`void`	`setResourcePath(java.lang.String resourcePath)` Sets the path to the resource being requested.
`void`	`setTimeOffset(int timeOffset)` Sets the optional value for time offset for this request.
`HttpRequest<T>`	`withContent(java.io.InputStream content)` Sets the optional stream containing the payload data to include for this request.
`HttpRequest<T>`	`withHeader(java.lang.String name, java.lang.String value)` Adds the specified header to this request and returns the updated HttpRequest object.
`HttpRequest<T>`	`withHeaders(java.util.Map<java.lang.String,java.lang.String> headers)` Sets all headers, clearing any existing ones and returns the updated `HttpRequest` object.
`HttpRequest<T>`	`withHttpMethod(HttpMethod httpMethod)` Sets the HTTP method to use when sending this request and returns the updated `HttpRequest` object.
`HttpRequest<T>`	`withParameter(java.lang.String name, java.lang.String value)` Adds the specified request parameter to this request and returns the updated `HttpRequest` object.
`HttpRequest<T>`	`withParameters(java.util.Map<java.lang.String,java.lang.String> parameters)` Sets all parameters, clearing any existing values and return the updated `HttpRequest` object.
`HttpRequest<T>`	`withResourcePath(java.lang.String resourcePath)` Sets the path to the resource being requested and returns the updated `HttpRequest` object.
`HttpRequest<T>`	`withTimeOffset(int timeOffset)` Sets the optional value for time offset for this request.

- Method Detail
  - getContentType
```
java.lang.String getContentType()
```
    Returns:
    
    HTTP request content type.
  - getContentLength
```
int getContentLength()
```
    Returns:
    
    HTTP request content length.
  - getUnderlying
```
T getUnderlying()
```
    Returns:
    
    HTTP request underlying object.
  - setHeader
```
void setHeader(java.lang.String name,
               java.lang.String value)
```
    Adds the specified header to this request.
    
    Parameters:
    
    name - the name of the header to add.
    
    value - the header's value.
  - withHeader
```
HttpRequest<T> withHeader(java.lang.String name,
                          java.lang.String value)
```
    Adds the specified header to this request and returns the updated HttpRequest object.
    
    Parameters:
    
    name - the name of the header to add.
    
    value - the header's value.
    
    Returns:
    
    the updated HttpRequest object with a new header.
  - getHeaders
```
java.util.Map<java.lang.String,java.lang.String> getHeaders()
```
    Returns:
    
    A map of all headers include in this request.
  - setHeaders
```
void setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
```
    Sets all headers, clearing any existing ones.
    
    Parameters:
    
    headers - the given map of headers to set.
  - withHeaders
```
HttpRequest<T> withHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
```
    Sets all headers, clearing any existing ones and returns the updated HttpRequest object.
    
    Parameters:
    
    headers - the given map of headers to set.
    
    Returns:
    
    the updated HttpRequest object with a new headers.
  - getResourcePath
```
java.lang.String getResourcePath()
```
    Returns:
    
    the path to the resource being requested.
  - setResourcePath
```
void setResourcePath(java.lang.String resourcePath)
```
    Sets the path to the resource being requested.
    
    Parameters:
    
    resourcePath - the path to the resource being requested.
  - withResourcePath
```
HttpRequest<T> withResourcePath(java.lang.String resourcePath)
```
    Sets the path to the resource being requested and returns the updated HttpRequest object.
    
    Parameters:
    
    resourcePath - the path to the resource being requested.
    
    Returns:
    
    the updated HttpRequest object with a new resource path.
  - addParameter
```
void addParameter(java.lang.String name,
                  java.lang.String value)
```
    Adds the specified request parameter to this request.
    
    Parameters:
    
    name - the name of the request parameter.
    
    value - the value of the request parameter.
  - withParameter
```
HttpRequest<T> withParameter(java.lang.String name,
                             java.lang.String value)
```
    Adds the specified request parameter to this request and returns the updated HttpRequest object.
    
    Parameters:
    
    name - the name of the request parameter.
    
    value - the value of the request parameter.
    
    Returns:
    
    the updated HttpRequest object with a new parameter.
  - getParameters
```
java.util.Map<java.lang.String,java.lang.String> getParameters()
```
    Returns:
    
    A map of all parameters in this request.
  - setParameters
```
void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
```
    Sets all parameters, clearing any existing values.
    
    Parameters:
    
    parameters - the map of parameters to set.
  - withParameters
```
HttpRequest<T> withParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
```
    Sets all parameters, clearing any existing values and return the updated HttpRequest object.
    
    Parameters:
    
    parameters - the map of parameters to set.
    
    Returns:
    
    the updated HttpRequest object with new map of parameters.
  - getEndpoint
```
java.net.URI getEndpoint()
```
    Returns:
    
    the service endpoint to which this request should be sent.
  - getHttpMethod
```
HttpMethod getHttpMethod()
```
    Returns:
    
    the HTTP method to use when sending this request.
  - setHttpMethod
```
void setHttpMethod(HttpMethod httpMethod)
```
    Sets the HTTP method to use when sending this request.
    
    Parameters:
    
    httpMethod - the HTTP method to use when sending this request.
  - withHttpMethod
```
HttpRequest<T> withHttpMethod(HttpMethod httpMethod)
```
    Sets the HTTP method to use when sending this request and returns the updated HttpRequest object.
    
    Parameters:
    
    httpMethod - the HTTP method to use when sending this request.
    
    Returns:
    
    the updated HttpRequest object with a new http method.
  - getContent
```
java.io.InputStream getContent()
```
    Returns:
    
    The optional stream containing the payload data to include for this request.
  - setContent
```
void setContent(java.io.InputStream content)
```
    Sets the optional stream containing the payload data to include for this request. Not all requests will contain payload data.
    
    Parameters:
    
    content - the optional stream containing the payload data to include for request.
  - withContent
```
HttpRequest<T> withContent(java.io.InputStream content)
```
    Sets the optional stream containing the payload data to include for this request. Not all requests will contain payload data and returns the updated HttpRequest object.
    
    Parameters:
    
    content - the optional stream containing the payload data to include for request.
    
    Returns:
    
    the updated HttpRequest object with a new content.
  - getServiceName
```
java.lang.String getServiceName()
```
    Returns:
    
    the name of the service this request is for.
  - getTimeOffset
```
int getTimeOffset()
```
    Returns:
    
    optional value for time offset for this request.
  - setTimeOffset
```
void setTimeOffset(int timeOffset)
```
    Sets the optional value for time offset for this request. This will be used by the signer to adjust for potential clock skew. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow.
    
    Parameters:
    
    timeOffset - The optional value for time offset for this request.
  - withTimeOffset
```
HttpRequest<T> withTimeOffset(int timeOffset)
```
    Sets the optional value for time offset for this request. This will be used by the signer to adjust for potential clock skew. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow and returns the updated HttpRequest object.
    
    Parameters:
    
    timeOffset - The optional value for time offset for this request.
    
    Returns:
    
    the updated HttpRequest object with a new time offset.
  - getOriginalRequest
```
ApiServiceRequest getOriginalRequest()
```
    Returns the original, user facing request object which this basic request object is representing.
    
    Returns:
    
    the original, user facing request object which this basic request object is representing.

Interface HttpRequest<T>

Method Summary

Method Detail

getContentType

getContentLength

getUnderlying

setHeader

withHeader

getHeaders

setHeaders

withHeaders

getResourcePath

setResourcePath

withResourcePath

addParameter

withParameter

getParameters

setParameters

withParameters

getEndpoint

getHttpMethod

setHttpMethod

withHttpMethod

getContent

setContent

withContent

getServiceName

getTimeOffset

setTimeOffset

withTimeOffset

getOriginalRequest