BreinConfig (brein-api-library-java)

java.lang.Object
- com.brein.domain.BreinConfig

public class BreinConfig
extends java.lang.Object

Contains Breinify Endpoint configuration

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_ACTIVITY_ENDPOINT` default endpoint of activity
`static java.lang.String`	`DEFAULT_BASE_URL` default Breinify base url
`static long`	`DEFAULT_CONNECTION_TIMEOUT` default connection timeout
`static java.lang.String`	`DEFAULT_LOOKUP_ENDPOINT` default endpoint of lookup
`static long`	`DEFAULT_SOCKET_TIMEOUT` default socket timeout
`static boolean`	`DEFAULT_VALIDATE` default validation

Constructor Summary

Constructors
Constructor and Description
`BreinConfig()` Empty Ctor - necessary
`BreinConfig(java.lang.String apiKey, java.lang.String baseUrl)`
`BreinConfig(java.lang.String apiKey, java.lang.String baseUrl, BreinEngineType breinEngineType)` Configuration object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BreinifyExecutor`	`build()` builder method - based on th configuration an universal executer will be created.
`void`	`checkBaseUrl(java.lang.String baseUrl)` checks if the url is valid.
`java.lang.String`	`getActivityEndpoint()` retrieves the activity endpoint
`java.lang.String`	`getApiKey()` retrieves the apikey
`java.lang.String`	`getBaseUrl()` retrieves the base url
`BreinEngine`	`getBreinEngine()` returns the configured brein engine for the rest calls
`long`	`getConnectionTimeout()` retrieves the configured timeout values
`java.lang.String`	`getDefaultCategory()` returns the default category (if set)
`java.lang.String`	`getLookupEndpoint()` retrieves the lookup endpoint
`BreinEngineType`	`getRestEngineType()` retrieves rest type client
`java.lang.String`	`getSecret()` returns the configured secret
`long`	`getSocketTimeout()` socket timeout values
`java.lang.String`	`getUrl()` retrieves the url for the post requests
`void`	`initEngine()` initializes the rest client
`boolean`	`isUrlValid(java.lang.String url)` Validates if the URL is correct.
`BreinConfig`	`setActivityEndpoint(java.lang.String activityEndpoint)` sets the activity endpoint
`BreinConfig`	`setApiKey(java.lang.String apiKey)` sets the 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)` set the connection timeout
`BreinConfig`	`setDefaultCategory(java.lang.String defaultCategory)` sets the default category
`BreinConfig`	`setLookupEndpoint(java.lang.String lookupEndpoint)` sets the lookup endpoint
`BreinConfig`	`setRestEngineType(BreinEngineType restEngineType)` set rest type client
`BreinConfig`	`setSecret(java.lang.String secret)` set the secret
`BreinConfig`	`setSocketTimeout(long socketTimeout)` set the socket timeout
`void`	`shutdownEngine()` invokes the termination of the rest engine.

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 of activity
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LOOKUP_ENDPOINT
```
public static final java.lang.String DEFAULT_LOOKUP_ENDPOINT
```
    default endpoint of lookup
    
    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_VALIDATE
```
public static boolean DEFAULT_VALIDATE
```
    default validation
- Constructor Detail
  - BreinConfig
```
public BreinConfig(java.lang.String apiKey,
                   java.lang.String baseUrl)
```
    Parameters:
    
    apiKey - contains the Breinify api key
    
    baseUrl - contains the base url
  - BreinConfig
```
public BreinConfig(java.lang.String apiKey,
                   java.lang.String baseUrl,
                   BreinEngineType breinEngineType)
```
    Configuration object
    
    Parameters:
    
    apiKey - contains the Breinify api-key
    
    baseUrl - contains the base url
    
    breinEngineType - selected engine
  - BreinConfig
```
public BreinConfig()
```
    Empty Ctor - necessary
- Method Detail
  - initEngine
```
public void initEngine()
```
    initializes the rest client
  - build
```
public BreinifyExecutor build()
```
    builder method - based on th configuration an universal executer will be created.
    
    Returns:
    
    new created executer
  - 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()
```
    retrieves rest type client
    
    Returns:
    
    configured rest type client
  - setRestEngineType
```
public BreinConfig setRestEngineType(BreinEngineType restEngineType)
```
    set rest type client
    
    Parameters:
    
    restEngineType - of the rest impl
    
    Returns:
    
    the config object itself
  - getBreinEngine
```
public BreinEngine getBreinEngine()
```
    returns the configured brein engine for the rest calls
    
    Returns:
    
    brein engine
  - getApiKey
```
public java.lang.String getApiKey()
```
    retrieves the apikey
    
    Returns:
    
    apikey
  - setApiKey
```
public BreinConfig setApiKey(java.lang.String apiKey)
```
    sets the apikey
    
    Parameters:
    
    apiKey - the apikey
    
    Returns:
    
    the config object itself
  - getUrl
```
public java.lang.String getUrl()
```
    retrieves the url for the post requests
    
    Returns:
    
    base url
  - getConnectionTimeout
```
public long getConnectionTimeout()
```
    retrieves the configured timeout values
    
    Returns:
    
    connection time out
  - setConnectionTimeout
```
public BreinConfig setConnectionTimeout(long connectionTimeout)
```
    set the connection timeout
    
    Parameters:
    
    connectionTimeout - value
  - getSocketTimeout
```
public long getSocketTimeout()
```
    socket timeout values
    
    Returns:
    
    connection time out values
  - setSocketTimeout
```
public BreinConfig setSocketTimeout(long socketTimeout)
```
    set the socket timeout
    
    Parameters:
    
    socketTimeout - value
  - getActivityEndpoint
```
public java.lang.String getActivityEndpoint()
```
    retrieves the activity endpoint
    
    Returns:
    
    endpoint
  - setActivityEndpoint
```
public BreinConfig setActivityEndpoint(java.lang.String activityEndpoint)
```
    sets the activity endpoint
    
    Parameters:
    
    activityEndpoint - endpoint
    
    Returns:
    
    the config object itself
  - getLookupEndpoint
```
public java.lang.String getLookupEndpoint()
```
    retrieves the lookup endpoint
    
    Returns:
    
    lookup endpoint
  - setLookupEndpoint
```
public BreinConfig setLookupEndpoint(java.lang.String lookupEndpoint)
```
    sets the lookup endpoint
    
    Parameters:
    
    lookupEndpoint - endpoint
    
    Returns:
    
    the config object itself
  - getSecret
```
public java.lang.String getSecret()
```
    returns the configured secret
    
    Returns:
    
    raw secret
  - setSecret
```
public BreinConfig setSecret(java.lang.String secret)
```
    set the secret
    
    Parameters:
    
    secret - raw secret
  - getDefaultCategory
```
public java.lang.String getDefaultCategory()
```
    returns the default category (if set)
    
    Returns:
    
    default category
  - setDefaultCategory
```
public BreinConfig setDefaultCategory(java.lang.String defaultCategory)
```
    sets the default category
    
    Parameters:
    
    defaultCategory - default to set
  - shutdownEngine
```
public void shutdownEngine()
```
    invokes the termination of the rest engine. Depending of the configured engine additional threads might have been allocated and this will close those threads.
  - isUrlValid
```
public boolean isUrlValid(java.lang.String url)
```
    Validates if the URL is correct.
    
    Parameters:
    
    url - to check
    
    Returns:
    
    true if ok otherwise false

Class BreinConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ACTIVITY_ENDPOINT

DEFAULT_LOOKUP_ENDPOINT

DEFAULT_CONNECTION_TIMEOUT

DEFAULT_SOCKET_TIMEOUT

DEFAULT_BASE_URL

DEFAULT_VALIDATE

Constructor Detail

BreinConfig

BreinConfig

BreinConfig

Method Detail

initEngine

build

getBaseUrl

setBaseUrl

checkBaseUrl

getRestEngineType

setRestEngineType

getBreinEngine

getApiKey

setApiKey

getUrl

getConnectionTimeout

setConnectionTimeout

getSocketTimeout

setSocketTimeout

getActivityEndpoint

setActivityEndpoint

getLookupEndpoint

setLookupEndpoint

getSecret

setSecret

getDefaultCategory

setDefaultCategory

shutdownEngine

isUrlValid