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, BreinRecommendations, BreinTemporalData

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

Base Class for activity and lookup operations.

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	IP_ADDRESS
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
java.lang.String	getClientIpAddress()
abstract java.lang.String	getEndPoint(BreinConfig config) Gets the endpoint to be used to send the request to
com.google.gson.Gson	getGson() Gets the GSON builder instance used to build the requests body
java.util.Map<java.lang.String,java.lang.String>	getHeaders()
protected T	getThis()
long	getUnixTimestamp() Retrieves the currently set unixTimestamp.
BreinUser	getUser() Retrieves the current BreinUser for the request.
java.lang.String	prepareRequestData(BreinConfig config) Method to generate the body part of the request.
abstract void	prepareRequestData(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) This method adds the request specific information to the requestData.
T	set(java.lang.String key, java.lang.Object value) Sets a base value.
T	setAdditional(java.lang.String key, java.lang.Object value) Sets a specific data point for the additional part of the request, i.e.:
T	setClientIpAddress(java.lang.String ipAddress) sets the ipaddress
T	setHeader(java.lang.String key, java.lang.String value)
T	setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
T	setUnixTimestamp(long unixTimestamp) Sets the timestamp.
T	setUser(BreinUser.UserField key, java.lang.Object value) Sets a specific data point for the user data of the request, i.e.:
T	setUser(BreinUser user) Sets the BreinUser instance for the request.
T	setUser(java.lang.String key, java.lang.Object value) Sets a specific data point for the user data of the request, i.e.:
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

IP_ADDRESS

public static final java.lang.String IP_ADDRESS

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 current BreinUser for the request. This method never returns null, instead it creates an empty BreinUser instance if none is available so far.

Returns:

the current BreinUser for the request

setUser

public T setUser(BreinUser user)

Sets the BreinUser instance for the request. It is recommended to get the user (using getUser()) and manipulate the retrieved instance directly or to use the setUser(key, value) method to set user specific data.

Parameters:

user - the BreinUser to set

Returns:

this

See Also:

BreinUser

setUser

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

Sets a specific data point for the user data of the request, i.e.:

     {
         user: {
             'key': 'value'
         }
     }
 

Typically, that would be, e.g., email, sessionId, and/or userId

Parameters:

key - the value to be set (e.g., "email" or "sessionId")

value - the value to be set for the specified key

Returns:

this

setUser

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

Sets a specific data point for the user data of the request, i.e.:

     {
         user: {
             'key': 'value'
         }
     }
 

Typically, that would be, e.g., email, sessionId, and/or userId

Parameters:

key - the value to be set (e.g., UserField.EMAIL)

value - the value to be set for the specified key

Returns:

this

See Also:

BreinUser.UserField

setAdditional

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

Sets a specific data point for the additional part of the request, i.e.:

     {
         user: {
              additional: {
                  'key': 'value'
              }
         }
     }
 

Parameters:

key - the value to be set (e.g., "localDateTime", "userAgent", "referrer" or "timezone")

value - the value to be set for the specified key

Returns:

this

getEndPoint

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

Gets the endpoint to be used to send the request to

Parameters:

config - the current configuration

Returns:

the endpoint to be used to send the request to

See Also:

BreinConfig

getUnixTimestamp

public long getUnixTimestamp()

Retrieves the currently set unixTimestamp. If now should be used as timestamp, the method returns -1L.

Returns:

unix timestamp

setUnixTimestamp

public T setUnixTimestamp(long unixTimestamp)

Sets the timestamp.

Parameters:

unixTimestamp - unix timestamp to be used

Returns:

this

setClientIpAddress

public T setClientIpAddress(java.lang.String ipAddress)

sets the ipaddress

Parameters:

ipAddress - contains the ipAddress

Returns:

this

getClientIpAddress

public java.lang.String getClientIpAddress()

getGson

public com.google.gson.Gson getGson()

Gets the GSON builder instance used to build the requests body

Returns:

GSON instance

set

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

Sets a base value. The method cannot be used to set the user base-value, instead setUser has to be used.

     {
          'key': 'value'
     }
 

Returns:

this

setHeader

public T setHeader(java.lang.String key,
                   java.lang.String value)

setHeaders

public T setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()

prepareRequestData

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

This method adds the request specific information to the requestData. It is called by prepareRequestData(BreinConfig) after the request data of the base information is added.

Parameters:

requestData - the request data to be sent to the endpoint

prepareRequestData

public java.lang.String prepareRequestData(BreinConfig config)

Method to generate the body part of the request.

Parameters:

config - the configuration used to create the request body

Returns:

the created request body (JSON)

getThis

protected T getThis()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object