com.siftscience

Class FieldSet<T extends FieldSet<T>>

java.lang.Object

com.siftscience.FieldSet<T>

Direct Known Subclasses:

DecisionStatusFieldSet, EventsApiRequestFieldSet, LabelFieldSet, ScoreFieldSet, UnlabelFieldSet, WorkflowStatusFieldSet

public abstract class FieldSet<T extends FieldSet<T>>
extends java.lang.Object

FieldSet represents a set of fields/parameters to send along with an API request. It handles JSON serialization, field validation, and provides support for custom fields. One important thing to note about FieldSets is that although they know how to serialize into JSON, their fields will not always be used as such. For example, some requests don't have a JSON body at all so the "$api_key" field of the FieldSet will be used as a query parameter of the HTTP request instead.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABUSE_TYPE
static java.lang.String	API_KEY
static java.lang.String	EVENT_TYPE
protected static com.google.gson.Gson	gson
static java.lang.String	IP
static java.lang.String	IS_BAD
static java.lang.String	SESSION_ID
static java.lang.String	TIME
static java.lang.String	USER_ID

Constructor Summary

Constructors

Constructor and Description
FieldSet()

Method Summary

Modifier and Type	Method and Description
protected T	clearCustomField(java.lang.String key)
protected T	clearCustomFields()
java.lang.String	getApiKey()
java.lang.String	getEventType()
T	setApiKey(java.lang.String apiKey)
protected T	setCustomField(java.lang.String key, java.lang.Boolean val)
protected T	setCustomField(java.lang.String key, java.lang.Number val)
protected T	setCustomField(java.lang.String key, java.lang.String val)
protected boolean	shouldJsonSerializeApiKey()
java.lang.String	toJson()
void	validate()

Methods inherited from class java.lang.Object

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

Field Detail

API_KEY

public static final java.lang.String API_KEY

See Also:

Constant Field Values

USER_ID

public static final java.lang.String USER_ID

See Also:

Constant Field Values

SESSION_ID

public static final java.lang.String SESSION_ID

See Also:

Constant Field Values

EVENT_TYPE

public static final java.lang.String EVENT_TYPE

See Also:

Constant Field Values

IP

public static final java.lang.String IP

See Also:

Constant Field Values

TIME

public static final java.lang.String TIME

See Also:

Constant Field Values

IS_BAD

public static final java.lang.String IS_BAD

See Also:

Constant Field Values

ABUSE_TYPE

public static final java.lang.String ABUSE_TYPE

See Also:

Constant Field Values

gson

protected static com.google.gson.Gson gson

Constructor Detail

FieldSet

public FieldSet()

Method Detail

getEventType

public java.lang.String getEventType()

shouldJsonSerializeApiKey

protected boolean shouldJsonSerializeApiKey()

setCustomField

protected T setCustomField(java.lang.String key,
                           java.lang.Number val)

setCustomField

protected T setCustomField(java.lang.String key,
                           java.lang.Boolean val)

setCustomField

protected T setCustomField(java.lang.String key,
                           java.lang.String val)

clearCustomField

protected T clearCustomField(java.lang.String key)

clearCustomFields

protected T clearCustomFields()

validate

public void validate()

toJson

public java.lang.String toJson()

getApiKey

public java.lang.String getApiKey()

setApiKey

public T setApiKey(java.lang.String apiKey)