io.formapi

Class ApiClient

java.lang.Object

io.formapi.ApiClient

public class ApiClient
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiClient()
ApiClient(String authName) Basic constructor for single auth name
ApiClient(String[] authNames)
ApiClient(String authName, String apiKey) Helper constructor for single api key
ApiClient(String authName, String username, String password) Helper constructor for single basic auth or password oauth2
ApiClient(String authName, String clientId, String secret, String username, String password) Helper constructor for single password oauth2

Method Summary

Modifier and Type	Method and Description
ApiClient	addAuthorization(String authName, okhttp3.Interceptor authorization) Adds an authorization to be used by the client
void	addAuthsToOkBuilder(okhttp3.OkHttpClient.Builder okBuilder)
ApiClient	configureAuthorizationFlow(String clientId, String clientSecret, String redirectURI) Helper method to configure the oauth accessCode/implicit flow parameters
void	configureFromOkclient(okhttp3.OkHttpClient okClient) Clones the okBuilder given in parameter, adds the auth interceptors and uses it to configure the Retrofit
void	createDefaultAdapter()
<S> S	createService(Class<S> serviceClass)
retrofit2.Retrofit.Builder	getAdapterBuilder()
Map<String,okhttp3.Interceptor>	getApiAuthorizations()
org.apache.oltu.oauth2.client.request.OAuthClientRequest.AuthenticationRequestBuilder	getAuthorizationEndPoint() Helper method to configure authorization endpoint of the first oauth found in the apiAuthorizations (there should be only one)
okhttp3.OkHttpClient.Builder	getOkBuilder()
org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder	getTokenEndPoint() Helper method to configure the token endpoint of the first oauth found in the apiAuthorizations (there should be only one)
ApiClient	registerAccessTokenListener(OAuth.AccessTokenListener accessTokenListener) Configures a listener which is notified when a new access token is received.
ApiClient	setAccessToken(String accessToken) Helper method to pre-set the oauth access token of the first oauth found in the apiAuthorizations (there should be only one)
ApiClient	setAdapterBuilder(retrofit2.Retrofit.Builder adapterBuilder)
ApiClient	setApiAuthorizations(Map<String,okhttp3.Interceptor> apiAuthorizations)
ApiClient	setApiKey(String apiKey) Helper method to configure the first api key found
ApiClient	setCredentials(String username, String password) Helper method to configure the username/password for basic auth or password oauth
ApiClient	setDateFormat(DateFormat dateFormat)
ApiClient	setLocalDateFormat(org.threeten.bp.format.DateTimeFormatter dateFormat)
ApiClient	setOffsetDateTimeFormat(org.threeten.bp.format.DateTimeFormatter dateFormat)
ApiClient	setSqlDateFormat(DateFormat dateFormat)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiClient

public ApiClient()

ApiClient

public ApiClient(String[] authNames)

ApiClient

public ApiClient(String authName)

Basic constructor for single auth name

Parameters:

authName - Authentication name

ApiClient

public ApiClient(String authName,
                 String apiKey)

Helper constructor for single api key

Parameters:

authName - Authentication name

apiKey - API key

ApiClient

public ApiClient(String authName,
                 String username,
                 String password)

Helper constructor for single basic auth or password oauth2

Parameters:

authName - Authentication name

username - Username

password - Password

ApiClient

public ApiClient(String authName,
                 String clientId,
                 String secret,
                 String username,
                 String password)

Helper constructor for single password oauth2

Parameters:

authName - Authentication name

clientId - Client ID

secret - Client Secret

username - Username

password - Password

Method Detail

createDefaultAdapter

public void createDefaultAdapter()

createService

public <S> S createService(Class<S> serviceClass)

setDateFormat

public ApiClient setDateFormat(DateFormat dateFormat)

setSqlDateFormat

public ApiClient setSqlDateFormat(DateFormat dateFormat)

setOffsetDateTimeFormat

public ApiClient setOffsetDateTimeFormat(org.threeten.bp.format.DateTimeFormatter dateFormat)

setLocalDateFormat

public ApiClient setLocalDateFormat(org.threeten.bp.format.DateTimeFormatter dateFormat)

setApiKey

public ApiClient setApiKey(String apiKey)

Helper method to configure the first api key found

Parameters:

apiKey - API key

Returns:

ApiClient

setCredentials

public ApiClient setCredentials(String username,
                                String password)

Helper method to configure the username/password for basic auth or password oauth

Parameters:

username - Username

password - Password

Returns:

ApiClient

getTokenEndPoint

public org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder getTokenEndPoint()

Helper method to configure the token endpoint of the first oauth found in the apiAuthorizations (there should be only one)

Returns:

Token request builder

getAuthorizationEndPoint

public org.apache.oltu.oauth2.client.request.OAuthClientRequest.AuthenticationRequestBuilder getAuthorizationEndPoint()

Helper method to configure authorization endpoint of the first oauth found in the apiAuthorizations (there should be only one)

Returns:

Authentication request builder

setAccessToken

public ApiClient setAccessToken(String accessToken)

Helper method to pre-set the oauth access token of the first oauth found in the apiAuthorizations (there should be only one)

Parameters:

accessToken - Access token

Returns:

ApiClient

configureAuthorizationFlow

public ApiClient configureAuthorizationFlow(String clientId,
                                            String clientSecret,
                                            String redirectURI)

Helper method to configure the oauth accessCode/implicit flow parameters

Parameters:

clientId - Client ID

clientSecret - Client secret

redirectURI - Redirect URI

Returns:

ApiClient

registerAccessTokenListener

public ApiClient registerAccessTokenListener(OAuth.AccessTokenListener accessTokenListener)

Configures a listener which is notified when a new access token is received.

Parameters:

accessTokenListener - Access token listener

Returns:

ApiClient

addAuthorization

public ApiClient addAuthorization(String authName,
                                  okhttp3.Interceptor authorization)

Adds an authorization to be used by the client

Parameters:

authName - Authentication name

authorization - Authorization interceptor

Returns:

ApiClient

getApiAuthorizations

public Map<String,okhttp3.Interceptor> getApiAuthorizations()

setApiAuthorizations

public ApiClient setApiAuthorizations(Map<String,okhttp3.Interceptor> apiAuthorizations)

getAdapterBuilder

public retrofit2.Retrofit.Builder getAdapterBuilder()

setAdapterBuilder

public ApiClient setAdapterBuilder(retrofit2.Retrofit.Builder adapterBuilder)

getOkBuilder

public okhttp3.OkHttpClient.Builder getOkBuilder()

addAuthsToOkBuilder

public void addAuthsToOkBuilder(okhttp3.OkHttpClient.Builder okBuilder)

configureFromOkclient

public void configureFromOkclient(okhttp3.OkHttpClient okClient)

Clones the okBuilder given in parameter, adds the auth interceptors and uses it to configure the Retrofit

Parameters:

okClient - An instance of OK HTTP client