com.brein.api

Class BreinBase<T extends BreinBase>

java.lang.Object

com.brein.api.BreinBase<T>

All Implemented Interfaces:

ISecretStrategy

Direct Known Subclasses:

BreinActivity, BreinLookup, BreinRecommendation, BreinTemporalData

public abstract class BreinBase<T extends BreinBase>
extends java.lang.Object
implements ISecretStrategy

Base Class for activity and lookup operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BreinBase.BaseField This list may not be complete it just contains some values.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	API_KEY_FIELD
static com.google.gson.Gson	GSON Builder for json creation
static java.lang.String	SIGNATURE_FIELD
static java.lang.String	SIGNATURE_TYPE_FIELD
static java.lang.String	UNIX_TIMESTAMP_FIELD

Constructor Summary

Constructors

Constructor and Description
BreinBase()

Method Summary

Modifier and Type	Method and Description
protected <F> F	getBaseField(BreinBase.BaseField field)
abstract java.lang.String	getEndPoint(BreinConfig config) retrieves the endpoint.
com.google.gson.Gson	getGson() return the GSON builder instance
java.lang.String	getIpAddress() gets the ipAddress
protected T	getThis()
long	getUnixTimestamp() retrieves the timestamp
BreinUser	getUser() retrieves the breinuser
java.lang.String	prepareRequestData(BreinConfig config)
abstract void	prepareRequestData(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) prepares the request for the base section with standard fields plus possible fields if configured
T	set(java.lang.String key, java.lang.Object value) Sets a value
T	setAdditional(java.lang.String key, java.lang.Object value)
T	setClientIpAddress(java.lang.String ipAddress) sets the ipaddress
T	setUnixTimestamp(long unixTimestamp) sets the timestamp
T	setUser(BreinUser user) sets the brein user
T	setUser(java.lang.String key, java.lang.Object value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.brein.api.ISecretStrategy

createSignature

Field Detail

API_KEY_FIELD

public static final java.lang.String API_KEY_FIELD

See Also:

Constant Field Values

UNIX_TIMESTAMP_FIELD

public static final java.lang.String UNIX_TIMESTAMP_FIELD

See Also:

Constant Field Values

SIGNATURE_FIELD

public static final java.lang.String SIGNATURE_FIELD

See Also:

Constant Field Values

SIGNATURE_TYPE_FIELD

public static final java.lang.String SIGNATURE_TYPE_FIELD

See Also:

Constant Field Values

GSON

public static final com.google.gson.Gson GSON

Builder for json creation

Constructor Detail

BreinBase

public BreinBase()

Method Detail

getUser

public BreinUser getUser()

retrieves the breinuser

Returns:

breinuser

setUser

public T setUser(BreinUser user)

sets the brein user

Parameters:

user - user data

Returns:

self

setUser

public T setUser(java.lang.String key,
                 java.lang.Object value)

setAdditional

public T setAdditional(java.lang.String key,
                       java.lang.Object value)

getEndPoint

public abstract java.lang.String getEndPoint(BreinConfig config)

retrieves the endpoint. this depends of the kind of BreinBase type.

Parameters:

config - the current configuration

Returns:

endpoint

getUnixTimestamp

public long getUnixTimestamp()

retrieves the timestamp

Returns:

value from 1.1.1970

setUnixTimestamp

public T setUnixTimestamp(long unixTimestamp)

sets the timestamp

Parameters:

unixTimestamp - value from 1.1.1970

Returns:

self

getIpAddress

public java.lang.String getIpAddress()

gets the ipAddress

Returns:

content of ipAddress

setClientIpAddress

public T setClientIpAddress(java.lang.String ipAddress)

sets the ipaddress

Parameters:

ipAddress - contains the ipAddress

Returns:

object itself

getGson

public com.google.gson.Gson getGson()

return the GSON builder instance

Returns:

GSON instance

set

public T set(java.lang.String key,
             java.lang.Object value)

Sets a value

Returns:

self

prepareRequestData

public abstract void prepareRequestData(BreinConfig config,
                                        java.util.Map<java.lang.String,java.lang.Object> requestData)

prepares the request for the base section with standard fields plus possible fields if configured

Parameters:

requestData - contains the created json structure

prepareRequestData

public java.lang.String prepareRequestData(BreinConfig config)

getThis

protected T getThis()

getBaseField

protected <F> F getBaseField(BreinBase.BaseField field)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object