com.brein.api

Class BreinLookup

java.lang.Object

com.brein.api.BreinBase

com.brein.api.BreinLookup

All Implemented Interfaces:

ISecretStrategy

public class BreinLookup
extends BreinBase
implements ISecretStrategy

Provides the lookup functionality

Constructor Summary

Constructors

Constructor and Description
BreinLookup()

Method Summary

Modifier and Type	Method and Description
java.lang.String	createSignature() Creates the signature for lookup
BreinDimension	getBreinDimension() retrieves the Brein dimension object
java.lang.String	getEndPoint() retrieves the configured lookup endpoint (e.g.
void	init() initializes the values of this instance
BreinResult	lookUp(BreinUser breinUser, BreinDimension breinDimension) Lookup implementation.
java.lang.String	prepareJsonRequest() prepares a JSON request for a lookup
void	resetAllValues() resets all values of this class and base class to initial values.
BreinLookup	setBreinDimension(BreinDimension breinDimension) sets the breindimension object - will be used for lookup

Methods inherited from class com.brein.api.BreinBase

cloneBase, getBase, getBreinEngine, getBreinUser, getConfig, getErrorCallback, getGson, getIpAddress, getUnixTimestamp, isSign, prepareBaseRequestData, setBase, setBreinUser, setConfig, setErrorCallback, setIpAddress, setUnixTimestamp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

init

public void init()

initializes the values of this instance

Overrides:

init in class BreinBase

resetAllValues

public void resetAllValues()

resets all values of this class and base class to initial values. This will lead to empty strings or null objects

lookUp

public BreinResult lookUp(BreinUser breinUser,
                          BreinDimension breinDimension)

Lookup implementation. For a given user (BreinUser) a lookup will be performed with the requested dimensions (BreinDimension)

Parameters:

breinUser - contains the breinify user

breinDimension - contains the dimensions to look after

Returns:

response from request or null if no data can be retrieved

prepareJsonRequest

public java.lang.String prepareJsonRequest()

prepares a JSON request for a lookup

Overrides:

prepareJsonRequest in class BreinBase

Returns:

well formed json request

getEndPoint

public java.lang.String getEndPoint()

retrieves the configured lookup endpoint (e.g. \lookup)

Overrides:

getEndPoint in class BreinBase

Returns:

endpoint

createSignature

public java.lang.String createSignature()

Creates the signature for lookup

Specified by:

createSignature in interface ISecretStrategy

Overrides:

createSignature in class BreinBase

Returns:

signature