com.snowplowanalytics.snowplow.tracker.emitter

Class AbstractEmitter

java.lang.Object

com.snowplowanalytics.snowplow.tracker.emitter.AbstractEmitter

All Implemented Interfaces:

Emitter

Direct Known Subclasses:

BatchEmitter, SimpleEmitter

public abstract class AbstractEmitter
extends java.lang.Object
implements Emitter

AbstractEmitter class which contains common elements to the emitters wrapped in a builder format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractEmitter.Builder<T extends AbstractEmitter.Builder<T>>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<TrackerPayload>	buffer
protected int	bufferSize
protected java.util.concurrent.ExecutorService	executor
protected HttpClientAdapter	httpClientAdapter
protected RequestCallback	requestCallback

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEmitter(AbstractEmitter.Builder<?> builder)

Method Summary

Modifier and Type	Method and Description
static AbstractEmitter.Builder<?>	builder()
abstract void	emit(TrackerPayload payload) Adds a payload to the buffer and checks whether we have reached the buffer limit yet.
protected void	execute(java.lang.Runnable runnable) Sends a runnable to the executor service.
abstract void	flushBuffer() When the buffer limit is reached sending of the buffer is initiated.
java.util.List<TrackerPayload>	getBuffer() Returns the List of Payloads that are in the buffer.
int	getBufferSize() Gets the Emitter Buffer Size - Will always be 1 for SimpleEmitter
protected boolean	isSuccessfulSend(int code) Checks whether the response code was a success or not.
void	setBufferSize(int bufferSize) Customize the emitter buffer size to any valid integer greater than zero.

Methods inherited from class java.lang.Object

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

Field Detail

httpClientAdapter

protected HttpClientAdapter httpClientAdapter

requestCallback

protected RequestCallback requestCallback

executor

protected java.util.concurrent.ExecutorService executor

buffer

protected java.util.List<TrackerPayload> buffer

bufferSize

protected int bufferSize

Constructor Detail

AbstractEmitter

protected AbstractEmitter(AbstractEmitter.Builder<?> builder)

Method Detail

builder

public static AbstractEmitter.Builder<?> builder()

emit

public abstract void emit(TrackerPayload payload)

Adds a payload to the buffer and checks whether we have reached the buffer limit yet.

Specified by:

emit in interface Emitter

Parameters:

payload - an event payload

setBufferSize

public void setBufferSize(int bufferSize)

Customize the emitter buffer size to any valid integer greater than zero. - Will only effect the BatchEmitter

Specified by:

setBufferSize in interface Emitter

Parameters:

bufferSize - number of events to collect before sending

flushBuffer

public abstract void flushBuffer()

When the buffer limit is reached sending of the buffer is initiated.

Specified by:

flushBuffer in interface Emitter

getBufferSize

public int getBufferSize()

Gets the Emitter Buffer Size - Will always be 1 for SimpleEmitter

Specified by:

getBufferSize in interface Emitter

Returns:

the buffer size

getBuffer

public java.util.List<TrackerPayload> getBuffer()

Returns the List of Payloads that are in the buffer.

Specified by:

getBuffer in interface Emitter

Returns:

the buffer payloads

execute

protected void execute(java.lang.Runnable runnable)

Sends a runnable to the executor service.

Parameters:

runnable - the runnable to be queued

isSuccessfulSend

protected boolean isSuccessfulSend(int code)

Checks whether the response code was a success or not.

Parameters:

code - the response code

Returns:

whether it is in the success range