RestRequest (RestClient 2.2 API)

java.lang.Object
- smartrics.rest.client.RestData
- - smartrics.rest.client.RestRequest

public class RestRequest
extends RestData

Wraps a REST request object.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RestRequest.Method
An http verb (those supported).
- Nested classes/interfaces inherited from class smartrics.rest.client.RestData
  RestData.Header

Nested Classes
Modifier and Type	Class and Description
`static class`	`RestRequest.Method` An http verb (those supported).

Field Summary
- Fields inherited from class smartrics.rest.client.RestData
  DEFAULT_ENCODING, LINE_SEPARATOR

Constructor Summary

Constructors
Constructor and Description

RestRequest()

Constructors
Constructor and Description
`RestRequest()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`RestRequest`	`addMultipart(String multiParamName, RestMultipart restMultipart)` Add the multipart upload file name for this request.
`RestRequest`	`addMultipartFileName(String multipartFileName)` Add the multipart upload file name for this request.
`RestRequest`	`addMultipartFileName(String multipartFileName, String contentType)` Add the multipart upload file name for this request.
`RestRequest`	`addMultipartFileName(String multipartFileName, String contentType, String charSet)` Add the multipart upload file name for this request.
`String`	`getFileName()`
`RestRequest.Method`	`getMethod()`
`Map<String,RestMultipart>`	`getMultipartFileNames()`
`String`	`getMultipartFileParameterName()` Deprecated.
`String`	`getQuery()`
`boolean`	`isFollowRedirect()`
`boolean`	`isResourceUriEscaped()`
`boolean`	`isValid()` Checks validity of this request.
`RestRequest`	`setFileName(String fileName)` Sets the upload file name for this request.
`RestRequest`	`setFollowRedirect(boolean v)`
`RestRequest`	`setMethod(RestRequest.Method method)` Sets the method for this request.
`RestRequest`	`setMultipartFileName(String multipartFileName)` Deprecated.
`RestRequest`	`setMultipartFileParameterName(String multipartFileParameterName)` Deprecated.
`RestRequest`	`setQuery(String query)` Sets the query for this request.
`RestRequest`	`setResourceUriEscaped(boolean escaped)`
`String`	`toString()` String representation of this request.

Methods inherited from class smartrics.rest.client.RestData
addHeader, addHeaders, addHeaders, getBody, getCharset, getContentLength, getContentType, getHeader, getHeaders, getHeaderValue, getRawBody, getResource, getTransactionId, setBody, setRawBody, setResource, setTransactionId

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

- Constructor Detail
  - RestRequest
```
public RestRequest()
```
- Method Detail
  - getMethod
```
public RestRequest.Method getMethod()
```
    Returns:
    
    the method for this request
  - setMethod
```
public RestRequest setMethod(RestRequest.Method method)
```
    Sets the method for this request.
    
    Parameters:
    
    method - the method
    
    Returns:
    
    this request
    
    See Also:
    
    RestRequest.Method
  - getQuery
```
public String getQuery()
```
    Returns:
    
    the query for this request
  - setQuery
```
public RestRequest setQuery(String query)
```
    Sets the query for this request.
    
    Parameters:
    
    query - the query
    
    Returns:
    
    this request
  - getFileName
```
public String getFileName()
```
    Returns:
    
    the upload file name for this request
  - getMultipartFileNames
```
public Map<String,RestMultipart> getMultipartFileNames()
```
    Returns:
    
    the multipart upload files name for this request
  - getMultipartFileParameterName
```
@Deprecated
public String getMultipartFileParameterName()
```
    Deprecated.
    
    Returns:
    
    the multipart file form parameter name for this request
  - setMultipartFileParameterName
```
@Deprecated
public RestRequest setMultipartFileParameterName(String multipartFileParameterName)
```
    Deprecated.
    
    Sets the multipart file form parameter name for this request.
    
    Parameters:
    
    multipartFileParameterName - the multipart file form parameter name
    
    Returns:
    
    this request
  - setMultipartFileName
```
@Deprecated
public RestRequest setMultipartFileName(String multipartFileName)
```
    Deprecated.
    
    Sets the multipart upload file name for this request.
    
    Parameters:
    
    multipartFileName - the multipart file name
    
    Returns:
    
    this request
  - addMultipartFileName
```
public RestRequest addMultipartFileName(String multipartFileName)
```
    Add the multipart upload file name for this request.
    
    Parameters:
    
    multipartFileName - the multipart file name
    
    Returns:
    
    this request
  - addMultipartFileName
```
public RestRequest addMultipartFileName(String multipartFileName,
                                        String contentType)
```
    Add the multipart upload file name for this request.
    
    Parameters:
    
    multipartFileName - the multipart file name
    
    contentType - the multipart contentType
    
    Returns:
    
    this request
  - addMultipartFileName
```
public RestRequest addMultipartFileName(String multipartFileName,
                                        String contentType,
                                        String charSet)
```
    Add the multipart upload file name for this request.
    
    Parameters:
    
    multipartFileName - the multipart file name
    
    contentType - the multipart contentType
    
    charSet - the multipart charSet
    
    Returns:
    
    this request
  - addMultipart
```
public RestRequest addMultipart(String multiParamName,
                                RestMultipart restMultipart)
```
    Add the multipart upload file name for this request.
    
    Parameters:
    
    multiParamName - the multipart file form parameter name
    
    restMultipart - the multipart restMultipart data
    
    Returns:
    
    this request
  - setFollowRedirect
```
public RestRequest setFollowRedirect(boolean v)
```
  - isFollowRedirect
```
public boolean isFollowRedirect()
```
  - setFileName
```
public RestRequest setFileName(String fileName)
```
    Sets the upload file name for this request.
    
    Parameters:
    
    fileName - the upload file name
    
    Returns:
    
    this request
  - isValid
```
public boolean isValid()
```
    Checks validity of this request. In this implementation a request is valid if both the method and the resource Uri not null
    
    Returns:
    
    true if valid
  - isResourceUriEscaped
```
public boolean isResourceUriEscaped()
```
    Returns:
    
    whether resource uri is % escaped (true) or not (false). Defaults to false.
  - setResourceUriEscaped
```
public RestRequest setResourceUriEscaped(boolean escaped)
```
    Parameters:
    
    escaped - whether resource uri is % escaped or not
    
    Returns:
    
    this request
  - toString
```
public String toString()
```
    String representation of this request.
    
    Overrides:
    
    toString in class RestData
    
    Returns:
    
    the string representation

Class RestRequest

Nested Class Summary

Nested classes/interfaces inherited from class smartrics.rest.client.RestData

Field Summary

Fields inherited from class smartrics.rest.client.RestData

Constructor Summary

Method Summary

Methods inherited from class smartrics.rest.client.RestData

Methods inherited from class java.lang.Object

Constructor Detail

RestRequest

Method Detail

getMethod

setMethod

getQuery

setQuery

getFileName

getMultipartFileNames

getMultipartFileParameterName

setMultipartFileParameterName

setMultipartFileName

addMultipartFileName

addMultipartFileName

addMultipartFileName

addMultipart

setFollowRedirect

isFollowRedirect

setFileName

isValid

isResourceUriEscaped

setResourceUriEscaped

toString