- 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
-
Provides the configuration of the library for the properties supplied.
- BreinConfig(String) - Constructor for class com.brein.domain.BreinConfig
-
- BreinConfig(String, String) - Constructor for class com.brein.domain.BreinConfig
-
- BreinConfig() - Constructor for class com.brein.domain.BreinConfig
-
Base Constructor - will be invoked in any case to initialize the
Rest Engine.
- 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
-
- Breinify() - Constructor for class com.brein.api.Breinify
-
- BreinifyExecutor - Class in com.brein.api
-
- 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
-
- 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
-
- BreinMapUtil - Class in com.brein.util
-
Helper class for map related functions
- BreinMapUtil() - Constructor for class com.brein.util.BreinMapUtil
-
- BreinRecommendation - Class in com.brein.api
-
- BreinRecommendation(BreinUser, int) - Constructor for class com.brein.api.BreinRecommendation
-
Ctor with full configuration
- 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
- BreinResult(String, int) - Constructor for class com.brein.domain.BreinResult
-
- BreinTemporalData - Class in com.brein.api
-
Provides the lookup functionality
- BreinTemporalData() - Constructor for class com.brein.api.BreinTemporalData
-
- 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
-
- 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.
- 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.
- CheckFunction - Interface in com.brein.api
-
Used to invoke actions within the map
- CHECKOUT - Static variable in class com.brein.domain.BreinActivityType
-
- clone(BreinActivity) - Static method in class com.brein.api.BreinActivity
-
Used to create a clone of an activity.
- clone(BreinRecommendation) - Static method in class com.brein.api.BreinRecommendation
-
Used to create a clone of a recommendation.
- clone(BreinTemporalData) - Static method in class com.brein.api.BreinTemporalData
-
Used to create a clone of a temporal data object.
- clone(BreinUser) - Static method in class com.brein.domain.BreinUser
-
Creates a clone of a given BreinUser object
- cloneBase(BreinBase) - Method in class com.brein.api.BreinBase
-
Clones from base class
- 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
- copyMap(Map<String, Object>) - Static method in class com.brein.util.BreinMapUtil
-
Map Helper method used to copy a hashmap of type String, Object
- createSignature() - Method in class com.brein.api.BreinActivity
-
Generates the signature for the request
- createSignature() - Method in class com.brein.api.BreinBase
-
used to create the signature depending of the request type
- createSignature() - Method in class com.brein.api.BreinLookup
-
Creates the signature for lookup
- createSignature() - Method in class com.brein.api.BreinRecommendation
-
Generates the signature for the request
- createSignature() - Method in class com.brein.api.BreinTemporalData
-
Creates the signature for temporaldata
- createSignature() - Method in interface com.brein.api.ISecretStrategy
-
Creates the appropriate signature that is part of the request to
the Breinify server.
- 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() - Method in class com.brein.api.BreinActivity
-
returns the activity map
- get(String) - Method in class com.brein.domain.BreinResult
-
retrieves the object according to the requested key
- get() - Method in class com.brein.domain.BreinUser
-
returns the user map
- getActivityEndpoint() - Method in class com.brein.domain.BreinConfig
-
retrieves the activity endpoint
- getAdditional() - Method in class com.brein.domain.BreinUser
-
returns the user additional map
- getApiKey() - Method in class com.brein.domain.BreinConfig
-
retrieves the apikey
- getBase() - Method in class com.brein.api.BreinBase
-
returns the map for the base section
- 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
- getBreinRecommendation() - Static method in class com.brein.api.Breinify
-
- getBreinTemporalData() - Static method in class com.brein.api.Breinify
-
- getBreinUser() - Method in class com.brein.api.BreinBase
-
retrieves the breinuser
- getCategory() - Method in class com.brein.api.BreinRecommendation
-
get the recommendation category
- 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 device-id
- getDimensionFields() - Method in class com.brein.domain.BreinDimension
-
retrieve dimension array
- getEmail() - Method in class com.brein.domain.BreinUser
-
get the email of the user
- 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.
- getEndPoint() - Method in class com.brein.api.BreinRecommendation
-
retrieves the configured activity endpoint (e.g.
- getEndPoint() - Method in class com.brein.api.BreinTemporalData
-
retrieves the configured temporaldata endpoint (e.g.
- getErrorCallback() - Method in class com.brein.api.BreinBase
-
Returns the callback function
- 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)
- getGson() - Method in class com.brein.api.BreinBase
-
return the gson builder instance
- getImei() - Method in class com.brein.domain.BreinUser
-
Retrieves imei (International Mobile Equipment Identity)
- getIpAddress() - Method in class com.brein.api.BreinBase
-
gets the ipAddress
- getIpAddress() - Method in class com.brein.domain.BreinUser
-
retrieves the ipAddress (additional part)
- getLastName() - Method in class com.brein.domain.BreinUser
-
Retrieves the last name of the user
- getLocalDateTime() - Method in class com.brein.domain.BreinUser
-
get's the localDateTime
- getLookupEndpoint() - Method in class com.brein.domain.BreinConfig
-
retrieves the lookup endpoint
- getMap() - Method in class com.brein.domain.BreinResult
-
provides the map containing the results
- getMessage() - Method in class com.brein.domain.BreinResult
-
- getNumberOfRecommendations() - Method in class com.brein.api.BreinRecommendation
-
get the number of recommendations
- getRecommendationEndpoint() - Method in class com.brein.domain.BreinConfig
-
returns the recommendation 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
- getStatus() - Method in class com.brein.domain.BreinResult
-
returns the http request status
- getTags() - Method in class com.brein.api.BreinActivity
-
retrieves the tagMap
- getTemporalDataEndpoint() - Method in class com.brein.domain.BreinConfig
-
retrieves the temporaldata endpoint
- getTimezone() - Method in class com.brein.domain.BreinUser
-
gets the timezone
- 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
- 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
-
- set(Map<String, Object>) - Method in class com.brein.api.BreinActivity
-
sets the activity map
- set(String, Map<String, Object>) - Method in class com.brein.api.BreinActivity
-
sets the activity map
- set(Map<String, Object>) - Method in class com.brein.domain.BreinUser
-
sets the user map
- set(String, Map<String, Object>) - Method in class com.brein.domain.BreinUser
-
sets the user additional fields
- setActivityEndpoint(String) - Method in class com.brein.domain.BreinConfig
-
sets the activity endpoint
- setAdditional(Map<String, Object>) - Method in class com.brein.domain.BreinUser
-
sets the user additional map
- setAdditional(String, Map<String, Object>) - Method in class com.brein.domain.BreinUser
-
sets the user additional fields
- setAndInitRestEngine(BreinEngineType) - Method in class com.brein.domain.BreinConfig
-
set rest type client
- setApiKey(String) - Method in class com.brein.domain.BreinConfig
-
sets the apikey
- setBase(Map<String, Object>) - Method in class com.brein.api.BreinBase
-
sets an map for the base section
- 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
- setCategory(String) - Method in class com.brein.api.BreinRecommendation
-
set the recommendation category
- 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
- setErrorCallback(Function<String, Void>) - Method in class com.brein.api.BreinBase
-
sets the error callback function
- 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
- setIpAddress(String) - Method in class com.brein.api.BreinBase
-
sets the ipaddress
- setIpAddress(String) - Method in class com.brein.domain.BreinUser
-
sets the ipAddress
- setLastName(String) - Method in class com.brein.domain.BreinUser
-
set the last name of the user
- setLocalDateTime(String) - Method in class com.brein.domain.BreinUser
-
set's the localDateTime
- setLookupEndpoint(String) - Method in class com.brein.domain.BreinConfig
-
sets the lookup endpoint
- setNumberOfRecommendations(int) - Method in class com.brein.api.BreinRecommendation
-
set the number of recommendations
- setRecommendationEndpoint(String) - Method in class com.brein.domain.BreinConfig
-
sets the recommendation endpoint
- setReferrer(String) - Method in class com.brein.domain.BreinUser
-
sets the additional referrer value
- setSecret(String) - Method in class com.brein.domain.BreinConfig
-
set the secret
- setSessionId(String) - Method in class com.brein.domain.BreinUser
-
sets the sessionId
- setSocketTimeout(long) - Method in class com.brein.domain.BreinConfig
-
set the socket timeout
- setStatus(int) - Method in class com.brein.domain.BreinResult
-
sets the http request status
- setTags(Map<String, Object>) - Method in class com.brein.api.BreinActivity
-
sets the tagsMap
- setTemporalDataEndpoint(String) - Method in class com.brein.domain.BreinConfig
-
sets the temporaldata endpoint
- setTimezone(String) - Method in class com.brein.domain.BreinUser
-
set the timezone
- 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.