com.brein.api

Class BreinRecommendations

java.lang.Object

com.brein.api.BreinBase<BreinRecommendations>

com.brein.api.BreinRecommendations

All Implemented Interfaces:

IExecutable<BreinRecommendationResults>, ISecretStrategy

public class BreinRecommendations
extends BreinBase<BreinRecommendations>
implements IExecutable<BreinRecommendationResults>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_RECS

Fields inherited from class com.brein.api.BreinBase

API_KEY_FIELD, GSON, IP_ADDRESS, SIGNATURE_FIELD, SIGNATURE_TYPE_FIELD, UNIX_TIMESTAMP_FIELD

Constructor Summary

Constructors

Constructor and Description
BreinRecommendations()

Method Summary

Modifier and Type	Method and Description
BreinRecommendations	addRecommendation(BreinRecommendation reqToAdd)
java.lang.String	createSignature(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) Generates the signature for the request
BreinRecommendationResults	execute() Method to execute the request synchronous.
java.lang.String	getEndPoint(BreinConfig config) Gets the endpoint to be used to send the request to
java.util.List<BreinRecommendation>	getRecommendationRequests()
void	prepareRequestData(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) This method adds the request specific information to the requestData.

Methods inherited from class com.brein.api.BreinBase

getClientIpAddress, getGson, getHeaders, getThis, getUnixTimestamp, getUser, prepareRequestData, set, setAdditional, setClientIpAddress, setHeader, setHeaders, setUnixTimestamp, setUser, setUser, setUser, toString

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_RECS

public static final java.lang.String ATTR_RECS

See Also:

Constant Field Values

Constructor Detail

BreinRecommendations

public BreinRecommendations()

Method Detail

getRecommendationRequests

public java.util.List<BreinRecommendation> getRecommendationRequests()

addRecommendation

public BreinRecommendations addRecommendation(BreinRecommendation reqToAdd)

execute

public BreinRecommendationResults execute()

Description copied from interface: IExecutable

Method to execute the request synchronous.

Specified by:

execute in interface IExecutable<BreinRecommendationResults>

Returns:

the returned value

getEndPoint

public java.lang.String getEndPoint(BreinConfig config)

Description copied from class: BreinBase

Gets the endpoint to be used to send the request to

Specified by:

getEndPoint in class BreinBase<BreinRecommendations>

Parameters:

config - the current configuration

Returns:

the endpoint to be used to send the request to

See Also:

BreinConfig

prepareRequestData

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

Description copied from class: BreinBase

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

Specified by:

prepareRequestData in class BreinBase<BreinRecommendations>

requestData - the request data to be sent to the endpoint

createSignature

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

Generates the signature for the request

Specified by:

createSignature in interface ISecretStrategy

Parameters:

config - the configuration

requestData - the data used for the request including all the data that will be sent, without the signature

Returns:

full signature