software.reloadly.sdk.core.internal.net

Class ServiceAPI

java.lang.Object

software.reloadly.sdk.core.internal.net.API

software.reloadly.sdk.core.internal.net.ServiceAPI

public abstract class ServiceAPI
extends API

Field Summary

Fields

Modifier and Type	Field and Description
protected String	accessToken
protected boolean	cacheAccessToken

Fields inherited from class software.reloadly.sdk.core.internal.net.API

client, clientId, clientSecret, enableLogging, enableTelemetry, KEY_CLIENT_ID, KEY_CLIENT_SECRET

Constructor Summary

Constructors

Constructor and Description
ServiceAPI(String clientId, String clientSecret, String accessToken, boolean enableLogging, List<String> redactHeaders, HttpOptions options, Boolean enableTelemetry, String sdkVersion, String apiVersion)

Method Summary

Modifier and Type	Method and Description
boolean	isAccessTokenCached()
abstract void	refreshAccessToken(Request<?> request) Retrieve a new API access token to use on new calls.
protected void	setAccessToken(String accessToken) Update the API access token to use on new calls.
protected void	validateCredentials()

Methods inherited from class software.reloadly.sdk.core.internal.net.API

createUrlFromString, isLoggingEnabled

Methods inherited from class java.lang.Object

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

Field Detail

accessToken

protected String accessToken

cacheAccessToken

protected boolean cacheAccessToken

Constructor Detail

ServiceAPI

public ServiceAPI(String clientId,
                  String clientSecret,
                  String accessToken,
                  boolean enableLogging,
                  List<String> redactHeaders,
                  HttpOptions options,
                  Boolean enableTelemetry,
                  String sdkVersion,
                  @Nullable
                  String apiVersion)

Method Detail

refreshAccessToken

public abstract void refreshAccessToken(Request<?> request)
                                 throws ReloadlyException

Retrieve a new API access token to use on new calls. This is useful when the token is about to expire or already has.

Parameters:

request - - The request to refresh the token for

Throws:

ReloadlyException - - Error captured when executing a http request to the Reloadly Server

isAccessTokenCached

public boolean isAccessTokenCached()

validateCredentials

protected void validateCredentials()

setAccessToken

protected void setAccessToken(String accessToken)

Update the API access token to use on new calls. This is useful when the token is about to expire or already has.

Parameters:

accessToken - the token to authenticate the calls with.