com.konfigthis.splitit.client.auth

Class RetryingOAuth

java.lang.Object

com.konfigthis.splitit.client.auth.OAuth

com.konfigthis.splitit.client.auth.RetryingOAuth

All Implemented Interfaces:

Authentication, okhttp3.Interceptor

public class RetryingOAuth
extends OAuth
implements okhttp3.Interceptor

Nested Class Summary

Nested classes/interfaces inherited from interface okhttp3.Interceptor

okhttp3.Interceptor.Chain, okhttp3.Interceptor.Companion

Field Summary

Fields inherited from interface okhttp3.Interceptor

Companion

Constructor Summary

Constructors

Constructor and Description
RetryingOAuth(org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder tokenRequestBuilder)
RetryingOAuth(okhttp3.OkHttpClient client, org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder tokenRequestBuilder)
RetryingOAuth(String tokenUrl, String clientId, OAuthFlow flow, String clientSecret, Map<String,String> parameters)

Method Summary

Modifier and Type	Method and Description
void	applyToParams(List<Pair> queryParams, Map<String,String> headerParams, Map<String,String> cookieParams, String payload, String method) Apply authentication settings to header and query params.
org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder	getTokenRequestBuilder() Gets the token request builder
okhttp3.Response	intercept(okhttp3.Interceptor.Chain chain)
void	setFlow(OAuthFlow flow) Set the OAuth flow
void	setTokenRequestBuilder(org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder tokenRequestBuilder) Sets the token request builder
boolean	updateAccessToken(String requestAccessToken) Returns true if the access token has been updated

Methods inherited from class com.konfigthis.splitit.client.auth.OAuth

getAccessToken, setAccessToken

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryingOAuth

public RetryingOAuth(okhttp3.OkHttpClient client,
                     org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder tokenRequestBuilder)

Parameters:

client - An OkHttp client

tokenRequestBuilder - A token request builder

RetryingOAuth

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

Parameters:

tokenRequestBuilder - A token request builder

RetryingOAuth

public RetryingOAuth(String tokenUrl,
                     String clientId,
                     OAuthFlow flow,
                     String clientSecret,
                     Map<String,String> parameters)

Parameters:

tokenUrl - The token URL to be used for this OAuth2 flow. Applicable to the following OAuth2 flows: "password", "clientCredentials" and "authorizationCode". The value must be an absolute URL.

clientId - The OAuth2 client ID for the "clientCredentials" flow.

flow - OAuth flow.

clientSecret - The OAuth2 client secret for the "clientCredentials" flow.

parameters - A map of string.

Method Detail

setFlow

public void setFlow(OAuthFlow flow)

Set the OAuth flow

Parameters:

flow - The OAuth flow.

intercept

public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain)
                           throws IOException

Specified by:

intercept in interface okhttp3.Interceptor

Throws:

IOException

updateAccessToken

public boolean updateAccessToken(String requestAccessToken)
                          throws IOException

Returns true if the access token has been updated

Parameters:

requestAccessToken - the request access token

Returns:

True if the update is successful

Throws:

IOException - If fail to update the access token

getTokenRequestBuilder

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

Gets the token request builder

Returns:

A token request builder

setTokenRequestBuilder

public void setTokenRequestBuilder(org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder tokenRequestBuilder)

Sets the token request builder

Parameters:

tokenRequestBuilder - Token request builder

applyToParams

public void applyToParams(List<Pair> queryParams,
                          Map<String,String> headerParams,
                          Map<String,String> cookieParams,
                          String payload,
                          String method)
                   throws ApiException

Description copied from interface: Authentication

Apply authentication settings to header and query params.

Specified by:

applyToParams in interface Authentication

Overrides:

applyToParams in class OAuth

Parameters:

queryParams - List of query parameters

headerParams - Map of header parameters

cookieParams - Map of cookie parameters

payload - HTTP request body

method - HTTP method

Throws:

ApiException - if failed to update the parameters