net.gini.android.vision.network

Class GiniVisionDefaultNetworkService.Builder

java.lang.Object

net.gini.android.vision.network.GiniVisionDefaultNetworkService.Builder

Enclosing class:

GiniVisionDefaultNetworkService

public static class GiniVisionDefaultNetworkService.Builder
extends java.lang.Object

Builder for configuring a new instance of the GiniVisionDefaultNetworkService.

Method Summary

Modifier and Type	Method and Description
GiniVisionDefaultNetworkService	build() Create a new instance of the GiniVisionDefaultNetworkService.
GiniVisionDefaultNetworkService.Builder	setBackoffMultiplier(float backoffMultiplier) Sets the backoff multiplication factor for connection retries.
GiniVisionDefaultNetworkService.Builder	setBaseUrl(java.lang.String baseUrl) Set the base URL of the Gini API.
GiniVisionDefaultNetworkService.Builder	setCache(Cache cache) Set the cache implementation to use with Volley.
GiniVisionDefaultNetworkService.Builder	setClientCredentials(java.lang.String clientId, java.lang.String clientSecret, java.lang.String emailDomain) Set your Gini API client ID and secret.
GiniVisionDefaultNetworkService.Builder	setConnectionTimeout(long connectionTimeout) Set the (initial) timeout for each request.
GiniVisionDefaultNetworkService.Builder	setConnectionTimeoutUnit(java.util.concurrent.TimeUnit connectionTimeoutUnit) Set the connection timeout's time unit.
GiniVisionDefaultNetworkService.Builder	setCredentialsStore(CredentialsStore credentialsStore) Set the credentials store which is used by the Gini API SDK to store user credentials.
GiniVisionDefaultNetworkService.Builder	setDocumentMetadata(DocumentMetadata documentMetadata) Set additional information related to the documents.
GiniVisionDefaultNetworkService.Builder	setMaxNumberOfRetries(int maxNumberOfRetries) Set the maximal number of retries for each network request.
GiniVisionDefaultNetworkService.Builder	setNetworkSecurityConfigResId(int networkSecurityConfigResId) Set the resource id for the network security configuration xml to enable public key pinning.
GiniVisionDefaultNetworkService.Builder	setSessionManager(SessionManager sessionManager) Set a custom SessionManager implementation for handling sessions.
GiniVisionDefaultNetworkService.Builder	setUserCenterBaseUrl(java.lang.String userCenterBaseUrl) Set the base URL of the Gini User Center API.

Methods inherited from class java.lang.Object

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

Method Detail

build

public GiniVisionDefaultNetworkService build()

Create a new instance of the GiniVisionDefaultNetworkService.

Returns:

new GiniVisionDefaultNetworkService instance

setClientCredentials

public GiniVisionDefaultNetworkService.Builder setClientCredentials(java.lang.String clientId,
                                                                    java.lang.String clientSecret,
                                                                    java.lang.String emailDomain)

Set your Gini API client ID and secret. The email domain is used when generating anonymous Gini users in the form of UUID@your-email-domain.

Parameters:

clientId - your application's client ID for the Gini API

clientSecret - your application's client secret for the Gini API

emailDomain - the email domain which is used for created Gini users

Returns:

the GiniVisionDefaultNetworkService.Builder instance

setSessionManager

public GiniVisionDefaultNetworkService.Builder setSessionManager(SessionManager sessionManager)

Set a custom SessionManager implementation for handling sessions.

Parameters:

sessionManager - the SessionManager to use

Returns:

the GiniVisionDefaultNetworkService.Builder instance

setBaseUrl

public GiniVisionDefaultNetworkService.Builder setBaseUrl(java.lang.String baseUrl)

Set the base URL of the Gini API.

Parameters:

baseUrl - custom Gini API base URL

Returns:

the GiniVisionDefaultNetworkService.Builder instance

setUserCenterBaseUrl

public GiniVisionDefaultNetworkService.Builder setUserCenterBaseUrl(java.lang.String userCenterBaseUrl)

Set the base URL of the Gini User Center API.

Parameters:

userCenterBaseUrl - custom Gini API base URL

Returns:

the GiniVisionDefaultNetworkService.Builder instance

setCache

public GiniVisionDefaultNetworkService.Builder setCache(Cache cache)

Set the cache implementation to use with Volley. If no cache is set, the default Volley cache will be used.

Parameters:

cache - a cache instance (specified by the com.android.volley.Cache interface)

Returns:

the GiniVisionDefaultNetworkService.Builder instance

setCredentialsStore

public GiniVisionDefaultNetworkService.Builder setCredentialsStore(CredentialsStore credentialsStore)

Set the credentials store which is used by the Gini API SDK to store user credentials. If no credentials store is set, the SharedPreferencesCredentialsStore from the Gini API SDK is used by default.

Parameters:

credentialsStore - a credentials store instance (specified by the CredentialsStore interface)

Returns:

the GiniVisionDefaultNetworkService.Builder instance

setNetworkSecurityConfigResId

public GiniVisionDefaultNetworkService.Builder setNetworkSecurityConfigResId(int networkSecurityConfigResId)

Set the resource id for the network security configuration xml to enable public key pinning.

Parameters:

networkSecurityConfigResId - xml resource id

Returns:

the GiniVisionDefaultNetworkService.Builder instance

setConnectionTimeout

public GiniVisionDefaultNetworkService.Builder setConnectionTimeout(long connectionTimeout)

Set the (initial) timeout for each request. A timeout error will occur if nothing is received from the underlying socket in the given time span. The initial timeout will be altered depending on the backoff multiplier and failed retries.

Parameters:

connectionTimeout - initial timeout

Returns:

the GiniVisionDefaultNetworkService.Builder instance

setConnectionTimeoutUnit

public GiniVisionDefaultNetworkService.Builder setConnectionTimeoutUnit(java.util.concurrent.TimeUnit connectionTimeoutUnit)

Set the connection timeout's time unit.

Parameters:

connectionTimeoutUnit - the time unit

Returns:

the GiniVisionDefaultNetworkService.Builder instance

setMaxNumberOfRetries

public GiniVisionDefaultNetworkService.Builder setMaxNumberOfRetries(int maxNumberOfRetries)

Set the maximal number of retries for each network request.

Parameters:

maxNumberOfRetries - maximal number of retries

Returns:

the GiniVisionDefaultNetworkService.Builder instance

setBackoffMultiplier

public GiniVisionDefaultNetworkService.Builder setBackoffMultiplier(float backoffMultiplier)

Sets the backoff multiplication factor for connection retries. In case of failed retries the timeout of the last request attempt is multiplied by this factor.

Parameters:

backoffMultiplier - the backoff multiplication factor

Returns:

the GiniVisionDefaultNetworkService.Builder instance

setDocumentMetadata

public GiniVisionDefaultNetworkService.Builder setDocumentMetadata(DocumentMetadata documentMetadata)

Set additional information related to the documents. This metadata will be passed to all document uploads.

Parameters:

documentMetadata - a DocumentMetadata instance containing additional information for the uploaded documents

Returns:

the GiniVisionDefaultNetworkService.Builder instance