com.brein.api

Class BreinLookup

java.lang.Object

com.brein.api.BreinBase<BreinLookup>

com.brein.api.BreinLookup

All Implemented Interfaces:

IExecutable<BreinResult>, ISecretStrategy

public class BreinLookup
extends BreinBase<BreinLookup>
implements IExecutable<BreinResult>

Provides the lookup functionality

Nested Class Summary

Nested classes/interfaces inherited from class com.brein.api.BreinBase

BreinBase.BaseField

Field Summary

Fields inherited from class com.brein.api.BreinBase

API_KEY_FIELD, GSON, SIGNATURE_FIELD, SIGNATURE_TYPE_FIELD, UNIX_TIMESTAMP_FIELD

Constructor Summary

Constructors

Constructor and Description
BreinLookup()

Method Summary

Modifier and Type	Method and Description
java.lang.String	createSignature(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) Creates the signature for lookup
BreinResult	execute() Method to execute the request synchronous.
BreinDimension	getBreinDimension() retrieves the Brein dimension object
java.lang.String	getEndPoint(BreinConfig config) Gets the endpoint to be used to send the request to
void	prepareRequestData(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) This method adds the request specific information to the requestData.
BreinLookup	setBreinDimension(BreinDimension breinDimension) sets the breindimension object - will be used for lookup

Methods inherited from class com.brein.api.BreinBase

getBaseField, getGson, getThis, getUnixTimestamp, getUser, prepareRequestData, set, setAdditional, setClientIpAddress, setUnixTimestamp, setUser, setUser, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BreinLookup

public BreinLookup()

Method Detail

getBreinDimension

public BreinDimension getBreinDimension()

retrieves the Brein dimension object

Returns:

object

setBreinDimension

public BreinLookup setBreinDimension(BreinDimension breinDimension)

sets the breindimension object - will be used for lookup

Parameters:

breinDimension - object to set

Returns:

self

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<BreinLookup>

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<BreinLookup>

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)

Creates the signature for lookup

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:

signature

execute

public BreinResult execute()

Description copied from interface: IExecutable

Method to execute the request synchronous.

Specified by:

execute in interface IExecutable<BreinResult>

Returns:

the returned value