com.humandevice.resttools.rest

Class Request<T>

java.lang.Object

com.humandevice.resttools.rest.Request<T>

Direct Known Subclasses:

DeleteRequest, GetRequest, PostRequest, PutRequest

public abstract class Request<T>
extends java.lang.Object

Klasa dostarczająca podstawowe metody komunikacji z api

Field Summary

Fields

Modifier and Type	Field and Description
protected OkHttpClient	mHttpClient
protected ObjectReader	mObjectReader
protected ObjectWriter	mObjectWriter
protected static UserService	mUserService
protected static RestConfig	sConfig

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Request()

Method Summary

Modifier and Type	Method and Description
protected java.util.concurrent.Callable<T>	createRequestTask() Utworzenie nowego zadania dla zapytania
RequestFuture<T>	execute() Metoda uruchamiająca wykonywanie zapytania
RequestFuture<T>	execute(RequestListener<T> listener) Metoda uruchamiająca wykonywanie zapytania, po zakończeniu uruchamiana jest metoda listenera
protected java.lang.Class<T>	getParameterClass() metoda zwracająca classę obiektu oczekiwanego w odpowiedzi
protected <any>	getParameterType() Metoda zwracająca typ obiektu zwracanego, jeśli metoda nie została przeciążona to zwraca null
protected RequestBody	getRequestBody() metoda zwracająca body zapytania zawierające parameters
protected HttpUrl	getUrl() Metoda zwraca kompletny adres url do metody api.
protected abstract void	prepareRequest() Metoda, w której powinna byc wykonana konfiguracja zapytania.
protected void	putParameter(java.lang.String parameterName, java.lang.Object value) Dodanie parametru do body zapytania
protected void	putParameter(java.lang.String objectName, java.lang.String parameterName, java.lang.Object value) Dodanie parametru do body zapytania
protected void	putUrlParameter(java.lang.String parameterName, java.lang.Object value) Dodanie parametru do adresu url.
protected void	putUrlParameter(java.lang.String objectName, java.lang.String parameterName, java.lang.Object value) Dodanie parametru do adresu url
protected abstract Response	request() Metoda zwracająca wynik zapytania api
static void	setRestConfig(RestConfig credentials)
protected void	setUrlSegments(java.lang.String... urlSegments) Ustawienie adresu api
static void	setUserService(UserService userService)
protected void	withoutApiVersion() wywołanie tej metody powoduje wyłączenie dodawania wersji api (RestConfig.API_VERSION) do adresu url zapytania

Methods inherited from class java.lang.Object

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

Field Detail

mObjectReader

protected final ObjectReader mObjectReader

mObjectWriter

protected final ObjectWriter mObjectWriter

mHttpClient

protected OkHttpClient mHttpClient

mUserService

protected static UserService mUserService

sConfig

protected static RestConfig sConfig

Constructor Detail

Request

protected Request()

Method Detail

setUserService

public static void setUserService(UserService userService)

setRestConfig

public static void setRestConfig(RestConfig credentials)

getParameterType

protected <any> getParameterType()

Metoda zwracająca typ obiektu zwracanego, jeśli metoda nie została przeciążona to zwraca null

getParameterClass

protected java.lang.Class<T> getParameterClass()

metoda zwracająca classę obiektu oczekiwanego w odpowiedzi

execute

public RequestFuture<T> execute()

Metoda uruchamiająca wykonywanie zapytania

execute

public RequestFuture<T> execute(RequestListener<T> listener)

Metoda uruchamiająca wykonywanie zapytania, po zakończeniu uruchamiana jest metoda listenera

createRequestTask

protected java.util.concurrent.Callable<T> createRequestTask()

Utworzenie nowego zadania dla zapytania

Returns:

callable zapytania

request

protected abstract Response request()
                             throws java.io.IOException

Metoda zwracająca wynik zapytania api

Throws:

java.io.IOException

prepareRequest

protected abstract void prepareRequest()

Metoda, w której powinna byc wykonana konfiguracja zapytania.

See Also:

setUrlSegments(String...), putParameter(String, Object), putUrlParameter(String, Object)

getUrl

protected HttpUrl getUrl()

Metoda zwraca kompletny adres url do metody api. Jeśli do adresu mają zostać dodane parametry to musi to być wykonane przed wywołaniem tej funkcji.

See Also:

putUrlParameter(String, Object)

setUrlSegments

protected void setUrlSegments(java.lang.String... urlSegments)

Ustawienie adresu api

Parameters:

urlSegments - elementy ścieżki url do odpowiedniej metody api np.:
dla adresu http://example.com/v1/get/user metoda powinna być wywołana: getUrlBuilder("get", "user");

putParameter

protected void putParameter(java.lang.String parameterName,
                            java.lang.Object value)

Dodanie parametru do body zapytania

putParameter

protected void putParameter(java.lang.String objectName,
                            java.lang.String parameterName,
                            java.lang.Object value)

Dodanie parametru do body zapytania

putUrlParameter

protected void putUrlParameter(java.lang.String parameterName,
                               java.lang.Object value)

Dodanie parametru do adresu url.

putUrlParameter

protected void putUrlParameter(java.lang.String objectName,
                               java.lang.String parameterName,
                               java.lang.Object value)

Dodanie parametru do adresu url

Parameters:

objectName - nazwa obiektu do jakiego ma zostać dopisany parametr, wynikowa nazwą będzie: objectName[parameterName]

withoutApiVersion

protected void withoutApiVersion()

wywołanie tej metody powoduje wyłączenie dodawania wersji api (RestConfig.API_VERSION) do adresu url zapytania

getRequestBody

protected RequestBody getRequestBody()
                              throws JsonProcessingException

metoda zwracająca body zapytania zawierające parameters

Returns:

body zapytania lub null jeśli nie zostały przesłane żadne parametry

Throws:

JsonProcessingException