RequestInterface (GroundWork - RESTClient 2.1 API)

All Known Subinterfaces:

DeleteRequestInterface<T>, GetRequestInterface<T>, HeadRequestInterface<T>, OptionsRequestInterface<T>, PatchRequestInterface<T>, PostRequestInterface<T>, PutRequestInterface<T>
```
public interface RequestInterface<T extends Response>
```
Request interface for all request

Author:

patrick.boesch@viascom.ch

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addAdditionalAllowedStatusCode(int code)` Add an additional allowed status code
`void`	`addAdditionalDeniedStatusCode(int code)` Add an denied status code
`void`	`addHeaders(String name, String value)` Add a new header property
`void`	`addQueryParam(String name, String value)` Add a new query property
`T`	`execute()` Executes the request and returns a deserialized object of the response based on T
`ArrayList<Integer>`	`getAdditionalAllowedStatusCodes()` Get all additional allowed status codes
`ArrayList<Integer>`	`getAdditionalDeniedStatusCodes()` Get all additional denied status codes
`HashMap<String,String>`	`getHeaderMap()` Get the header map of the request key: property name value: property value Example: {"Accept-Charset": "UTF-8"}
`String`	`getMediaType()` Get media type (Content-Type property) of the request
`Class<T>`	`getParameterClass()` Get the generic class T
`String`	`getPath()` Set path of the request Examples: - /post/1 - /user/12/address
`HashMap<String,String>`	`getQueryParamMap()` Get the query map of the request key: property name value: property value Example: {"definitionId": "12974", "active": "true"} = ?definitionId=12974&active=true
`HashMap<String,Object>`	`getRESTFilters()` Get the RESTFilters for the Request/Response
`ArrayList<RESTFilter>`	`getRESTFilters(FilterTypes filterType)` Get the RESTFilters of a specific type for the Request/Response
`String`	`getUrl()` Get the url of the request Examples: - http://rest.viascom.ch:8000 - https://127.0.0.1:8080
`void`	`prepareQuery()` Generate request url with all informations for the request
`void`	`register(RESTFilter restFilter)` Register a RESTFilters for the Request/Response
`Object`	`request()` Send request to the rest endpoint
`void`	`setAdditionalAllowedStatusCodes(ArrayList<Integer> additionalAllowedStatusCodes)` Set additional allowed status codes this will extend the default of statuscode >= 200 && < 300
`void`	`setAdditionalDeniedStatusCodes(ArrayList<Integer> additionalDeniedStatusCodes)` Set additional denied status codes this will override the default of statuscode >= 200 && < 300
`void`	`setHeaderMap(HashMap<String,String> headerMap)` Set the header map of the request key: property name value: property value Example: {"Accept-Charset": "UTF-8"}
`void`	`setMediaType(String mediaType)` Set media type (Content-Type property) of the request
`void`	`setPath(String path)` Get path of the request Examples: - /post/1 - /user/12/address
`void`	`setQueryParamMap(HashMap<String,String> queryParamMap)` Set the query map of the request key: property name value: property value Example: {"definitionId": "12974", "active": "true"} = ?definitionId=12974&active=true
`void`	`setRequestParams(ArrayList<String> params, Object o)` Set query map of the request based on a objects and its attributes
`void`	`setUrl(String url)` Set url of the request Examples: - http://rest.viascom.ch:8000 - https://127.0.0.1:8080
`void`	`unregister(Class restFilter)` Unregister a RESTFilters for the Request/Response

- Method Detail
  - getUrl
```
String getUrl()
```
    Get the url of the request Examples: - http://rest.viascom.ch:8000 - https://127.0.0.1:8080
    
    Returns:
    
    A url
  - setUrl
```
void setUrl(String url)
```
    Set url of the request Examples: - http://rest.viascom.ch:8000 - https://127.0.0.1:8080
    
    Parameters:
    
    url - url to the rest endpoint
  - getPath
```
String getPath()
```
    Set path of the request Examples: - /post/1 - /user/12/address
    
    Returns:
    
    path of the request
  - setPath
```
void setPath(String path)
```
    Get path of the request Examples: - /post/1 - /user/12/address
    
    Parameters:
    
    path - path to the rest endpoint
  - getMediaType
```
String getMediaType()
```
    Get media type (Content-Type property) of the request
    
    Returns:
    
    media type
  - setMediaType
```
void setMediaType(String mediaType)
```
    Set media type (Content-Type property) of the request
    
    Parameters:
    
    mediaType - media type
  - getQueryParamMap
```
HashMap<String,String> getQueryParamMap()
```
    Get the query map of the request key: property name value: property value Example: {"definitionId": "12974", "active": "true"} = ?definitionId=12974&active=true
    
    Returns:
    
    query map of the request
  - setQueryParamMap
```
void setQueryParamMap(HashMap<String,String> queryParamMap)
```
    Set the query map of the request key: property name value: property value Example: {"definitionId": "12974", "active": "true"} = ?definitionId=12974&active=true
    
    Parameters:
    
    queryParamMap - hash map containing the query properties
  - setRequestParams
```
void setRequestParams(ArrayList<String> params,
                      Object o)
               throws RESTClientException
```
    Set query map of the request based on a objects and its attributes
    
    Parameters:
    
    params - list of attribute names which are used for the query map
    
    o - object with the attributes
    
    Throws:
    
    RESTClientException
  - addQueryParam
```
void addQueryParam(String name,
                   String value)
```
    Add a new query property
    
    Parameters:
    
    name - property name
    
    value - propert value
  - getHeaderMap
```
HashMap<String,String> getHeaderMap()
```
    Get the header map of the request key: property name value: property value Example: {"Accept-Charset": "UTF-8"}
    
    Returns:
    
    header map of the request
  - setHeaderMap
```
void setHeaderMap(HashMap<String,String> headerMap)
```
    Set the header map of the request key: property name value: property value Example: {"Accept-Charset": "UTF-8"}
    
    Parameters:
    
    headerMap - hash map containing the header properties
  - addHeaders
```
void addHeaders(String name,
                String value)
```
    Add a new header property
    
    Parameters:
    
    name - property name
    
    value - propert value
  - register
```
void register(RESTFilter restFilter)
```
    Register a RESTFilters for the Request/Response
    
    Parameters:
    
    restFilter - RESTFilter for the request
  - unregister
```
void unregister(Class restFilter)
```
    Unregister a RESTFilters for the Request/Response
    
    Parameters:
    
    restFilter - Class of a restFilter for the request
  - getRESTFilters
```
HashMap<String,Object> getRESTFilters()
```
    Get the RESTFilters for the Request/Response
    
    Returns:
    
    Array of RESTFilters of the request
  - getRESTFilters
```
ArrayList<RESTFilter> getRESTFilters(FilterTypes filterType)
```
    Get the RESTFilters of a specific type for the Request/Response
    
    Returns:
    
    Array of RESTFilters of the request
  - setAdditionalAllowedStatusCodes
```
void setAdditionalAllowedStatusCodes(ArrayList<Integer> additionalAllowedStatusCodes)
```
    Set additional allowed status codes this will extend the default of statuscode >= 200 && < 300
    
    Parameters:
    
    additionalAllowedStatusCodes - Array of additional allowed status codes
  - getAdditionalAllowedStatusCodes
```
ArrayList<Integer> getAdditionalAllowedStatusCodes()
```
    Get all additional allowed status codes
    
    Returns:
    
    additional allowed status codes
  - addAdditionalAllowedStatusCode
```
void addAdditionalAllowedStatusCode(int code)
```
    Add an additional allowed status code
    
    Parameters:
    
    code - status code to allow
  - setAdditionalDeniedStatusCodes
```
void setAdditionalDeniedStatusCodes(ArrayList<Integer> additionalDeniedStatusCodes)
```
    Set additional denied status codes this will override the default of statuscode >= 200 && < 300
    
    Parameters:
    
    additionalDeniedStatusCodes - Array of additional denied status codes
  - getAdditionalDeniedStatusCodes
```
ArrayList<Integer> getAdditionalDeniedStatusCodes()
```
    Get all additional denied status codes
    
    Returns:
    
    additional denied status codes
  - addAdditionalDeniedStatusCode
```
void addAdditionalDeniedStatusCode(int code)
```
    Add an denied status code
    
    Parameters:
    
    code - status code to denie
  - prepareQuery
```
void prepareQuery()
           throws Exception
```
    Generate request url with all informations for the request
    
    Throws:
    
    Exception
  - request
```
Object request()
        throws Exception
```
    Send request to the rest endpoint
    
    Returns:
    
    Http response of the request
    
    Throws:
    
    Exception
  - execute
```
T execute()
   throws Exception
```
    Executes the request and returns a deserialized object of the response based on T
    
    Returns:
    
    deserialized object of the response based on T
    
    Throws:
    
    Exception
  - getParameterClass
```
Class<T> getParameterClass()
```
    Get the generic class T
    
    Returns:
    
    generic class T

Interface RequestInterface<T extends Response>

Method Summary

Method Detail

getUrl

setUrl

getPath

setPath

getMediaType

setMediaType

getQueryParamMap

setQueryParamMap

setRequestParams

addQueryParam

getHeaderMap

setHeaderMap

addHeaders

register

unregister

getRESTFilters

getRESTFilters

setAdditionalAllowedStatusCodes

getAdditionalAllowedStatusCodes

addAdditionalAllowedStatusCode

setAdditionalDeniedStatusCodes

getAdditionalDeniedStatusCodes

addAdditionalDeniedStatusCode

prepareQuery

request

execute

getParameterClass