ch.viascom.groundwork.restclient.http.request

Class Request<T extends ch.viascom.groundwork.restclient.response.generic.Response>

java.lang.Object

ch.viascom.groundwork.restclient.http.request.Request<T>

All Implemented Interfaces:

ch.viascom.groundwork.restclient.request.RequestInterface<T>

Direct Known Subclasses:

DeleteRequest, GetRequest, PostRequest, PutRequest

public abstract class Request<T extends ch.viascom.groundwork.restclient.response.generic.Response>
extends Object
implements ch.viascom.groundwork.restclient.request.RequestInterface<T>

Author:

patrick.boesch@viascom.ch

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<Integer>	additionalAllowedStatusCodes
protected ArrayList<Integer>	additionalDeniedStatusCodes
protected HashMap<String,ch.viascom.groundwork.restclient.filter.response.ErrorResponseCodeFilter>	errorResponseCodeFilters
protected HashMap<String,String>	headerMap
protected org.apache.http.client.HttpClient	httpClient
protected org.apache.http.client.protocol.HttpClientContext	httpClientContext
protected String	mediaType
protected String	path
protected HashMap<String,String>	queryParamMap
protected org.apache.http.HttpEntity	requestBody
protected HashMap<String,RequestExceptionFilter>	requestExceptionFilters
protected HashMap<String,RequestFilter>	requestFilters
protected URI	requestUrl
protected HashMap<String,RequestWriteFilter>	requestWriteFilters
protected HashMap<String,ResponseExceptionFilter>	responseExceptionFilters
protected HashMap<String,ResponseFilter>	responseFilters
protected HashMap<String,ResponseReadFilter>	responseReadFilters
protected HashMap<String,ch.viascom.groundwork.restclient.filter.response.SuccessResponseCodeFilter>	successResponseCodeFilters
protected String	url

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Request(String url, org.apache.http.client.HttpClient httpClient)

Method Summary

Modifier and Type	Method and Description
void	addAdditionalAllowedStatusCode(int code)
void	addAdditionalDeniedStatusCode(int code)
void	addHeaders(String name, String value)
void	addQueryParam(String name, String value)
T	execute()
protected void	executeFilter(org.apache.http.HttpResponse httpResponse, org.apache.http.client.methods.HttpRequestBase httpRequest, ch.viascom.groundwork.restclient.response.generic.Response response, Request request, ch.viascom.groundwork.restclient.response.generic.ErrorResponse errorResponse, Exception e, ch.viascom.groundwork.restclient.filter.FilterTypes filterType)
String	getEncodedPath()
protected com.google.gson.Gson	getGson()
Class<T>	getParameterClass()
org.apache.http.Header[]	getRequestHeader()
HashMap<String,Object>	getRESTFilters()
ArrayList<ch.viascom.groundwork.restclient.filter.RESTFilter>	getRESTFilters(ch.viascom.groundwork.restclient.filter.FilterTypes filterType)
void	prepareQuery()
void	register(ch.viascom.groundwork.restclient.filter.RESTFilter restFilter)
abstract Object	request()
void	setRequestParams(ArrayList<String> params, Object o)
void	unregister(Class restFilter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ch.viascom.groundwork.restclient.request.RequestInterface

getAdditionalAllowedStatusCodes, getAdditionalDeniedStatusCodes, getHeaderMap, getMediaType, getPath, getQueryParamMap, getUrl, setAdditionalAllowedStatusCodes, setAdditionalDeniedStatusCodes, setHeaderMap, setMediaType, setPath, setQueryParamMap, setUrl

Field Detail

url

protected String url

path

protected String path

requestUrl

protected URI requestUrl

mediaType

protected String mediaType

requestBody

protected org.apache.http.HttpEntity requestBody

httpClient

protected org.apache.http.client.HttpClient httpClient

httpClientContext

protected org.apache.http.client.protocol.HttpClientContext httpClientContext

queryParamMap

protected HashMap<String,String> queryParamMap

headerMap

protected HashMap<String,String> headerMap

additionalAllowedStatusCodes

protected ArrayList<Integer> additionalAllowedStatusCodes

additionalDeniedStatusCodes

protected ArrayList<Integer> additionalDeniedStatusCodes

requestFilters

protected HashMap<String,RequestFilter> requestFilters

requestWriteFilters

protected HashMap<String,RequestWriteFilter> requestWriteFilters

requestExceptionFilters

protected HashMap<String,RequestExceptionFilter> requestExceptionFilters

responseFilters

protected HashMap<String,ResponseFilter> responseFilters

responseReadFilters

protected HashMap<String,ResponseReadFilter> responseReadFilters

responseExceptionFilters

protected HashMap<String,ResponseExceptionFilter> responseExceptionFilters

successResponseCodeFilters

protected HashMap<String,ch.viascom.groundwork.restclient.filter.response.SuccessResponseCodeFilter> successResponseCodeFilters

errorResponseCodeFilters

protected HashMap<String,ch.viascom.groundwork.restclient.filter.response.ErrorResponseCodeFilter> errorResponseCodeFilters

Constructor Detail

Request

protected Request(String url,
                  org.apache.http.client.HttpClient httpClient)

Method Detail

request

public abstract Object request()
                        throws Exception

Specified by:

request in interface ch.viascom.groundwork.restclient.request.RequestInterface<T extends ch.viascom.groundwork.restclient.response.generic.Response>

Throws:

Exception

addHeaders

public void addHeaders(String name,
                       String value)

Specified by:

addHeaders in interface ch.viascom.groundwork.restclient.request.RequestInterface<T extends ch.viascom.groundwork.restclient.response.generic.Response>

getRequestHeader

public org.apache.http.Header[] getRequestHeader()

setRequestParams

public void setRequestParams(ArrayList<String> params,
                             Object o)
                      throws ch.viascom.groundwork.restclient.exception.RESTClientException

Specified by:

setRequestParams in interface ch.viascom.groundwork.restclient.request.RequestInterface<T extends ch.viascom.groundwork.restclient.response.generic.Response>

Throws:

ch.viascom.groundwork.restclient.exception.RESTClientException

addQueryParam

public void addQueryParam(String name,
                          String value)

Specified by:

addQueryParam in interface ch.viascom.groundwork.restclient.request.RequestInterface<T extends ch.viascom.groundwork.restclient.response.generic.Response>

addAdditionalAllowedStatusCode

public void addAdditionalAllowedStatusCode(int code)

Specified by:

addAdditionalAllowedStatusCode in interface ch.viascom.groundwork.restclient.request.RequestInterface<T extends ch.viascom.groundwork.restclient.response.generic.Response>

addAdditionalDeniedStatusCode

public void addAdditionalDeniedStatusCode(int code)

Specified by:

addAdditionalDeniedStatusCode in interface ch.viascom.groundwork.restclient.request.RequestInterface<T extends ch.viascom.groundwork.restclient.response.generic.Response>

register

public void register(ch.viascom.groundwork.restclient.filter.RESTFilter restFilter)

Specified by:

register in interface ch.viascom.groundwork.restclient.request.RequestInterface<T extends ch.viascom.groundwork.restclient.response.generic.Response>

unregister

public void unregister(Class restFilter)

Specified by:

unregister in interface ch.viascom.groundwork.restclient.request.RequestInterface<T extends ch.viascom.groundwork.restclient.response.generic.Response>

getRESTFilters

public HashMap<String,Object> getRESTFilters()

Specified by:

getRESTFilters in interface ch.viascom.groundwork.restclient.request.RequestInterface<T extends ch.viascom.groundwork.restclient.response.generic.Response>

getRESTFilters

public ArrayList<ch.viascom.groundwork.restclient.filter.RESTFilter> getRESTFilters(ch.viascom.groundwork.restclient.filter.FilterTypes filterType)

Specified by:

getRESTFilters in interface ch.viascom.groundwork.restclient.request.RequestInterface<T extends ch.viascom.groundwork.restclient.response.generic.Response>

prepareQuery

public void prepareQuery()
                  throws URISyntaxException

Specified by:

prepareQuery in interface ch.viascom.groundwork.restclient.request.RequestInterface<T extends ch.viascom.groundwork.restclient.response.generic.Response>

Throws:

URISyntaxException

getGson

protected com.google.gson.Gson getGson()

execute

public T execute()
          throws Exception

Specified by:

execute in interface ch.viascom.groundwork.restclient.request.RequestInterface<T extends ch.viascom.groundwork.restclient.response.generic.Response>

Throws:

Exception

executeFilter

protected void executeFilter(org.apache.http.HttpResponse httpResponse,
                             org.apache.http.client.methods.HttpRequestBase httpRequest,
                             ch.viascom.groundwork.restclient.response.generic.Response response,
                             Request request,
                             ch.viascom.groundwork.restclient.response.generic.ErrorResponse errorResponse,
                             Exception e,
                             ch.viascom.groundwork.restclient.filter.FilterTypes filterType)
                      throws Exception

Throws:

Exception

getEncodedPath

public String getEncodedPath()

getParameterClass

public Class<T> getParameterClass()

Specified by:

getParameterClass in interface ch.viascom.groundwork.restclient.request.RequestInterface<T extends ch.viascom.groundwork.restclient.response.generic.Response>