com.snowplowanalytics.snowplow.configuration

Class EmitterConfiguration

java.lang.Object

com.snowplowanalytics.snowplow.configuration.EmitterConfiguration

All Implemented Interfaces:

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

public class EmitterConfiguration
extends Object
implements Configuration, com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface

It allows the tracker configuration from the emission perspective. The EmitterConfiguration can be used to setup details about how the tracker should treat the events to emit to the collector.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
BufferOption	bufferOption
long	byteLimitGet
long	byteLimitPost
int	emitRange
EventStore	eventStore
RequestCallback	requestCallback
int	threadPoolSize

Constructor Summary

Constructors

Constructor and Description
EmitterConfiguration() It sets a default EmitterConfiguration.

Method Summary

Modifier and Type	Method and Description
EmitterConfiguration	bufferOption(BufferOption bufferOption) Sets whether the buffer should send events instantly or after the buffer has reached it's limit.
EmitterConfiguration	byteLimitGet(int byteLimitGet) Maximum amount of bytes allowed to be sent in a payload in a GET request.
EmitterConfiguration	byteLimitPost(int byteLimitPost) Maximum amount of bytes allowed to be sent in a payload in a POST request.
EmitterConfiguration	copy()
EmitterConfiguration	emitRange(int emitRange) Maximum number of events collected from the EventStore to be sent in a request.
EmitterConfiguration	eventStore(EventStore eventStore) Custom component with full ownership for persisting events before to be sent to the collector.
BufferOption	getBufferOption()
long	getByteLimitGet()
long	getByteLimitPost()
int	getEmitRange()
EventStore	getEventStore()
RequestCallback	getRequestCallback()
int	getThreadPoolSize()
EmitterConfiguration	requestCallback(RequestCallback requestCallback) Callback called for each request performed by the tracker to the collector.
void	setBufferOption(BufferOption bufferOption)
void	setByteLimitGet(long byteLimitGet)
void	setByteLimitPost(long byteLimitPost)
void	setEmitRange(int emitRange)
void	setRequestCallback(RequestCallback requestCallback)
void	setThreadPoolSize(int threadPoolSize)
EmitterConfiguration	threadPoolSize(int threadPoolSize) Maximum number of threads working in parallel in the tracker to send requests.

Methods inherited from class java.lang.Object

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

Field Detail

bufferOption

@NonNull
public BufferOption bufferOption

See Also:

bufferOption(BufferOption)

emitRange

public int emitRange

See Also:

emitRange(int)

threadPoolSize

public int threadPoolSize

See Also:

threadPoolSize(int)

byteLimitGet

public long byteLimitGet

See Also:

byteLimitGet(int)

byteLimitPost

public long byteLimitPost

See Also:

byteLimitPost(int)

requestCallback

@Nullable
public RequestCallback requestCallback

See Also:

requestCallback(RequestCallback)

eventStore

@Nullable
public EventStore eventStore

See Also:

eventStore(EventStore)

Constructor Detail

EmitterConfiguration

public EmitterConfiguration()

It sets a default EmitterConfiguration. Default values: bufferOption = BufferOption.Single; emitRange = 150; threadPoolSize = 15; byteLimitGet = 40000; byteLimitPost = 40000;

Method Detail

getEventStore

@Nullable
public EventStore getEventStore()

Specified by:

getEventStore in interface com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface

getBufferOption

@NonNull
public BufferOption getBufferOption()

Specified by:

getBufferOption in interface com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface

setBufferOption

public void setBufferOption(@NonNull
                            BufferOption bufferOption)

Specified by:

setBufferOption in interface com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface

getEmitRange

public int getEmitRange()

Specified by:

getEmitRange in interface com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface

setEmitRange

public void setEmitRange(int emitRange)

Specified by:

setEmitRange in interface com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface

getThreadPoolSize

public int getThreadPoolSize()

Specified by:

getThreadPoolSize in interface com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface

setThreadPoolSize

public void setThreadPoolSize(int threadPoolSize)

getByteLimitGet

public long getByteLimitGet()

Specified by:

getByteLimitGet in interface com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface

setByteLimitGet

public void setByteLimitGet(long byteLimitGet)

Specified by:

setByteLimitGet in interface com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface

getByteLimitPost

public long getByteLimitPost()

Specified by:

getByteLimitPost in interface com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface

setByteLimitPost

public void setByteLimitPost(long byteLimitPost)

Specified by:

setByteLimitPost in interface com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface

getRequestCallback

@Nullable
public RequestCallback getRequestCallback()

Specified by:

getRequestCallback in interface com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface

setRequestCallback

public void setRequestCallback(@Nullable
                               RequestCallback requestCallback)

Specified by:

setRequestCallback in interface com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface

bufferOption

@NonNull
public EmitterConfiguration bufferOption(@NonNull
                                                  BufferOption bufferOption)

Sets whether the buffer should send events instantly or after the buffer has reached it's limit. By default, this is set to BufferOption Default.

emitRange

@NonNull
public EmitterConfiguration emitRange(int emitRange)

Maximum number of events collected from the EventStore to be sent in a request.

threadPoolSize

@NonNull
public EmitterConfiguration threadPoolSize(int threadPoolSize)

Maximum number of threads working in parallel in the tracker to send requests.

byteLimitGet

@NonNull
public EmitterConfiguration byteLimitGet(int byteLimitGet)

Maximum amount of bytes allowed to be sent in a payload in a GET request.

byteLimitPost

@NonNull
public EmitterConfiguration byteLimitPost(int byteLimitPost)

Maximum amount of bytes allowed to be sent in a payload in a POST request.

eventStore

@NonNull
public EmitterConfiguration eventStore(@Nullable
                                                EventStore eventStore)

Custom component with full ownership for persisting events before to be sent to the collector. If it's not set the tracker will use a SQLite database as default EventStore.

requestCallback

@NonNull
public EmitterConfiguration requestCallback(@Nullable
                                                     RequestCallback requestCallback)

Callback called for each request performed by the tracker to the collector.

copy

@NonNull
public EmitterConfiguration copy()

Specified by:

copy in interface Configuration