com.contentful.java.cma

Class CMAClient.Builder

java.lang.Object

com.contentful.java.cma.CMAClient.Builder

Enclosing class:

CMAClient

public static class CMAClient.Builder
extends Object

Builder.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CMAClient	build()
okhttp3.OkHttpClient.Builder	defaultCoreCallFactoryBuilder()
okhttp3.OkHttpClient.Builder	defaultUploadCallFactoryBuilder()
CMAClient.Builder	setAccessToken(String accessToken) Sets the access token for this client.
CMAClient.Builder	setApplication(String name, String version) Tell the client which application this is.
CMAClient.Builder	setCallbackExecutor(Executor executor) Sets the executor to use when invoking asynchronous callbacks.
CMAClient.Builder	setCoreCallFactory(okhttp3.Call.Factory callFactory) Sets a custom HTTP call factory for core modules.
CMAClient.Builder	setCoreEndpoint(String remoteUrl) Overrides the default remote URL for core modules.
CMAClient.Builder	setEnvironmentId(String environmentId) Configure which environment to use if none is specified.
CMAClient.Builder	setIntegration(String name, String version) Which integration is used.
CMAClient.Builder	setLogger(Logger logger) Sets the logger to be used for logging all network requests or all application requests.
CMAClient.Builder	setLogLevel(Logger.Level logLevel) Sets the log level for this client.
CMAClient.Builder	setLogSensitiveData(boolean logSensitiveData)
CMAClient.Builder	setRateLimitListener(RateLimitsListener listener) Add a listener to receive information about rate limits.
CMAClient.Builder	setSpaceId(String spaceId) Configure which space to use if none is specified.
CMAClient.Builder	setUploadCallFactory(okhttp3.Call.Factory callFactory) Sets a custom HTTP call factory for the upload module.
CMAClient.Builder	setUploadEndpoint(String remoteUrl) Overrides the remote URL for upload module.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setCoreEndpoint

public CMAClient.Builder setCoreEndpoint(String remoteUrl)

Overrides the default remote URL for core modules.

Parameters:

remoteUrl - String representing the remote URL

Returns:

this CMAClient.Builder instance

See Also:

setUploadEndpoint(String)

setLogSensitiveData

public CMAClient.Builder setLogSensitiveData(boolean logSensitiveData)

setUploadEndpoint

public CMAClient.Builder setUploadEndpoint(String remoteUrl)

Overrides the remote URL for upload module.

Parameters:

remoteUrl - String representing the remote URL

Returns:

this CMAClient.Builder instance

See Also:

setCoreEndpoint(String)

setAccessToken

public CMAClient.Builder setAccessToken(String accessToken)

Sets the access token for this client.

Parameters:

accessToken - access token

Returns:

this CMAClient.Builder instance

setSpaceId

public CMAClient.Builder setSpaceId(String spaceId)

Configure which space to use if none is specified.

Parameters:

spaceId - the id of the space to be used.

Returns:

this CMAClient.Builder instance.

See Also:

ModuleEntries.fetchAll()

setEnvironmentId

public CMAClient.Builder setEnvironmentId(String environmentId)

Configure which environment to use if none is specified.

Parameters:

environmentId - the id of the environment to be used.

Returns:

this CMAClient.Builder instance.

See Also:

ModuleEntries.fetchAll()

setCoreCallFactory

public CMAClient.Builder setCoreCallFactory(okhttp3.Call.Factory callFactory)

Sets a custom HTTP call factory for core modules.

Please also add a AuthorizationHeaderInterceptor ContentTypeInterceptor if you are using a custom call factory to ensure properly setup http headers.

Parameters:

callFactory - Call.Factory instance

Returns:

this Builder instance

setUploadCallFactory

public CMAClient.Builder setUploadCallFactory(okhttp3.Call.Factory callFactory)

Sets a custom HTTP call factory for the upload module.

Parameters:

callFactory - Call.Factory instance

Returns:

this Builder instance

See Also:

Call.Factory for needed interceptors.

setCallbackExecutor

public CMAClient.Builder setCallbackExecutor(Executor executor)

Sets the executor to use when invoking asynchronous callbacks.

Parameters:

executor - Executor on which any CMACallback methods will be invoked. This defaults to execute on the main thread for Android projects. For non-Android projects this defaults to the same thread of the HTTP client.

Returns:

this Builder instance

setLogger

public CMAClient.Builder setLogger(Logger logger)

Sets the logger to be used for logging all network requests or all application requests.

Parameters:

logger - Logger

Returns:

this Builder instance

setLogLevel

public CMAClient.Builder setLogLevel(Logger.Level logLevel)

Sets the log level for this client.

Parameters:

logLevel - Logger.Level value

Returns:

this Builder instance

setApplication

public CMAClient.Builder setApplication(String name,
                                        String version)

Tell the client which application this is.

It might be used for internal tracking of Contentfuls tools.

Parameters:

name - the name of the app.

version - the version in semver of the app.

Returns:

this builder for chaining.

setIntegration

public CMAClient.Builder setIntegration(String name,
                                        String version)

Which integration is used.

Parameters:

name - name of the integration.

version - the version of the integration.

Returns:

this builder for chaining.

setRateLimitListener

public CMAClient.Builder setRateLimitListener(RateLimitsListener listener)

Add a listener to receive information about rate limits.

Parameters:

listener - a listener interface to be informed, as soon as a rate limit header is found.

Returns:

this builder for chaining.

build

public CMAClient build()

Returns:

a CMAClient out of this CMAClient.Builder.

defaultCoreCallFactoryBuilder

public okhttp3.OkHttpClient.Builder defaultCoreCallFactoryBuilder()

Returns:

default core call factory builder, used by the sdk.

defaultUploadCallFactoryBuilder

public okhttp3.OkHttpClient.Builder defaultUploadCallFactoryBuilder()

Returns:

default update api call factory builder, used by the sdk.