org.sagebionetworks.bridge.rest

Class ClientManager.Builder

java.lang.Object

org.sagebionetworks.bridge.rest.ClientManager.Builder

Enclosing class:

ClientManager

public static final class ClientManager.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ClientManager	build()
ClientManager.Builder	withAcceptLanguage(List<String> acceptLanguages) Provide the languages this caller can accept to the server, in an ordered list of two-character language codes (in order of most preferred, to least preferred).
ClientManager.Builder	withClientInfo(ClientInfo clientInfo) Provide a ClientInfo object for requests made by clients from this ClientManager.
ClientManager.Builder	withConfig(Config config) Provide a configuration object for this ClientManager.
ClientManager.Builder	withIncludeUserAgent(boolean includeUserAgent) True if you want the ClientManager to include the User-Agent header in requests.
ClientManager.Builder	withSignIn(SignIn signIn) Provide the sign in credentials for clients from this ClientManager.
ClientManager.Builder	withUserAgentOverride(String userAgentOverride) Provide a User-Agent string that will be used instead of the ClientInfo object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withConfig

public ClientManager.Builder withConfig(Config config)

Provide a configuration object for this ClientManager. A default configuration is created if none is provided.

Parameters:

config - a Config object

Returns:

builder

withClientInfo

public ClientManager.Builder withClientInfo(ClientInfo clientInfo)

Provide a ClientInfo object for requests made by clients from this ClientManager. This information is used to create a well-formed User-Agent header for requests. If you provide a clientInfo object to the ClientManager, any values that would be set in the properties file (e.g. device.name or app.version) will be ignored. If you want to change these values, create the client manager and then update the resulting clientInfo object.

Parameters:

clientInfo - a ClientInfo object

Returns:

builder

withAcceptLanguage

public ClientManager.Builder withAcceptLanguage(List<String> acceptLanguages)

Provide the languages this caller can accept to the server, in an ordered list of two-character language codes (in order of most preferred, to least preferred). Duplicate language codes are ignored (first in order takes preference). If the app is offered in more than one language, this preferred language may change the content returned from the server. These language preferences are considered optional by the Bridge server, though your specific app may require that a language be specified to deliver the correct content. If no language match occurs (or these preferences are not provided), virtually all studies are configured to return default content in the app's primary language.

Parameters:

acceptLanguages - an optional, ordered list of two-letter language codes, from most preferred language to least preferred language

Returns:

builder

withIncludeUserAgent

public ClientManager.Builder withIncludeUserAgent(boolean includeUserAgent)

True if you want the ClientManager to include the User-Agent header in requests. Defaults to true.

withSignIn

public ClientManager.Builder withSignIn(SignIn signIn)

Provide the sign in credentials for clients from this ClientManager. This information can be provided via configuration, or programmatically through this object.

Parameters:

signIn - a SignIn object

Returns:

builder

withUserAgentOverride

public ClientManager.Builder withUserAgentOverride(String userAgentOverride)

Provide a User-Agent string that will be used instead of the ClientInfo object. This is useful if you want to provide a custom User-Agent string.

build

public ClientManager build()