net.gini.android.vision.accounting.network

Class GiniVisionAccountingNetworkService.Builder

java.lang.Object

net.gini.android.vision.accounting.network.GiniVisionAccountingNetworkService.Builder

Enclosing class:

GiniVisionAccountingNetworkService

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

Builder for configuring a new instance of the GiniVisionAccountingNetworkService.

Method Summary

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

Create a new instance of the GiniVisionAccountingNetworkService.

Returns:

new GiniVisionAccountingNetworkService instance

setClientCredentials

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

Set your Gini Accounting 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 Accounting API

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

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

Returns:

the GiniVisionAccountingNetworkService.Builder instance

setSessionManager

public GiniVisionAccountingNetworkService.Builder setSessionManager(SessionManager sessionManager)

Set a custom SessionManager implementation for handling sessions.

Parameters:

sessionManager - the SessionManager to use

Returns:

the GiniVisionAccountingNetworkService.Builder instance

setBaseUrl

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

Set the base URL of the Gini Accounting API.

Parameters:

baseUrl - custom Gini Accounting API base URL

Returns:

the GiniVisionAccountingNetworkService.Builder instance

setUserCenterBaseUrl

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

Set the base URL of the Gini User Center API.

Parameters:

userCenterBaseUrl - custom Gini User Center API base URL

Returns:

the GiniVisionAccountingNetworkService.Builder instance

setCache

public GiniVisionAccountingNetworkService.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 GiniVisionAccountingNetworkService.Builder instance

setCredentialsStore

public GiniVisionAccountingNetworkService.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 EncryptedCredentialsStore from the Gini API SDK is used by default.

Parameters:

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

Returns:

the GiniVisionAccountingNetworkService.Builder instance

setNetworkSecurityConfigResId

public GiniVisionAccountingNetworkService.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 GiniVisionAccountingNetworkService.Builder instance

setConnectionTimeout

public GiniVisionAccountingNetworkService.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 GiniVisionAccountingNetworkService.Builder instance

setConnectionTimeoutUnit

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

Set the connection timeout's time unit.

Parameters:

connectionTimeoutUnit - the time unit

Returns:

the GiniVisionAccountingNetworkService.Builder instance

setMaxNumberOfRetries

public GiniVisionAccountingNetworkService.Builder setMaxNumberOfRetries(int maxNumberOfRetries)

Set the maximal number of retries for each network request.

Parameters:

maxNumberOfRetries - maximal number of retries

Returns:

the GiniVisionAccountingNetworkService.Builder instance

setBackoffMultiplier

public GiniVisionAccountingNetworkService.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 GiniVisionAccountingNetworkService.Builder instance

setDocumentMetadata

public GiniVisionAccountingNetworkService.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 GiniVisionAccountingNetworkService.Builder instance