com.snowplowanalytics.snowplow.network

Class OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder

java.lang.Object

com.snowplowanalytics.snowplow.network.OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder

Enclosing class:

OkHttpNetworkConnection

public static class OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder
extends Object

Builder for the OkHttpNetworkConnection.

Constructor Summary

Constructors

Constructor and Description
OkHttpNetworkConnectionBuilder(String uri)

Method Summary

Modifier and Type	Method and Description
OkHttpNetworkConnection	build() Creates a new OkHttpNetworkConnection
OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder	client(okhttp3.OkHttpClient client)
OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder	customPostPath(String customPostPath)
OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder	emitTimeout(int emitTimeout)
OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder	method(HttpMethod httpMethod)
OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder	tls(EnumSet<com.snowplowanalytics.snowplow.internal.emitter.TLSVersion> versions)
OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder	tls(com.snowplowanalytics.snowplow.internal.emitter.TLSVersion version)

Methods inherited from class java.lang.Object

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

Constructor Detail

OkHttpNetworkConnectionBuilder

public OkHttpNetworkConnectionBuilder(@NonNull
                                      String uri)

Parameters:

uri - The uri of the collector

Method Detail

method

@NonNull
public OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder method(@NonNull
                                                                              HttpMethod httpMethod)

Parameters:

httpMethod - The method by which requests are emitted

Returns:

itself

tls

@NonNull
public OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder tls(@NonNull
                                                                           com.snowplowanalytics.snowplow.internal.emitter.TLSVersion version)

Parameters:

version - the TLS version allowed for requests

Returns:

itself

tls

@NonNull
public OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder tls(@NonNull
                                                                           EnumSet<com.snowplowanalytics.snowplow.internal.emitter.TLSVersion> versions)

Parameters:

versions - the TLS versions allowed for requests

Returns:

itself

emitTimeout

@NonNull
public OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder emitTimeout(int emitTimeout)

Parameters:

emitTimeout - The maximum timeout for emitting events. If emit time exceeds this value TimeOutException will be thrown

Returns:

itself

client

@NonNull
public OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder client(@Nullable
                                                                              okhttp3.OkHttpClient client)

Parameters:

client - An OkHttp client that will be used in the emitter, you can provide your own if you want to share your Singleton client's interceptors, connection pool etc.. ,otherwise a new one is created.

Returns:

itself

customPostPath

@NonNull
public OkHttpNetworkConnection.OkHttpNetworkConnectionBuilder customPostPath(@Nullable
                                                                                      String customPostPath)

Parameters:

customPostPath - A custom path that is used on the endpoint to send requests.

Returns:

itself

build

@NonNull
public OkHttpNetworkConnection build()

Creates a new OkHttpNetworkConnection

Returns:

a new OkHttpNetworkConnection object