com.microstrategy.ushersdk

Class UsherSdk.Configuration.Builder

java.lang.Object

com.microstrategy.ushersdk.UsherSdk.Configuration.Builder

Enclosing class:

UsherSdk.Configuration

public abstract static class UsherSdk.Configuration.Builder
extends java.lang.Object

The UsherSdk.Configuration.Builder abstract class allows the user to create and return an UsherSdk.Configuration object. For example,
return UsherSdk.Configuration.builder()
.application(this)
.serverUrl("www.microstrategy.com")
.appId("MyApplication")
.build();

Method Summary

Modifier and Type	Method and Description
abstract UsherSdk.Configuration.Builder	appId(java.lang.String appId) Returns the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.appId() component of the UsherSdk.Configuration object.
abstract UsherSdk.Configuration.Builder	application(android.app.Application application) Returns the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.application() component of the UsherSdk.Configuration object.
abstract UsherSdk.Configuration	build() Builds the UsherSdk.Configuration object that is used to initialize the UsherSdk object.
abstract UsherSdk.Configuration.Builder	enableTrustOnFirstUse(boolean enableTrustOnFirstUse) When certificate pinning is enforced, the connection between the SDK and server will work on the trust-on-first-use (TOFU) model.
abstract UsherSdk.Configuration.Builder	networkConnectionTimeout(int networkConnectionTimeout) Returns the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.networkConnectionTimeout() component of the UsherSdk.Configuration object.
abstract UsherSdk.Configuration.Builder	serverUrl(java.lang.String serverUrl) Returns the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.serverUrl() component of the UsherSdk.Configuration object.

Methods inherited from class java.lang.Object

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

Method Detail

application

public abstract UsherSdk.Configuration.Builder application(android.app.Application application)

Returns the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.application() component of the UsherSdk.Configuration object.

Parameters:

application - the application that the UsherSdk.Configuration is to be initialized for. See Application

Returns:

the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.application() component of the UsherSdk.Configuration object.

serverUrl

public abstract UsherSdk.Configuration.Builder serverUrl(java.lang.String serverUrl)

Returns the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.serverUrl() component of the UsherSdk.Configuration object.

Parameters:

serverUrl - the URL of the server to handle http requests

Returns:

the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.serverUrl() component of the UsherSdk.Configuration object.

appId

public abstract UsherSdk.Configuration.Builder appId(java.lang.String appId)

Returns the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.appId() component of the UsherSdk.Configuration object.

Parameters:

appId - the application ID

Returns:

the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.appId() component of the UsherSdk.Configuration object.

enableTrustOnFirstUse

public abstract UsherSdk.Configuration.Builder enableTrustOnFirstUse(boolean enableTrustOnFirstUse)

When certificate pinning is enforced, the connection between the SDK and server will work on the trust-on-first-use (TOFU) model. The first time that we encounter a new domain, we assume that whatever certificates that we receive are good, and we memorize them. If additional HTTP requests to the server are to be made, the SDK will validate the certificate first. If a validation failure occurs, the SDK will throw an UsherException.NETWORK_INVALID_CERTIFICATE. This flag is usually enabled to prevent a man-in-the-middle (MITM) attack.

By default, this value is false, which means that the security for the network connection falls upon the default system behavior.

Returns the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.enableTrustOnFirstUse() component of the UsherSdk.Configuration object.

Parameters:

enableTrustOnFirstUse - true if the trust-on-first-use model is requested; false otherwise

Returns:

the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.enableTrustOnFirstUse() component of the UsherSdk.Configuration object.

networkConnectionTimeout

public abstract UsherSdk.Configuration.Builder networkConnectionTimeout(int networkConnectionTimeout)

Returns the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.networkConnectionTimeout() component of the UsherSdk.Configuration object. By default, this value is 15s.

Returns the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.networkConnectionTimeout() component of the UsherSdk.Configuration object.

Parameters:

networkConnectionTimeout - network time out param

Returns:

the UsherSdk.Configuration.Builder for the UsherSdk.Configuration.networkConnectionTimeout() component of the UsherSdk.Configuration object.

build

public abstract UsherSdk.Configuration build()

Builds the UsherSdk.Configuration object that is used to initialize the UsherSdk object.

Returns:

the UsherSdk.Configuration object that is used to initialize the UsherSdk object.