com.snowplowanalytics.snowplow.configuration

Class NetworkConfiguration

java.lang.Object

com.snowplowanalytics.snowplow.configuration.NetworkConfiguration

All Implemented Interfaces:

Configuration, com.snowplowanalytics.snowplow.internal.emitter.NetworkConfigurationInterface, Serializable

public class NetworkConfiguration
extends Object
implements com.snowplowanalytics.snowplow.internal.emitter.NetworkConfigurationInterface, Configuration

Represents the network communication configuration allowing the tracker to be able to send events to the Snowplow collector.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	customPostPath
NetworkConnection	networkConnection
okhttp3.OkHttpClient	okHttpClient
Integer	timeout

Constructor Summary

Constructors

Constructor and Description
NetworkConfiguration(JSONObject jsonObject)
NetworkConfiguration(NetworkConnection networkConnection)
NetworkConfiguration(String endpoint)
NetworkConfiguration(String endpoint, HttpMethod method)

Method Summary

Modifier and Type	Method and Description
Configuration	copy()
NetworkConfiguration	customPostPath(String customPostPath) A custom path which will be added to the endpoint URL to specify the complete URL of the collector when paired with the POST method.
String	getCustomPostPath()
String	getEndpoint()
HttpMethod	getMethod()
NetworkConnection	getNetworkConnection()
okhttp3.OkHttpClient	getOkHttpClient()
Protocol	getProtocol()
Integer	getTimeout()
NetworkConfiguration	okHttpClient(okhttp3.OkHttpClient okHttpClient) 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..
NetworkConfiguration	timeout(Integer timeout) The timeout set for the requests to the collector.

Methods inherited from class java.lang.Object

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

Field Detail

networkConnection

@Nullable
public NetworkConnection networkConnection

See Also:

NetworkConfiguration(NetworkConnection)

customPostPath

@Nullable
public String customPostPath

See Also:

customPostPath(String)

timeout

@Nullable
public Integer timeout

See Also:

timeout(Integer)

okHttpClient

@Nullable
public okhttp3.OkHttpClient okHttpClient

See Also:

okHttpClient(OkHttpClient)

Constructor Detail

NetworkConfiguration

public NetworkConfiguration(@NonNull
                            String endpoint)

Parameters:

endpoint - URL of the collector that is going to receive the events tracked by the tracker. The URL can include the schema/protocol (e.g.: `http://collector-url.com`). In case the URL doesn't include the schema/protocol, the HTTPS protocol is automatically selected.

NetworkConfiguration

public NetworkConfiguration(@NonNull
                            String endpoint,
                            @NonNull
                            HttpMethod method)

Parameters:

endpoint - URL of the collector that is going to receive the events tracked by the tracker. The URL can include the schema/protocol (e.g.: `http://collector-url.com`). In case the URL doesn't include the schema/protocol, the HTTPS protocol is automatically selected.

method - The method used to send the requests (GET or POST).

NetworkConfiguration

public NetworkConfiguration(@NonNull
                            NetworkConnection networkConnection)

Parameters:

networkConnection - The NetworkConnection component which will control the communication between the tracker and the collector.

NetworkConfiguration

public NetworkConfiguration(@NonNull
                            JSONObject jsonObject)

Method Detail

getEndpoint

@Nullable
public String getEndpoint()

Specified by:

getEndpoint in interface com.snowplowanalytics.snowplow.internal.emitter.NetworkConfigurationInterface

Returns:

URL (without schema/protocol) used to send events to the collector.

getMethod

@Nullable
public HttpMethod getMethod()

Specified by:

getMethod in interface com.snowplowanalytics.snowplow.internal.emitter.NetworkConfigurationInterface

Returns:

Method used to send events to the collector.

getProtocol

@Nullable
public Protocol getProtocol()

Specified by:

getProtocol in interface com.snowplowanalytics.snowplow.internal.emitter.NetworkConfigurationInterface

Returns:

Protocol used to send events to the collector.

getCustomPostPath

@Nullable
public String getCustomPostPath()

Specified by:

getCustomPostPath in interface com.snowplowanalytics.snowplow.internal.emitter.NetworkConfigurationInterface

getTimeout

@Nullable
public Integer getTimeout()

Specified by:

getTimeout in interface com.snowplowanalytics.snowplow.internal.emitter.NetworkConfigurationInterface

getNetworkConnection

@Nullable
public NetworkConnection getNetworkConnection()

Specified by:

getNetworkConnection in interface com.snowplowanalytics.snowplow.internal.emitter.NetworkConfigurationInterface

getOkHttpClient

@Nullable
public okhttp3.OkHttpClient getOkHttpClient()

Specified by:

getOkHttpClient in interface com.snowplowanalytics.snowplow.internal.emitter.NetworkConfigurationInterface

customPostPath

@NonNull
public NetworkConfiguration customPostPath(@NonNull
                                                    String customPostPath)

A custom path which will be added to the endpoint URL to specify the complete URL of the collector when paired with the POST method.

timeout

@NonNull
public NetworkConfiguration timeout(@NonNull
                                             Integer timeout)

The timeout set for the requests to the collector.

okHttpClient

@NonNull
public NetworkConfiguration okHttpClient(@NonNull
                                                  okhttp3.OkHttpClient okHttpClient)

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.

copy

@NonNull
public Configuration copy()

Specified by:

copy in interface Configuration