com.brein.domain

Class BreinConfig

java.lang.Object

com.brein.domain.BreinConfig

public class BreinConfig
extends java.lang.Object

Provides the configuration of the library for the properties supplied.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ACTIVITY_ENDPOINT default endpoint for activity
static java.lang.String	DEFAULT_BASE_URL default Breinify base url
static long	DEFAULT_CONNECTION_TIMEOUT default connection timeout
static BreinEngineType	DEFAULT_ENGINE_TYPE default BreinEngineType
static java.lang.String	DEFAULT_LOOKUP_ENDPOINT default endpoint for lookup
static java.lang.String	DEFAULT_RECOMMENDATION_ENDPOINT default endpoint for recommendation
static int	DEFAULT_REST_CALL_THREADS default rest call threads
static long	DEFAULT_SOCKET_TIMEOUT default socket timeout
static java.lang.String	DEFAULT_TEMPORALDATA_ENDPOINT default endpoint for temporalData

Constructor Summary

Constructors

Constructor and Description
BreinConfig(java.lang.String apiKey)
BreinConfig(java.lang.String apiKey, java.lang.String secret)

Method Summary

Modifier and Type	Method and Description
void	checkBaseUrl(java.lang.String baseUrl) checks if the url is valid.
java.lang.String	getActivityEndpoint()
java.lang.String	getApiKey()
java.lang.String	getBaseUrl() retrieves the base url
long	getConnectionTimeout()
java.lang.String	getDefaultCategory()
java.util.Map<java.lang.String,java.lang.String>	getHeaders()
java.lang.String	getLookupEndpoint()
java.lang.String	getRecommendationEndpoint()
int	getRestCallThreads()
BreinEngineType	getRestEngineType()
java.lang.String	getSecret()
long	getSocketTimeout()
java.lang.String	getTemporalDataEndpoint()
java.lang.String	getUrl()
boolean	isSign()
BreinConfig	setActivityEndpoint(java.lang.String activityEndpoint)
BreinConfig	setApiKey(java.lang.String apiKey)
BreinConfig	setBaseUrl(java.lang.String baseUrl) set the base url of the breinify backend and will check if the URL is valid.
BreinConfig	setConnectionTimeout(long connectionTimeout)
BreinConfig	setDefaultCategory(java.lang.String defaultCategory)
BreinConfig	setHeader(java.lang.String key, java.lang.String value)
BreinConfig	setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
BreinConfig	setLookupEndpoint(java.lang.String lookupEndpoint)
BreinConfig	setRecommendationEndpoint(java.lang.String recommendationEndpoint)
void	setRestCallThreads(int restCallThreads)
BreinConfig	setRestEngineType(BreinEngineType restEngineType)
BreinConfig	setSecret(java.lang.String secret)
BreinConfig	setSocketTimeout(long socketTimeout)
void	setTemporalDataEndpoint(java.lang.String temporalDataEndpoint)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ACTIVITY_ENDPOINT

public static final java.lang.String DEFAULT_ACTIVITY_ENDPOINT

default endpoint for activity

See Also:

Constant Field Values

DEFAULT_LOOKUP_ENDPOINT

public static final java.lang.String DEFAULT_LOOKUP_ENDPOINT

default endpoint for lookup

See Also:

Constant Field Values

DEFAULT_TEMPORALDATA_ENDPOINT

public static final java.lang.String DEFAULT_TEMPORALDATA_ENDPOINT

default endpoint for temporalData

See Also:

Constant Field Values

DEFAULT_RECOMMENDATION_ENDPOINT

public static final java.lang.String DEFAULT_RECOMMENDATION_ENDPOINT

default endpoint for recommendation

See Also:

Constant Field Values

DEFAULT_CONNECTION_TIMEOUT

public static final long DEFAULT_CONNECTION_TIMEOUT

default connection timeout

See Also:

Constant Field Values

DEFAULT_SOCKET_TIMEOUT

public static final long DEFAULT_SOCKET_TIMEOUT

default socket timeout

See Also:

Constant Field Values

DEFAULT_BASE_URL

public static final java.lang.String DEFAULT_BASE_URL

default Breinify base url

See Also:

Constant Field Values

DEFAULT_ENGINE_TYPE

public static final BreinEngineType DEFAULT_ENGINE_TYPE

default BreinEngineType

DEFAULT_REST_CALL_THREADS

public static final int DEFAULT_REST_CALL_THREADS

default rest call threads

See Also:

Constant Field Values

Constructor Detail

BreinConfig

public BreinConfig(java.lang.String apiKey)

Parameters:

apiKey - contains the Breinify api key

BreinConfig

public BreinConfig(java.lang.String apiKey,
                   java.lang.String secret)

Parameters:

apiKey - contains the Breinify api key

secret - contains the secret

Method Detail

getBaseUrl

public java.lang.String getBaseUrl()

retrieves the base url

Returns:

base url

setBaseUrl

public BreinConfig setBaseUrl(java.lang.String baseUrl)

set the base url of the breinify backend and will check if the URL is valid.

Parameters:

baseUrl - contains the url

Returns:

the config object itself

checkBaseUrl

public void checkBaseUrl(java.lang.String baseUrl)
                  throws BreinInvalidConfigurationException

checks if the url is valid. If not a BreinInvalidConfigurationException will be thrown.

Parameters:

baseUrl - url to check

Throws:

BreinInvalidConfigurationException

getRestEngineType

public BreinEngineType getRestEngineType()

setRestEngineType

public BreinConfig setRestEngineType(BreinEngineType restEngineType)

getApiKey

public java.lang.String getApiKey()

setApiKey

public BreinConfig setApiKey(java.lang.String apiKey)

getUrl

public java.lang.String getUrl()

getConnectionTimeout

public long getConnectionTimeout()

setConnectionTimeout

public BreinConfig setConnectionTimeout(long connectionTimeout)

getSocketTimeout

public long getSocketTimeout()

setSocketTimeout

public BreinConfig setSocketTimeout(long socketTimeout)

getRestCallThreads

public int getRestCallThreads()

setRestCallThreads

public void setRestCallThreads(int restCallThreads)

getActivityEndpoint

public java.lang.String getActivityEndpoint()

setActivityEndpoint

public BreinConfig setActivityEndpoint(java.lang.String activityEndpoint)

getLookupEndpoint

public java.lang.String getLookupEndpoint()

setLookupEndpoint

public BreinConfig setLookupEndpoint(java.lang.String lookupEndpoint)

getTemporalDataEndpoint

public java.lang.String getTemporalDataEndpoint()

setTemporalDataEndpoint

public void setTemporalDataEndpoint(java.lang.String temporalDataEndpoint)

getRecommendationEndpoint

public java.lang.String getRecommendationEndpoint()

setRecommendationEndpoint

public BreinConfig setRecommendationEndpoint(java.lang.String recommendationEndpoint)

getSecret

public java.lang.String getSecret()

setSecret

public BreinConfig setSecret(java.lang.String secret)

getDefaultCategory

public java.lang.String getDefaultCategory()

setDefaultCategory

public BreinConfig setDefaultCategory(java.lang.String defaultCategory)

isSign

public boolean isSign()

setHeader

public BreinConfig setHeader(java.lang.String key,
                             java.lang.String value)

setHeaders

public BreinConfig setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()