io.honeycomb

Class LibHoney

java.lang.Object

io.honeycomb.LibHoney

public final class LibHoney
extends Object

Stores default values for Builders and Transmission.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LibHoney.Builder LibHoney.Builder

Method Summary

Modifier and Type	Method and Description
void	add(Map<String,Object> fields) Copies all of the field mappings from the specified map to this LibHoney.
void	addDynField(String key, Callable function) Associates the specified function with the specified key in the dynamic fields map.
void	addDynFields(Map<String,Callable> dynFields) Copies all of the dynamic field mappings from the specified map to this LibHoney.
void	addField(String key, Object value) Associates the specified value with the specified key in the fields map.
void	close() Closes Transmission
String	getApiHost() Returns the API host for this LibHoney.
boolean	getBlockOnResponse() Returns true if this LibHoney should block on response.
boolean	getBlockOnSend() Returns true if this LibHoney should block on send.
int	getCloseTimeout() Returns number of seconds Transmission's close method will wait before timing out.
String	getDataSet() Returns the data set identifier for this LibHoney.
Map<String,Callable>	getDynFields() Returns dynamic fields for this LibHoney.
Map<String,Object>	getFields() Returns fields for this LibHoney.
int	getMaxConcurrentBranches() Returns the maximum number of concurrent branches for this LibHoney.
Queue	getRequestQueue() Returns the request queue for this LibHoney.
int	getRequestQueueLength() Returns the response queue length for this LibHoney.
Queue	getResponseQueue() Returns the response queue for this LibHoney
int	getResponseQueueLength() Returns the request queue length for this LibHoney.
int	getSampleRate() Returns the sample rate for this LibHoney.
protected Transmission	getTransmission() Returns the Transmission for this LibHoney.
String	getUserAgent()
String	getWriteKey() Returns the write key for this LibHoney.
Builder	newBuilder() Creates a Builder from this LibHoney's fields.
Event	newEvent() Creates a Event from this LibHoney's Builder.
void	send() Creates an Event, then sends with Transmission as a request, or as a dropped response if it should be dropped.
void	sendNow(Map<String,Object> fields) Immediately send a map of keys and values as a Event
void	setTransmission(Transmission transmission) Sets the reference to transmission
org.json.JSONObject	toJson() Returns a JSON representation of this LibHoney.
String	toString() Returns a string representation of this LibHoney.

Methods inherited from class java.lang.Object

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

Method Detail

add

public void add(Map<String,Object> fields)

Copies all of the field mappings from the specified map to this LibHoney.

Parameters:

fields - field mappings to be added to this LibHoney

addDynField

public void addDynField(String key,
                        Callable function)

Associates the specified function with the specified key in the dynamic fields map.

Parameters:

key - key with which the specified function is to be associated

function - function to be associated with the specified key

addDynFields

public void addDynFields(Map<String,Callable> dynFields)

Copies all of the dynamic field mappings from the specified map to this LibHoney.

Parameters:

dynFields - dynamic field mappings to be added this LibHoney

addField

public void addField(String key,
                     Object value)

Associates the specified value with the specified key in the fields map.

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

close

public void close()

Closes Transmission

getApiHost

public String getApiHost()

Returns the API host for this LibHoney.

Returns:

the API host for this LibHoney

getBlockOnResponse

public boolean getBlockOnResponse()

Returns true if this LibHoney should block on response.

Returns:

true if this LibHoney should block on response

getBlockOnSend

public boolean getBlockOnSend()

Returns true if this LibHoney should block on send.

Returns:

true if this LibHoney should block on send

getCloseTimeout

public int getCloseTimeout()

Returns number of seconds Transmission's close method will wait before timing out.

Returns:

number of seconds Transmission's close method will wait before timing out

getDataSet

public String getDataSet()

Returns the data set identifier for this LibHoney.

Returns:

the data set identifier for this LibHoney

getDynFields

public Map<String,Callable> getDynFields()

Returns dynamic fields for this LibHoney.

Returns:

dynamic fields for this LibHoney

getFields

public Map<String,Object> getFields()

Returns fields for this LibHoney.

Returns:

fields for this LibHoney

getMaxConcurrentBranches

public int getMaxConcurrentBranches()

Returns the maximum number of concurrent branches for this LibHoney.

Returns:

the maximum number of concurrent branches for this LibHoney

getRequestQueue

public Queue getRequestQueue()

Returns the request queue for this LibHoney.

Returns:

the request queue for this LibHoney

getRequestQueueLength

public int getRequestQueueLength()

Returns the response queue length for this LibHoney.

Returns:

the response queue length for this LibHoney

getResponseQueue

public Queue getResponseQueue()

Returns the response queue for this LibHoney

Returns:

the response queue for this LibHoney

getResponseQueueLength

public int getResponseQueueLength()

Returns the request queue length for this LibHoney.

Returns:

the request queue length for this LibHoney

getSampleRate

public int getSampleRate()

Returns the sample rate for this LibHoney.

Returns:

the sample rate for this LibHoney

getTransmission

protected Transmission getTransmission()

Returns the Transmission for this LibHoney.

Returns:

the Transmission for this LibHoney

getUserAgent

public String getUserAgent()

getWriteKey

public String getWriteKey()

Returns the write key for this LibHoney.

Returns:

the write key for this LibHoney.

newBuilder

public Builder newBuilder()

Creates a Builder from this LibHoney's fields.

Returns:

a Builder from this LibHoney's fields

newEvent

public Event newEvent()

Creates a Event from this LibHoney's Builder.

Returns:

a Event from this LibHoney's Builder

send

public void send()
          throws HoneyException

Creates an Event, then sends with Transmission as a request, or as a dropped response if it should be dropped.

Throws:

HoneyException - if there is something wrong with the request

sendNow

public void sendNow(Map<String,Object> fields)
             throws HoneyException

Immediately send a map of keys and values as a Event

Parameters:

fields - field key

Throws:

HoneyException - if there is something wrong with the request

setTransmission

public void setTransmission(Transmission transmission)

Sets the reference to transmission

Parameters:

transmission - reference to transmission

toJson

public org.json.JSONObject toJson()

Returns a JSON representation of this LibHoney.

Returns:

a JSON representation of this LibHoney

toString

public String toString()

Returns a string representation of this LibHoney.

Overrides:

toString in class Object

Returns:

a string representation of this LibHoney