org.sagebionetworks.bridge.rest

Class ApiClientProvider

java.lang.Object

org.sagebionetworks.bridge.rest.ApiClientProvider

public class ApiClientProvider
extends Object

Base class for creating clients that are correctly configured to communicate with the Bridge server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ApiClientProvider.AuthenticatedClientProvider Base class for creating authenticated clients that are correctly configured to communicate with a Bridge study.
class	ApiClientProvider.AuthenticatedClientProviderBuilder Builder for AuthenticatedClientProvider.

Constructor Summary

Constructors

Constructor and Description
ApiClientProvider(String baseUrl, String userAgent, String acceptLanguage, String appId) Creates a builder for accessing services associated with an environment and app.
ApiClientProvider(String baseUrl, String userAgent, String acceptLanguage, String appId, SocketFactory socketFactory, List<okhttp3.Interceptor> networkInterceptors, List<okhttp3.Interceptor> applicationInterceptors) Creates a builder for accessing services associated with an environment and appId.

Method Summary

Modifier and Type	Method and Description
ApiClientProvider.AuthenticatedClientProviderBuilder	getAuthenticatedClientProviderBuilder() Returns a builder for authenticated access to this app.
AuthenticationApi	getAuthenticationApi() Get an instance of the Authentication API client.
<T> T	getClient(Class<T> service) Create an unauthenticated client (this client cannot authenticate automatically, and is only used for public APIs not requiring a server user to access).

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiClientProvider

public ApiClientProvider(String baseUrl,
                         String userAgent,
                         String acceptLanguage,
                         String appId)

Creates a builder for accessing services associated with an environment and app.

Parameters:

baseUrl - base url for Bridge service

userAgent - user-agent string in Bridge's expected format, see RestUtils.getUserAgent(ClientInfo)

acceptLanguage - optional comma-separated list of preferred languages for this client (most to least preferred

appId - app identifier

ApiClientProvider

public ApiClientProvider(String baseUrl,
                         String userAgent,
                         String acceptLanguage,
                         String appId,
                         SocketFactory socketFactory,
                         List<okhttp3.Interceptor> networkInterceptors,
                         List<okhttp3.Interceptor> applicationInterceptors)

Creates a builder for accessing services associated with an environment and appId.

Parameters:

baseUrl - base url for Bridge service

userAgent - user-agent string in Bridge's expected format, see RestUtils.getUserAgent(ClientInfo)

acceptLanguage - optional comma-separated list of preferred languages for this client (most to least preferred

appId - app identifier

socketFactory - optional factory to customize how OkHttp creates sockets. This is used on Android to associate a socket with statistics for the current thread, as required by Android O. If no factory is passed, the result is OkHttp's default behavior

networkInterceptors - additional network applicationInterceptors

applicationInterceptors - additional application applicationInterceptors

Method Detail

getClient

public <T> T getClient(Class<T> service)

Create an unauthenticated client (this client cannot authenticate automatically, and is only used for public APIs not requiring a server user to access).

Type Parameters:

T - One of the Api classes in the org.sagebionetworks.bridge.rest.api package.

Parameters:

service - Class representing the service

Returns:

service client

getAuthenticationApi

public AuthenticationApi getAuthenticationApi()

Get an instance of the Authentication API client.

Basically a convenience wrapper for getClient(AuthenticationApi.class).

Returns:

authentication API

getAuthenticatedClientProviderBuilder

public ApiClientProvider.AuthenticatedClientProviderBuilder getAuthenticatedClientProviderBuilder()

Returns a builder for authenticated access to this app.

Returns:

builder for creating authenticated clients