com.brein.api

Class BreinBase

java.lang.Object

com.brein.api.BreinBase

All Implemented Interfaces:

ISecretStrategy

Direct Known Subclasses:

BreinActivity, BreinLookup, BreinRecommendation, BreinTemporalData

public class BreinBase
extends java.lang.Object
implements ISecretStrategy

Base Class for activity and lookup operations.

Constructor Summary

Constructors

Constructor and Description
BreinBase()

Method Summary

Modifier and Type	Method and Description
void	cloneBase(BreinBase source) Clones from base class
java.lang.String	createSignature() used to create the signature depending of the request type
java.util.Map<java.lang.String,java.lang.Object>	getBase() returns the map for the base section
BreinEngine	getBreinEngine() returns the configured brein engine
BreinUser	getBreinUser() retrieves the breinuser
BreinConfig	getConfig() retrieves the configuration
java.lang.String	getEndPoint() retrieves the endpoint.
java.util.function.Function<java.lang.String,java.lang.Void>	getErrorCallback() Returns the callback function
com.google.gson.Gson	getGson() return the gson builder instance
java.lang.String	getIpAddress() gets the ipAddress
long	getUnixTimestamp() retrieves the timestamp
void	init() Initializes all values
boolean	isSign() retrieves the sign flag
void	prepareBaseRequestData(BreinBase breinBase, 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
java.lang.String	prepareJsonRequest() prepares the json request string
BreinBase	setBase(java.util.Map<java.lang.String,java.lang.Object> baseMap) sets an map for the base section
BreinBase	setBreinUser(BreinUser breinUser) sets the brein user
BreinBase	setConfig(BreinConfig breinConfig) sets the brein config
BreinBase	setErrorCallback(java.util.function.Function<java.lang.String,java.lang.Void> errorCallback) sets the error callback function
BreinBase	setIpAddress(java.lang.String ipAddress) sets the ipaddress
BreinBase	setUnixTimestamp(long unixTimestamp) sets the timestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

BreinBase

public BreinBase()

Method Detail

getBase

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

returns the map for the base section

Returns:

map

getConfig

public BreinConfig getConfig()

retrieves the configuration

Returns:

brein config

setConfig

public BreinBase setConfig(BreinConfig breinConfig)

sets the brein config

Parameters:

breinConfig - object

Returns:

self

getBreinUser

public BreinUser getBreinUser()

retrieves the breinuser

Returns:

breinuser

setBreinUser

public BreinBase setBreinUser(BreinUser breinUser)

sets the brein user

Parameters:

breinUser - user data

Returns:

self

getBreinEngine

public BreinEngine getBreinEngine()

returns the configured brein engine

Returns:

brein engine

getEndPoint

public java.lang.String getEndPoint()

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

Returns:

endpoint

getUnixTimestamp

public long getUnixTimestamp()

retrieves the timestamp

Returns:

value from 1.1.1970

setUnixTimestamp

public BreinBase setUnixTimestamp(long unixTimestamp)

sets the timestamp

Parameters:

unixTimestamp - value from 1.1.1970

Returns:

self

isSign

public boolean isSign()

retrieves the sign flag

Returns:

true or false depending on configured secret

getIpAddress

public java.lang.String getIpAddress()

gets the ipAddress

Returns:

content of ipAddress

setIpAddress

public BreinBase setIpAddress(java.lang.String ipAddress)

sets the ipaddress

Parameters:

ipAddress - contains the ipAddress

Returns:

object itself

getErrorCallback

public java.util.function.Function<java.lang.String,java.lang.Void> getErrorCallback()

Returns the callback function

Returns:

callback function

setErrorCallback

public BreinBase setErrorCallback(java.util.function.Function<java.lang.String,java.lang.Void> errorCallback)

sets the error callback function

Parameters:

errorCallback - function to callback

Returns:

self

getGson

public com.google.gson.Gson getGson()

return the gson builder instance

Returns:

gson instance

setBase

public BreinBase setBase(java.util.Map<java.lang.String,java.lang.Object> baseMap)

sets an map for the base section

Parameters:

baseMap - map of String, Object

Returns:

self

prepareBaseRequestData

public void prepareBaseRequestData(BreinBase breinBase,
                                   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:

breinBase - contains the appropriate request object

requestData - contains the created json structure

init

public void init()

Initializes all values

prepareJsonRequest

public java.lang.String prepareJsonRequest()

prepares the json request string

Returns:

empty

cloneBase

public void cloneBase(BreinBase source)

Clones from base class

Parameters:

source - to clone from

createSignature

public java.lang.String createSignature()

used to create the signature depending of the request type

Specified by:

createSignature in interface ISecretStrategy

Returns:

signature