Request (resttools API)

java.lang.Object
- com.humandevice.android.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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Request.ConnectionRestriction

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Request.ConnectionRestriction`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`ACCESS_TOKEN`
`protected static java.lang.String`	`AUTHORIZATION`
`protected static java.lang.String`	`CONTENT_TYPE`
`protected boolean`	`isMultipartRequest`
`protected static MediaType`	`MEDIA_TYPE`
`protected OkHttpClient`	`mHttpClient`
`protected static MediaType`	`MULTIPART_MEDIA_TYPE`
`protected static IUserService`	`mUserService`
`protected static RestConfiguration`	`sConfiguration`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Request()

Constructors
Modifier	Constructor and Description
`protected`	`Request()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkConnectionRestrictions(Request<T> request)`
`protected void`	`checkTokenValidity()` Metoda jest wykonywana dla Requestów implementujących interfejs TokenRequest.
`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 boolean`	`isTokenRequest()` Sprawdzenie czy zapytanie wymaga autoryzacji przy użyciu tokena
`protected java.lang.String`	`obtainStringValue(java.lang.Object value)`
`protected T`	`parseToObject(java.lang.String content)`
`protected abstract void`	`prepareRequest()` Metoda, w której powinna byc wykonana konfiguracja zapytania.
`protected void`	`putParameter(java.lang.Object value)`
`protected void`	`putParameter(java.lang.String parameter, java.lang.Object value)`
`protected void`	`putUrlParameter(java.lang.Object value)`
`protected void`	`putUrlParameter(java.lang.String parameter, java.lang.Object value)`
`protected T`	`readResponse(Response response)`
`protected abstract Response`	`request()` Metoda zwracająca wynik zapytania api
`static void`	`setRestConfiguration(RestConfiguration credentials)`
`protected void`	`setUrlSegments(java.lang.String... urlSegments)` Ustawienie adresu api
`static void`	`setUserService(IUserService userService)`
`protected java.lang.String[]`	`toObject(java.lang.String... names)`

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

- Field Detail
  - CONTENT_TYPE
```
protected static final java.lang.String CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - MEDIA_TYPE
```
protected static final MediaType MEDIA_TYPE
```
  - MULTIPART_MEDIA_TYPE
```
protected static final MediaType MULTIPART_MEDIA_TYPE
```
  - ACCESS_TOKEN
```
protected static final java.lang.String ACCESS_TOKEN
```
    See Also:
    
    Constant Field Values
  - AUTHORIZATION
```
protected static final java.lang.String AUTHORIZATION
```
    See Also:
    
    Constant Field Values
  - mUserService
```
protected static IUserService mUserService
```
  - sConfiguration
```
protected static RestConfiguration sConfiguration
```
  - mHttpClient
```
protected OkHttpClient mHttpClient
```
  - isMultipartRequest
```
protected boolean isMultipartRequest
```
- Constructor Detail
  - Request
```
protected Request()
```
- Method Detail
  - setUserService
```
public static void setUserService(IUserService userService)
```
  - setRestConfiguration
```
public static void setRestConfiguration(RestConfiguration credentials)
```
  - 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
  - readResponse
```
protected T readResponse(Response response)
                  throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - parseToObject
```
protected T parseToObject(java.lang.String content)
                   throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - checkConnectionRestrictions
```
protected void checkConnectionRestrictions(Request<T> request)
                                    throws ConnectionRestrictionFailedException
```
    Throws:
    
    ConnectionRestrictionFailedException
  - 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
  - isTokenRequest
```
protected boolean isTokenRequest()
```
    Sprawdzenie czy zapytanie wymaga autoryzacji przy użyciu tokena
  - checkTokenValidity
```
protected void checkTokenValidity()
                           throws RefreshTokenException
```
    Metoda jest wykonywana dla Requestów implementujących interfejs TokenRequest. Pierwszą rzeczą jest sprawdzanie zalogowanie użytkownika, gdy nie jest - pomijamy wykonywanie dalszej części kody. Następie używany jest ThreadLock - singleton synchronizujący dostęp wsyzstkich wątków z niego korzystających. Dzięki ThreadLock tylko jeden wątek odświeży token, zapisze go i udostępni innym wątkom do użycia.
    
    Throws:
    
    RefreshTokenException
  - prepareRequest
```
protected abstract void prepareRequest()
```
    Metoda, w której powinna byc wykonana konfiguracja zapytania.
    
    See Also:
    
    setUrlSegments(String...), putParameter(String, Object), putUrlParameter(String, Object)
  - request
```
protected abstract Response request()
                             throws java.io.IOException
```
    Metoda zwracająca wynik zapytania api
    
    Throws:
    
    java.io.IOException
  - 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");
  - putUrlParameter
```
protected void putUrlParameter(java.lang.String parameter,
                               java.lang.Object value)
```
  - putUrlParameter
```
protected void putUrlParameter(java.lang.Object value)
```
  - putParameter
```
protected void putParameter(java.lang.String parameter,
                            java.lang.Object value)
```
  - putParameter
```
protected void putParameter(java.lang.Object value)
```
  - toObject
```
protected java.lang.String[] toObject(java.lang.String... names)
```
  - 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
  - obtainStringValue
```
protected java.lang.String obtainStringValue(java.lang.Object value)
```

Class Request<T>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONTENT_TYPE

MEDIA_TYPE

MULTIPART_MEDIA_TYPE

ACCESS_TOKEN

AUTHORIZATION

mUserService

sConfiguration

mHttpClient

isMultipartRequest

Constructor Detail

Request

Method Detail

setUserService

setRestConfiguration

execute

execute

createRequestTask

readResponse

parseToObject

checkConnectionRestrictions

getParameterType

getParameterClass

isTokenRequest

checkTokenValidity

prepareRequest

request

getUrl

setUrlSegments

putUrlParameter

putUrlParameter

putParameter

putParameter

toObject

getRequestBody

obtainStringValue