com.brein.api

Class BreinifyExecutor

java.lang.Object

com.brein.api.BreinifyExecutor

public class BreinifyExecutor
extends java.lang.Object

Static Implementation of Breinify activity & lookup calls

Constructor Summary

Constructors

Constructor and Description
BreinifyExecutor()

Method Summary

Modifier and Type	Method and Description
void	activity() Sends an activity to the engine utilizing the API.
void	activity(BreinUser user, java.lang.String activityType, java.lang.String category, java.lang.String description, boolean sign) Sends an activity to the engine utilizing the API.
void	applyConfiguration() This is necessary because the configuration from class BreinifyExecutor needs to be transferred to class Breinify in order to invoke the activity and lookup calls within class Breinify.
BreinActivity	getBreinActivity() Retrieves the instance of the brein activity
BreinLookup	getBreinLookup() Retrieves the instance of the brein lookup
BreinConfig	getConfig() gets the config
java.lang.String	getVersion() returns the version
BreinResult	lookup(BreinUser user, BreinDimension dimension, boolean sign) Retrieves a lookup result from the engine.
void	setConfig(BreinConfig breinConfig) sets the configuration
void	shutdown() Shutdown Breinify services

Methods inherited from class java.lang.Object

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

Constructor Detail

BreinifyExecutor

public BreinifyExecutor()

Method Detail

getConfig

public BreinConfig getConfig()

gets the config

Returns:

config

setConfig

public void setConfig(BreinConfig breinConfig)

sets the configuration

Parameters:

breinConfig - config object

getVersion

public java.lang.String getVersion()

returns the version

Returns:

version

getBreinActivity

public BreinActivity getBreinActivity()

Retrieves the instance of the brein activity

Returns:

breinActivity object

getBreinLookup

public BreinLookup getBreinLookup()

Retrieves the instance of the brein lookup

Returns:

breinLookup object

activity

public void activity(BreinUser user,
                     java.lang.String activityType,
                     java.lang.String category,
                     java.lang.String description,
                     boolean sign)

Sends an activity to the engine utilizing the API. The call is done asynchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

This request is asynchronous.

Parameters:

user - a plain object specifying the user information the activity belongs to

activityType - the type of the activity collected, i.e., one of search, login, logout, addToCart, removeFromCart, checkOut, selectProduct, or other. if not specified, the default other will be used

category - the category of the platform/service/products, i.e., one of apparel, home, education, family, food, health, job, services, or other

description - a string with further information about the activity performed

sign - a boolean value specifying if the call should be signed

applyConfiguration

public void applyConfiguration()

This is necessary because the configuration from class BreinifyExecutor needs to be transferred to class Breinify in order to invoke the activity and lookup calls within class Breinify.

activity

public void activity()

Sends an activity to the engine utilizing the API. The call is done asynchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

This request is asynchronous.

lookup

public BreinResult lookup(BreinUser user,
                          BreinDimension dimension,
                          boolean sign)

Retrieves a lookup result from the engine. The function needs a valid API-key to be configured to succeed.

This request is synchronous.

Parameters:

user - a plain object specifying information about the user to retrieve data for.

dimension - an object (with an array) containing the names of the dimensions to lookup.

sign - a boolean value specifying if the call should be signed.

Returns:

response from request wrapped in an object called BreinResponse

shutdown

public void shutdown()

Shutdown Breinify services