org.sagebionetworks.bridge.rest

Class ClientManager

java.lang.Object

org.sagebionetworks.bridge.rest.ClientManager

public class ClientManager
extends Object

ClientManager provides support for configuring API classes using values set via a properties file (~/bridge-sdk.properties), from environment variables, or from Java system variables. The key values you can set:

ENV (env in properties file) or HOST (host in properties file

Bridge knows the location of four Bridge servers based on an ENV property (local, develop, staging, and production). An alternative to setting the host server through the ENV property, you can also set the service host directly (e.g. "https://bridge.deployment.com/").

LOG_LEVEL (log.level in properties file)

The Bridge Java REST SDK uses the [LF4J](http://www.slf4j.org/) logging library, and the SDK is set by default to only log messages of WARN level or higher to the console. If you wish to see more details about the SDK’s behavior, you can set this property.

LANGUAGES (languages in properties file)

A comma-separated list of preferred languages for this client (most to least preferred). Optional.

ACCOUNT_EMAIL (account.email in properties file)

The email address of your account.

ACCOUNT_PASSWORD (account.password in properties file)

The password of your account.

ACCOUNT_APP_ID (account.app.id in properties file)

The identifier of the app your account is in (not the name, but the ID).

APP_NAME (app.name in properties file)

The name of your application as sent in the User-Agent header.

APP_VERSION (app.version in properties file)

The version of your application (must be a positive integer that increases with each app release, often called a "build number". Not a semantic version number).

DEVICE_NAME (device.name in properties file)

The name of the device/device hardware your app is running on.

OS_NAME (os.name in properties file)

The name of the operating system (Bridge will filter content based on "iPhone OS" or "Android" as a value for this setting.

OS_VERSION (os.version in properties file)

The operating system version of the client (a string in any format).

SDK_VERSION

The build version number for the Bridge Java REST SDK. This value should not need to be set (it is set by the SDK).

Once you provide credentials (through configuration or programmatically), clients retrieved through this class will re-authenticate the caller if the session expires.

The ClientManager contacts our production servers unless you configure another Environment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientManager.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	getAcceptedLanguages()
<T> T	getClient(Class<T> service)
ClientInfo	getClientInfo()
Config	getConfig()
String	getHostUrl()
UserSessionInfo	getSessionOfClients()
static String	getUrl(Environment env)

Methods inherited from class java.lang.Object

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

Method Detail

getSessionOfClients

public final UserSessionInfo getSessionOfClients()

getConfig

public final Config getConfig()

getClientInfo

public final ClientInfo getClientInfo()

getAcceptedLanguages

public final List<String> getAcceptedLanguages()

getHostUrl

public final String getHostUrl()

getUrl

public static String getUrl(Environment env)

getClient

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

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