Skip navigation links
A B C D E F G H I J L M O P R S T U V 

A

activity(BreinUser, String, String, String, boolean) - Method in class com.brein.api.BreinActivity
Sends an activity to the Breinify server.
activity(BreinUser, String, String, String, boolean) - Static method in class com.brein.api.Breinify
Sends an activity to the engine utilizing the API.
activity() - Static method in class com.brein.api.Breinify
Sends an activity to the engine utilizing the API.
activity(BreinUser, String, String, String, boolean) - Method in class com.brein.api.BreinifyExecutor
Sends an activity to the engine utilizing the API.
activity() - Method in class com.brein.api.BreinifyExecutor
Sends an activity to the engine utilizing the API.
ACTIVITY_TYPE_NOT_SET - Static variable in exception com.brein.api.BreinException
 
ADD_TO_CART - Static variable in class com.brein.domain.BreinActivityType
 
APPAREL - Static variable in class com.brein.domain.BreinCategoryType
 
applyConfiguration() - Method in class com.brein.api.BreinifyExecutor
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.

B

BREIN_BASE_VALIDATION_FAILED - Static variable in exception com.brein.api.BreinException
 
BreinActivity - Class in com.brein.api
Sends an activity to the engine utilizing the API.
BreinActivity() - Constructor for class com.brein.api.BreinActivity
 
BreinActivityType - Class in com.brein.domain
The type of the activity collected, i.e., one of search, login, logout, addToCart, removeFromCart, checkOut, selectProduct, or other.
BreinActivityType() - Constructor for class com.brein.domain.BreinActivityType
 
BreinBase - Class in com.brein.api
Base Class for activity and lookup operations.
BreinBase() - Constructor for class com.brein.api.BreinBase
 
BreinCategoryType - Class in com.brein.domain
The categoryType of the platform/service/products, i.e., one of apparel, home, education, family, food, health, job, services, or other.
BreinCategoryType() - Constructor for class com.brein.domain.BreinCategoryType
 
BreinConfig - Class in com.brein.domain
Contains Breinify Endpoint configuration
BreinConfig(String, String) - Constructor for class com.brein.domain.BreinConfig
 
BreinConfig(String, String, BreinEngineType) - Constructor for class com.brein.domain.BreinConfig
Configuration object
BreinConfig() - Constructor for class com.brein.domain.BreinConfig
Empty Ctor - necessary
BreinDimension - Class in com.brein.domain
Contains the Dimension to ask for
BreinDimension(String...) - Constructor for class com.brein.domain.BreinDimension
Ctor with array of requested dimensions
BreinEngine - Class in com.brein.engine
Creates the Rest Engine (currently only unirest) and provides the methods to invoke activity and lookup calls
BreinEngine(BreinEngineType) - Constructor for class com.brein.engine.BreinEngine
Creates the engine
BreinEngineType - Enum in com.brein.engine
Specifies the possible Engine Types
BreinException - Exception in com.brein.api
BreinException
BreinException(Throwable) - Constructor for exception com.brein.api.BreinException
 
BreinException(String) - Constructor for exception com.brein.api.BreinException
 
BreinException(String, Exception) - Constructor for exception com.brein.api.BreinException
 
Breinify - Class in com.brein.api
Static Implementation of Breinify activity & lookup calls
Breinify() - Constructor for class com.brein.api.Breinify
 
BreinifyExecutor - Class in com.brein.api
Static Implementation of Breinify activity & lookup calls
BreinifyExecutor() - Constructor for class com.brein.api.BreinifyExecutor
 
BreinInvalidConfigurationException - Exception in com.brein.api
Exception in case of wrong configuration
BreinInvalidConfigurationException(Throwable) - Constructor for exception com.brein.api.BreinInvalidConfigurationException
Exception methods...
BreinInvalidConfigurationException(String) - Constructor for exception com.brein.api.BreinInvalidConfigurationException
 
BreinInvalidConfigurationException(String, Exception) - Constructor for exception com.brein.api.BreinInvalidConfigurationException
 
BreinLookup - Class in com.brein.api
Provides the lookup functionality
BreinLookup() - Constructor for class com.brein.api.BreinLookup
 
BreinResult - Class in com.brein.domain
Contains the result of an Brein Request when invoking a lookup
BreinResult(String) - Constructor for class com.brein.domain.BreinResult
creates a brein result object
BreinUser - Class in com.brein.domain
A plain object specifying the user information the activity belongs to
BreinUser(String) - Constructor for class com.brein.domain.BreinUser
create a brein user with field email.
BreinUser() - Constructor for class com.brein.domain.BreinUser
create a brein user
BreinUtil - Class in com.brein.util
Utility class
BreinUtil() - Constructor for class com.brein.util.BreinUtil
 
build() - Method in class com.brein.domain.BreinConfig
builder method - based on th configuration an universal executer will be created.

C

CATEGORY_TYPE_NOT_SET - Static variable in exception com.brein.api.BreinException
 
checkBaseUrl(String) - Method in class com.brein.domain.BreinConfig
checks if the url is valid.
CHECKOUT - Static variable in class com.brein.domain.BreinActivityType
 
com.brein.api - package com.brein.api
 
com.brein.domain - package com.brein.domain
 
com.brein.engine - package com.brein.engine
 
com.brein.util - package com.brein.util
 
CONFIG_VALIDATION_FAILED - Static variable in exception com.brein.api.BreinException
 
configure(BreinConfig) - Method in class com.brein.engine.BreinEngine
configuration of engine
configure(BreinConfig) - Method in interface com.brein.engine.IRestEngine
configures the rest engine
configure(BreinConfig) - Method in class com.brein.engine.JerseyRestEngine
configuration of the rest client
configure(BreinConfig) - Method in class com.brein.engine.UniRestEngine
configures the rest engine
containsValue(Object) - Static method in class com.brein.util.BreinUtil
Verifies if the object contains a value Return false in case of: - null - empty strings
createSignature() - Method in class com.brein.api.BreinActivity
Generates the signature for the request
createSignature() - Method in class com.brein.api.BreinLookup
Creates the signature for lookup
createSignature() - Method in interface com.brein.api.ISecretStrategy
Creates the appropriate signature that is part of the request to the Breinify server.

D

DEFAULT_ACTIVITY_ENDPOINT - Static variable in class com.brein.domain.BreinConfig
default endpoint of activity
DEFAULT_BASE_URL - Static variable in class com.brein.domain.BreinConfig
default Breinify base url
DEFAULT_CONNECTION_TIMEOUT - Static variable in class com.brein.domain.BreinConfig
default connection timeout
DEFAULT_LOOKUP_ENDPOINT - Static variable in class com.brein.domain.BreinConfig
default endpoint of lookup
DEFAULT_SOCKET_TIMEOUT - Static variable in class com.brein.domain.BreinConfig
default socket timeout
DEFAULT_VALIDATE - Static variable in class com.brein.domain.BreinConfig
default validation
doLookup(BreinLookup) - Method in interface com.brein.engine.IRestEngine
performs a lookup and provides details
doLookup(BreinLookup) - Method in class com.brein.engine.JerseyRestEngine
performs a lookup and provides details
doLookup(BreinLookup) - Method in class com.brein.engine.UniRestEngine
performs a lookup and provides details
doRequest(BreinActivity) - Method in interface com.brein.engine.IRestEngine
invokes the post request
doRequest(BreinActivity) - Method in class com.brein.engine.JerseyRestEngine
invokes the post request
doRequest(BreinActivity) - Method in class com.brein.engine.UniRestEngine
Invokes the asynch post call

E

EDUCATION - Static variable in class com.brein.domain.BreinCategoryType
 
ENGINE_NOT_INITIALIZED - Static variable in exception com.brein.api.BreinException
 

F

FAMILY - Static variable in class com.brein.domain.BreinCategoryType
 
FOOD - Static variable in class com.brein.domain.BreinCategoryType
 

G

generateSecret(int) - Static method in class com.brein.util.BreinUtil
Creates a secret by given len
generateSignature(String, String) - Static method in class com.brein.util.BreinUtil
Generates the signature
get(String) - Method in class com.brein.domain.BreinResult
retrieves the object according to the requested key
getActivityEndpoint() - Method in class com.brein.domain.BreinConfig
retrieves the activity endpoint
getApiKey() - Method in class com.brein.domain.BreinConfig
retrieves the apikey
getBaseUrl() - Method in class com.brein.domain.BreinConfig
retrieves the base url
getBreinActivity() - Static method in class com.brein.api.Breinify
 
getBreinActivity() - Method in class com.brein.api.BreinifyExecutor
Retrieves the instance of the brein activity
getBreinActivityType() - Method in class com.brein.api.BreinActivity
returns activity type
getBreinCategoryType() - Method in class com.brein.api.BreinActivity
retrieves brein category.
getBreinDimension() - Method in class com.brein.api.BreinLookup
retrieves the Brein dimension object
getBreinEngine() - Method in class com.brein.api.BreinBase
returns the configured brein engine
getBreinEngine() - Method in class com.brein.domain.BreinConfig
returns the configured brein engine for the rest calls
getBreinLookup() - Static method in class com.brein.api.Breinify
 
getBreinLookup() - Method in class com.brein.api.BreinifyExecutor
Retrieves the instance of the brein lookup
getBreinUser() - Method in class com.brein.api.BreinBase
retrieves the breinuser
getConfig() - Method in class com.brein.api.BreinBase
retrieves the configuration
getConfig() - Static method in class com.brein.api.Breinify
gets the config
getConfig() - Method in class com.brein.api.BreinifyExecutor
gets the config
getConnectionTimeout() - Method in class com.brein.domain.BreinConfig
retrieves the configured timeout values
getDateOfBirth() - Method in class com.brein.domain.BreinUser
Returns the date of birth
getDefaultCategory() - Method in class com.brein.domain.BreinConfig
returns the default category (if set)
getDescription() - Method in class com.brein.api.BreinActivity
retrieves the description
getDeviceId() - Method in class com.brein.domain.BreinUser
retrieves the deviceid
getDimensionFields() - Method in class com.brein.domain.BreinDimension
retrieve dimension array
getEmail() - Method in class com.brein.domain.BreinUser
setter & getter of the properties
getEndPoint() - Method in class com.brein.api.BreinActivity
retrieves the configured activity endpoint (e.g.
getEndPoint() - Method in class com.brein.api.BreinBase
retrieves the endpoint.
getEndPoint() - Method in class com.brein.api.BreinLookup
retrieves the configured lookup endpoint (e.g.
getFirstName() - Method in class com.brein.domain.BreinUser
Retrieves the first name of the user
getFullyQualifiedUrl(BreinBase) - Method in interface com.brein.engine.IRestEngine
retrieves the fully qualified url (base + endpoint)
getImei() - Method in class com.brein.domain.BreinUser
Retrieves imei (International Mobile Equipment Identity)
getLastName() - Method in class com.brein.domain.BreinUser
Retrieves the last name of the user
getLookupEndpoint() - Method in class com.brein.domain.BreinConfig
retrieves the lookup endpoint
getReferrer() - Method in class com.brein.domain.BreinUser
retrieves the additional referrer value
getRequestBody(BreinBase) - Method in interface com.brein.engine.IRestEngine
retrieves the request body depending of the object
getRestEngine() - Method in class com.brein.engine.BreinEngine
returns the brein engine
getRestEngine(BreinEngineType) - Static method in interface com.brein.engine.IRestEngine
Creates the requested Rest Engine.
getRestEngineType() - Method in class com.brein.domain.BreinConfig
retrieves rest type client
getSecret() - Method in class com.brein.domain.BreinConfig
returns the configured secret
getSessionId() - Method in class com.brein.domain.BreinUser
returns the sessionId (if set)
getSocketTimeout() - Method in class com.brein.domain.BreinConfig
socket timeout values
getTagsMap() - Method in class com.brein.api.BreinActivity
retrieves the tagMap
getUnixTimestamp() - Method in class com.brein.api.BreinBase
retrieves the timestamp
getUrl() - Method in class com.brein.domain.BreinConfig
retrieves the url for the post requests
getUrl() - Method in class com.brein.domain.BreinUser
retrieves the additional url
getUserAgent() - Method in class com.brein.domain.BreinUser
retrieves the additional userAgent value
getVersion() - Method in class com.brein.api.Breinify
returns the version
getVersion() - Method in class com.brein.api.BreinifyExecutor
returns the version

H

has(String) - Method in class com.brein.domain.BreinResult
checks if key exists in map
HEADER_ACCESS - Static variable in interface com.brein.engine.IRestEngine
 
HEADER_APP_JSON - Static variable in interface com.brein.engine.IRestEngine
 
HEALTH - Static variable in class com.brein.domain.BreinCategoryType
 
HOME - Static variable in class com.brein.domain.BreinCategoryType
 

I

init() - Method in class com.brein.api.BreinActivity
initializes the values of this instance
init() - Method in class com.brein.api.BreinBase
Initializes all values
init() - Method in class com.brein.api.BreinLookup
initializes the values of this instance
initEngine() - Method in class com.brein.domain.BreinConfig
initializes the rest client
IRestEngine - Interface in com.brein.engine
Interface for all possible rest engines
ISecretStrategy - Interface in com.brein.api
Base class for the secret strategy
isSign() - Method in class com.brein.api.BreinBase
retrieves the sign flag
isUrlValid(String) - Method in class com.brein.domain.BreinConfig
Validates if the URL is correct.
isUrlValid(String) - Static method in interface com.brein.engine.IRestEngine
Validates if the URL is correct.

J

JerseyRestEngine - Class in com.brein.engine
could be the jersey rest engine implementation
JerseyRestEngine() - Constructor for class com.brein.engine.JerseyRestEngine
 
JOB - Static variable in class com.brein.domain.BreinCategoryType
 

L

LOG - Static variable in interface com.brein.engine.IRestEngine
Logger instance
LOGIN - Static variable in class com.brein.domain.BreinActivityType
 
LOGOUT - Static variable in class com.brein.domain.BreinActivityType
 
lookup(BreinUser, BreinDimension, boolean) - Static method in class com.brein.api.Breinify
Retrieves a lookup result from the engine.
lookup(BreinLookup, BreinUser, BreinDimension, boolean) - Static method in class com.brein.api.Breinify
 
lookup(BreinUser, BreinDimension, boolean) - Method in class com.brein.api.BreinifyExecutor
Retrieves a lookup result from the engine.
lookUp(BreinUser, BreinDimension, boolean) - Method in class com.brein.api.BreinLookup
Lookup implementation.
LOOKUP_EXCEPTION - Static variable in exception com.brein.api.BreinException
 

M

MSG_REQUEST_HAS_BEEN_CANCELLED - Static variable in class com.brein.engine.UniRestEngine
 
MSG_REQUEST_HAS_FAILED - Static variable in class com.brein.engine.UniRestEngine
 
MSG_REQUEST_WAS_SUCCESSFUL - Static variable in class com.brein.engine.UniRestEngine
 
MSG_URL_IS_NULL - Static variable in class com.brein.engine.UniRestEngine
some constants

O

OTHER - Static variable in class com.brein.domain.BreinActivityType
 
OTHER - Static variable in class com.brein.domain.BreinCategoryType
 

P

PAGEVISIT - Static variable in class com.brein.domain.BreinActivityType
 
performLookUp(BreinLookup) - Method in class com.brein.engine.BreinEngine
performs a lookup.
prepareJsonRequest() - Method in class com.brein.api.BreinActivity
creates the json request based on the necessary data
prepareJsonRequest() - Method in class com.brein.api.BreinBase
prepares the json request string
prepareJsonRequest() - Method in class com.brein.api.BreinLookup
prepares a JSON request for a lookup

R

randomString() - Static method in class com.brein.util.BreinUtil
Helper method to generate a random string
randomString(int) - Static method in class com.brein.util.BreinUtil
Helper methods generates a random string by len
REMOVE_FROM_CART - Static variable in class com.brein.domain.BreinActivityType
 
REQUEST_BODY_FAILED - Static variable in exception com.brein.api.BreinException
 
REQUEST_FAILED - Static variable in exception com.brein.api.BreinException
 
resetAllValues() - Method in class com.brein.api.BreinActivity
resets all values of this class and base class to initial values.
resetAllValues() - Method in class com.brein.api.BreinLookup
resets all values of this class and base class to initial values.
resetDateOfBirth() - Method in class com.brein.domain.BreinUser
resets the dateOfBirth to an empty value

S

SEARCH - Static variable in class com.brein.domain.BreinActivityType
 
SELECT_PRODUCT - Static variable in class com.brein.domain.BreinActivityType
 
sendActivity(BreinActivity) - Method in class com.brein.engine.BreinEngine
sends an activity to the breinify server
SERVICES - Static variable in class com.brein.domain.BreinCategoryType
 
setActivityEndpoint(String) - Method in class com.brein.domain.BreinConfig
sets the activity endpoint
setApiKey(String) - Method in class com.brein.domain.BreinConfig
sets the apikey
setBaseUrl(String) - Method in class com.brein.domain.BreinConfig
set the base url of the breinify backend and will check if the URL is valid.
setBreinActivityType(String) - Method in class com.brein.api.BreinActivity
Sets activity type
setBreinCategoryType(String) - Method in class com.brein.api.BreinActivity
sets brein category
setBreinDimension(BreinDimension) - Method in class com.brein.api.BreinLookup
sets the breindimension object - will be used for lookup
setBreinUser(BreinUser) - Method in class com.brein.api.BreinBase
sets the brein user ~
setConfig(BreinConfig) - Method in class com.brein.api.BreinBase
sets the brein config
setConfig(BreinConfig) - Static method in class com.brein.api.Breinify
sets the configuration
setConfig(BreinConfig) - Method in class com.brein.api.BreinifyExecutor
sets the configuration
setConnectionTimeout(long) - Method in class com.brein.domain.BreinConfig
set the connection timeout
setDateOfBirth(int, int, int) - Method in class com.brein.domain.BreinUser
Set's the date of birth There is no check if the month - day combination is valid, only the range for day, month and year will be checked
setDefaultCategory(String) - Method in class com.brein.domain.BreinConfig
sets the default category
setDescription(String) - Method in class com.brein.api.BreinActivity
sets the description
setDeviceId(String) - Method in class com.brein.domain.BreinUser
sets the device id
setDimensionFields(String...) - Method in class com.brein.domain.BreinDimension
sets dimension array
setEmail(String) - Method in class com.brein.domain.BreinUser
sets the email of the user
setFirstName(String) - Method in class com.brein.domain.BreinUser
set the first name of the user
setImei(String) - Method in class com.brein.domain.BreinUser
Sets the imei number
setLastName(String) - Method in class com.brein.domain.BreinUser
set the last name of the user
setLookupEndpoint(String) - Method in class com.brein.domain.BreinConfig
sets the lookup endpoint
setReferrer(String) - Method in class com.brein.domain.BreinUser
sets the additional referrer value
setRestEngineType(BreinEngineType) - Method in class com.brein.domain.BreinConfig
set rest type client
setSecret(String) - Method in class com.brein.domain.BreinConfig
set the secret
setSessionId(String) - Method in class com.brein.domain.BreinUser
sets the sessionId
setSign(boolean) - Method in class com.brein.api.BreinBase
sets the sign flag
setSocketTimeout(long) - Method in class com.brein.domain.BreinConfig
set the socket timeout
setTagsMap(Map<String, Object>) - Method in class com.brein.api.BreinActivity
sets the tagsMap
setUnixTimestamp(long) - Method in class com.brein.api.BreinBase
sets the timestamp
setUrl(String) - Method in class com.brein.domain.BreinUser
sets the additional url
setUserAgent(String) - Method in class com.brein.domain.BreinUser
sets the additional user agent value
shutdown() - Static method in class com.brein.api.Breinify
Shutdown Breinify services
shutdown() - Method in class com.brein.api.BreinifyExecutor
Shutdown Breinify services
shutdownEngine() - Method in class com.brein.domain.BreinConfig
invokes the termination of the rest engine.

T

terminate() - Method in interface com.brein.engine.IRestEngine
terminates the rest engine
terminate() - Method in class com.brein.engine.JerseyRestEngine
stops possible functionality (e.g.
terminate() - Method in class com.brein.engine.UniRestEngine
used to stop the UNIREST threads
toString() - Method in class com.brein.domain.BreinUser
provides a nicer output of the user details

U

UniRestEngine - Class in com.brein.engine
Unirest Implementation
UniRestEngine() - Constructor for class com.brein.engine.UniRestEngine
 
URL_IS_MALFORMED - Static variable in exception com.brein.api.BreinException
 
URL_IS_NULL - Static variable in exception com.brein.api.BreinException
 
USER_NOT_SET - Static variable in exception com.brein.api.BreinException
 

V

validate(BreinBase) - Method in interface com.brein.engine.IRestEngine
Invokes validation of BreinBase object, configuration and url.
VALIDATE_ACTIVITY_OR_CONFIG_FAILED - Static variable in exception com.brein.api.BreinException
 
validateBreinBase(BreinBase) - Method in interface com.brein.engine.IRestEngine
validates the activity object
validateConfig(BreinBase) - Method in interface com.brein.engine.IRestEngine
validates the configuration object
validateUrl(String) - Method in interface com.brein.engine.IRestEngine
checks if the url is valid -> if not an exception will be thrown
valueOf(String) - Static method in enum com.brein.engine.BreinEngineType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.brein.engine.BreinEngineType
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E F G H I J L M O P R S T U V 
Skip navigation links

Copyright © Breinify - All Rights Reserved.