com.brein.engine

Interface IRestEngine

All Known Implementing Classes:

JerseyRestEngine, UniRestEngine

public interface IRestEngine

Interface for all possible rest engines

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HEADER_ACCESS
static java.lang.String	HEADER_APP_JSON
static org.slf4j.Logger	LOG Logger instance

Method Summary

Modifier and Type	Method and Description
void	configure(BreinConfig breinConfig) configures the rest engine
BreinResult	doLookup(BreinLookup breinLookup) performs a lookup and provides details
BreinResult	doRecommendation(BreinRecommendation breinRecommendation) performs a recommendation request
void	doRequest(BreinActivity breinActivity, java.util.function.Function<java.lang.String,java.lang.Void> errorCallback) invokes the post request
BreinResult	doTemporalDataRequest(BreinTemporalData breinTemporalData) performs a temporalData request
default java.lang.String	getFullyQualifiedUrl(BreinBase breinBase) retrieves the fully qualified url (base + endpoint)
default java.lang.String	getRequestBody(BreinBase breinBase) retrieves the request body depending of the object
static IRestEngine	getRestEngine(BreinEngineType engine) Creates the requested Rest Engine.
static boolean	isUrlValid(java.lang.String url) Validates if the URL is correct.
void	terminate() terminates the rest engine
default void	validate(BreinBase breinBase) Invokes validation of BreinBase object, configuration and url.
default void	validateBreinBase(BreinBase breinBase) validates the activity object
default void	validateConfig(BreinBase breinBase) validates the configuration object
default void	validateUrl(java.lang.String fullyQualifiedUrl) checks if the url is valid.

Field Detail

LOG

static final org.slf4j.Logger LOG

Logger instance

HEADER_ACCESS

static final java.lang.String HEADER_ACCESS

See Also:

Constant Field Values

HEADER_APP_JSON

static final java.lang.String HEADER_APP_JSON

See Also:

Constant Field Values

Method Detail

configure

void configure(BreinConfig breinConfig)

configures the rest engine

Parameters:

breinConfig - configuration object

doRequest

void doRequest(BreinActivity breinActivity,
               java.util.function.Function<java.lang.String,java.lang.Void> errorCallback)
        throws BreinException

invokes the post request

Parameters:

breinActivity - data

errorCallback - will be invoked in case of an error

Throws:

BreinException

doLookup

BreinResult doLookup(BreinLookup breinLookup)
              throws BreinException

performs a lookup and provides details

Parameters:

breinLookup - contains request data

Returns:

response from Breinify

Throws:

BreinException

terminate

void terminate()

terminates the rest engine

isUrlValid

static boolean isUrlValid(java.lang.String url)

Validates if the URL is correct.

Parameters:

url - to check

Returns:

true if ok otherwise false

validateUrl

default void validateUrl(java.lang.String fullyQualifiedUrl)
                  throws BreinException

checks if the url is valid. If not an exception will be thrown

Parameters:

fullyQualifiedUrl - url with endpoint

Throws:

BreinException

getRestEngine

static IRestEngine getRestEngine(BreinEngineType engine)

Creates the requested Rest Engine.

Parameters:

engine - type of engine

Returns:

created Rest-Engine

validateBreinBase

default void validateBreinBase(BreinBase breinBase)

validates the activity object

Parameters:

breinBase - object to validate

validateConfig

default void validateConfig(BreinBase breinBase)

validates the configuration object

Parameters:

breinBase - activity or lookup object

getFullyQualifiedUrl

default java.lang.String getFullyQualifiedUrl(BreinBase breinBase)

retrieves the fully qualified url (base + endpoint)

Parameters:

breinBase - activity or lookup object

Returns:

full url

getRequestBody

default java.lang.String getRequestBody(BreinBase breinBase)

retrieves the request body depending of the object

Parameters:

breinBase - object to use

Returns:

request as json string

validate

default void validate(BreinBase breinBase)

Invokes validation of BreinBase object, configuration and url.

Parameters:

breinBase - activity or lookup object

doTemporalDataRequest

BreinResult doTemporalDataRequest(BreinTemporalData breinTemporalData)
                           throws BreinException

performs a temporalData request

Parameters:

breinTemporalData - contains the request data

Returns:

result from request

Throws:

BreinException - exception that will be thrown

doRecommendation

BreinResult doRecommendation(BreinRecommendation breinRecommendation)
                      throws BreinException

performs a recommendation request

Parameters:

breinRecommendation - contains the request data

Returns:

result from request

Throws:

BreinException - exception that will be thrown