com.brein.engine

Interface IRestEngine

All Known Implementing Classes:

DummyRestEngine, 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

Method Summary

Modifier and Type	Method and Description
static BreinEngineType	autoDetect()
void	configure(BreinConfig breinConfig) configures the rest engine
default java.lang.String	getFullyQualifiedUrl(BreinConfig breinConfig, BreinBase breinBase)
default java.lang.String	getRequestBody(BreinConfig breinConfig, BreinBase breinBase)
static IRestEngine	getRestEngine(BreinEngineType engine) Creates the requested Rest Engine.
static BreinEngineType	getRestEngineType(BreinEngineType engine)
void	invokeAsyncRequest(BreinConfig config, BreinBase data, java.util.function.Consumer<BreinResult> callback)
BreinResult	invokeRequest(BreinConfig breinConfig, BreinBase data)
default java.util.Map<java.lang.String,java.lang.Object>	parseJson(java.lang.String jsonResponse)
void	terminate() terminates the rest engine
default void	validate(BreinConfig breinConfig, BreinBase breinBase)
default void	validateBreinBase(BreinBase breinBase) validates the activity object
default void	validateConfig(BreinConfig breinConfig) 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

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

autoDetect

static BreinEngineType autoDetect()

getRestEngineType

static BreinEngineType getRestEngineType(BreinEngineType engine)

getRestEngine

static IRestEngine getRestEngine(BreinEngineType engine)

Creates the requested Rest Engine.

Parameters:

engine - type of engine

Returns:

created Rest-Engine

configure

void configure(BreinConfig breinConfig)

configures the rest engine

Parameters:

breinConfig - configuration object

terminate

void terminate()

terminates the rest engine

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

validateBreinBase

default void validateBreinBase(BreinBase breinBase)

validates the activity object

Parameters:

breinBase - object to validate

validateConfig

default void validateConfig(BreinConfig breinConfig)

validates the configuration object

Parameters:

breinConfig - activity or lookup object

getFullyQualifiedUrl

default java.lang.String getFullyQualifiedUrl(BreinConfig breinConfig,
                                              BreinBase breinBase)

getRequestBody

default java.lang.String getRequestBody(BreinConfig breinConfig,
                                        BreinBase breinBase)

validate

default void validate(BreinConfig breinConfig,
                      BreinBase breinBase)

parseJson

default java.util.Map<java.lang.String,java.lang.Object> parseJson(java.lang.String jsonResponse)

invokeAsyncRequest

void invokeAsyncRequest(BreinConfig config,
                        BreinBase data,
                        java.util.function.Consumer<BreinResult> callback)

invokeRequest

BreinResult invokeRequest(BreinConfig breinConfig,
                          BreinBase data)