Config (para-core 1.18.6 API)

java.lang.Object
- com.erudika.para.utils.Config

```
public final class Config
extends Object
```
This class loads configuration settings from a file and sets defaults.

Author:

Alex Bogdanovski [alex@erudika.com]

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`_APPID` "appid"
`static String`	`_CREATORID` "creatorid"
`static String`	`_EMAIL` "email"
`static String`	`_EMAIL_TOKEN` "etoken"
`static String`	`_GROUPS` "groups"
`static String`	`_ID` "id"
`static String`	`_IDENTIFIER` "identifier"
`static String`	`_KEY` "key"
`static String`	`_NAME` "name"
`static String`	`_PARENTID` "parentid"
`static String`	`_PASSWORD` "password"
`static String`	`_RESET_TOKEN` "token"
`static String`	`_TAGS` "tags"
`static String`	`_TIMESTAMP` "timestamp"
`static String`	`_TYPE` "type"
`static String`	`_UPDATED` "updated"
`static String`	`ADMIN_IDENT` The identifier of the first administrator (can be email, OpenID, or Facebook user id)
`static boolean`	`API_ENABLED` Enable the RESTful API.
`static String`	`APP_NAME` The name of the default application.
`static String`	`APP_NAME_NS` The name of the default application without any spaces.
`static String`	`APP_SECRET_KEY` The secret key for this deployment.
`static String`	`AUTH_COOKIE` The name of the authentication cookie.
`static String`	`AWS_ACCESSKEY` AWS Access Key
`static String`	`AWS_REGION` AWS Region
`static String`	`AWS_SECRETKEY` AWS ecret Key
`static String`	`CLUSTER_NAME` The name of the cluster (can be used to separate deployments)
`static String`	`CORE_PACKAGE_NAME` The package path (e.g.
`static boolean`	`CORS_ENABLED` Enable the CORS filter for API requests.
`static String`	`DEFAULT_ENCODING` Default character encoding - 'UTF-8'
`static int`	`DEFAULT_LIMIT` 10000
`static String`	`ENVIRONMENT` For example: production, development, testing...
`static int`	`EXECUTOR_THREADS` The number of threads to use for the ExecutorService thread pool.
`static String`	`FB_APP_ID` Facebook app id (for authentication)
`static String`	`FB_PREFIX` Facebook prefix - defaults to 'fb:'.
`static String`	`FB_SECRET` Facebook app secret (for authentication)
`static String`	`GITHUB_APP_ID` GitHub app id (for authentication)
`static String`	`GITHUB_PREFIX` GitHub prefix - defaults to 'gh;'.
`static String`	`GITHUB_SECRET` GitHub app secret (for authentication)
`static String`	`GMAPS_API_KEY` Google Maps API key
`static String`	`GPLUS_APP_ID` Google+ app id (for authentication)
`static String`	`GPLUS_PREFIX` Google prefix - defaults to 'gp;'.
`static String`	`GPLUS_SECRET` Google+ app secret (for authentication)
`static boolean`	`GZIP_ENABLED` Enable the GZIP filter for API requests.
`static boolean`	`IN_DEVELOPMENT` Development environment flag.
`static boolean`	`IN_PRODUCTION` Production environment flag.
`static Long`	`JWT_EXPIRES_AFTER_SEC` JWT (access token) expiration in seconds.
`static Long`	`JWT_REFRESH_INTERVAL_SEC` JWT refresh interval - tokens will be auto-refreshed at this interval of time.
`static String`	`LINKEDIN_APP_ID` LinkedIn app id (for authentication)
`static String`	`LINKEDIN_PREFIX` LinkedIn prefix - defaults to 'in:'.
`static String`	`LINKEDIN_SECRET` LinkedIn app secret (for authentication)
`static int`	`MAX_DATATYPES_PER_APP` Maximum number of data types that can be defined per app - default is 256.
`static int`	`MAX_ENTITY_SIZE_BYTES` Maximum size of incoming JSON objects - default is 1048576 (bytes).
`static int`	`MAX_IMG_SIZE_PX` Maximum image size (longest edge) - default is 1024 (pixels).
`static int`	`MAX_ITEMS_PER_PAGE` Maximum results per page - limits the number of items to show in search results.
`static int`	`MAX_PAGES` Pagination limit - default is 10 000.
`static int`	`MIN_PASS_LENGTH` Minimum password length - default is 6 symbols.
`static String`	`OPENX_API_KEY` OpenExchangeRates.org API key
`static String`	`PARA` "para"
`static Long`	`PASSRESET_TIMEOUT_SEC` Password reset window in seconds.
`static Long`	`REQUEST_EXPIRES_AFTER_SEC` Expiration of signed API request, in seconds.
`static String`	`RETURNTO_COOKIE` The name of the "return to" cookie.
`static String`	`SEPARATOR` String separator - default is colon ':'.
`static Long`	`SESSION_TIMEOUT_SEC` Session timeout in seconds.
`static String`	`SUPPORT_EMAIL` The email address for support.
`static String`	`TWITTER_APP_ID` Twitter app id (for authentication)
`static String`	`TWITTER_PREFIX` Twitter prefix - defaults to 'tw:'.
`static String`	`TWITTER_SECRET` Twitter app secret (for authentication)
`static Long`	`VOTE_EXPIRES_AFTER_SEC` Votes expire after X seconds.
`static Long`	`VOTE_LOCKED_AFTER_SEC` A vote can be changed within X seconds of casting.
`static String`	`WORKER_ID` The id of this deployment.

Constructor Summary

Constructors
Constructor and Description

Config()

Constructors
Constructor and Description
`Config()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static com.typesafe.config.Config`	`getConfig()` Returns the Config object.
`static boolean`	`getConfigBoolean(String key, boolean defaultValue)` Returns the boolean value of a configuration parameter.
`static double`	`getConfigDouble(String key, double defaultValue)` Returns the double value of a configuration parameter.
`static int`	`getConfigInt(String key, int defaultValue)` Returns the integer value of a configuration parameter.
`static Map<String,String>`	`getConfigMap()` Returns a map of configuration parameters and their values.
`static String`	`getConfigParam(String key, String defaultValue)` Returns the value of a configuration parameter or its default value.
`static void`	`init(com.typesafe.config.Config conf)` Initializes the configuration class by loading the configuration file.
`static boolean`	`isCacheEnabled()` Default: true only if `ENVIRONMENT` = "production"
`static boolean`	`isSearchEnabled()` Default: true

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PARA
```
public static final String PARA
```
    "para"
    
    See Also:
    
    Constant Field Values
  - _TYPE
```
public static final String _TYPE
```
    "type"
    
    See Also:
    
    Constant Field Values
  - _APPID
```
public static final String _APPID
```
    "appid"
    
    See Also:
    
    Constant Field Values
  - _CREATORID
```
public static final String _CREATORID
```
    "creatorid"
    
    See Also:
    
    Constant Field Values
  - _ID
```
public static final String _ID
```
    "id"
    
    See Also:
    
    Constant Field Values
  - _IDENTIFIER
```
public static final String _IDENTIFIER
```
    "identifier"
    
    See Also:
    
    Constant Field Values
  - _KEY
```
public static final String _KEY
```
    "key"
    
    See Also:
    
    Constant Field Values
  - _NAME
```
public static final String _NAME
```
    "name"
    
    See Also:
    
    Constant Field Values
  - _PARENTID
```
public static final String _PARENTID
```
    "parentid"
    
    See Also:
    
    Constant Field Values
  - _PASSWORD
```
public static final String _PASSWORD
```
    "password"
    
    See Also:
    
    Constant Field Values
  - _RESET_TOKEN
```
public static final String _RESET_TOKEN
```
    "token"
    
    See Also:
    
    Constant Field Values
  - _EMAIL_TOKEN
```
public static final String _EMAIL_TOKEN
```
    "etoken"
    
    See Also:
    
    Constant Field Values
  - _TIMESTAMP
```
public static final String _TIMESTAMP
```
    "timestamp"
    
    See Also:
    
    Constant Field Values
  - _UPDATED
```
public static final String _UPDATED
```
    "updated"
    
    See Also:
    
    Constant Field Values
  - _TAGS
```
public static final String _TAGS
```
    "tags"
    
    See Also:
    
    Constant Field Values
  - _EMAIL
```
public static final String _EMAIL
```
    "email"
    
    See Also:
    
    Constant Field Values
  - _GROUPS
```
public static final String _GROUPS
```
    "groups"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LIMIT
```
public static final int DEFAULT_LIMIT
```
    10000
    
    See Also:
    
    Constant Field Values
  - SEPARATOR
```
public static final String SEPARATOR
```
    String separator - default is colon ':'.
  - FB_PREFIX
```
public static final String FB_PREFIX
```
    Facebook prefix - defaults to 'fb:'.
  - GPLUS_PREFIX
```
public static final String GPLUS_PREFIX
```
    Google prefix - defaults to 'gp;'.
  - LINKEDIN_PREFIX
```
public static final String LINKEDIN_PREFIX
```
    LinkedIn prefix - defaults to 'in:'.
  - TWITTER_PREFIX
```
public static final String TWITTER_PREFIX
```
    Twitter prefix - defaults to 'tw:'.
  - GITHUB_PREFIX
```
public static final String GITHUB_PREFIX
```
    GitHub prefix - defaults to 'gh;'.
  - MAX_ITEMS_PER_PAGE
```
public static final int MAX_ITEMS_PER_PAGE
```
    Maximum results per page - limits the number of items to show in search results. Default is 30.
  - MAX_PAGES
```
public static final int MAX_PAGES
```
    Pagination limit - default is 10 000.
  - MAX_IMG_SIZE_PX
```
public static final int MAX_IMG_SIZE_PX
```
    Maximum image size (longest edge) - default is 1024 (pixels).
  - MIN_PASS_LENGTH
```
public static final int MIN_PASS_LENGTH
```
    Minimum password length - default is 6 symbols.
  - MAX_DATATYPES_PER_APP
```
public static final int MAX_DATATYPES_PER_APP
```
    Maximum number of data types that can be defined per app - default is 256.
  - MAX_ENTITY_SIZE_BYTES
```
public static final int MAX_ENTITY_SIZE_BYTES
```
    Maximum size of incoming JSON objects - default is 1048576 (bytes).
  - DEFAULT_ENCODING
```
public static final String DEFAULT_ENCODING
```
    Default character encoding - 'UTF-8'
  - ENVIRONMENT
```
public static final String ENVIRONMENT
```
    For example: production, development, testing... etc. Default: "embedded"
  - AWS_ACCESSKEY
```
public static final String AWS_ACCESSKEY
```
    AWS Access Key
  - AWS_SECRETKEY
```
public static final String AWS_SECRETKEY
```
    AWS ecret Key
  - AWS_REGION
```
public static final String AWS_REGION
```
    AWS Region
  - FB_APP_ID
```
public static final String FB_APP_ID
```
    Facebook app id (for authentication)
  - FB_SECRET
```
public static final String FB_SECRET
```
    Facebook app secret (for authentication)
  - GPLUS_APP_ID
```
public static final String GPLUS_APP_ID
```
    Google+ app id (for authentication)
  - GPLUS_SECRET
```
public static final String GPLUS_SECRET
```
    Google+ app secret (for authentication)
  - LINKEDIN_APP_ID
```
public static final String LINKEDIN_APP_ID
```
    LinkedIn app id (for authentication)
  - LINKEDIN_SECRET
```
public static final String LINKEDIN_SECRET
```
    LinkedIn app secret (for authentication)
  - TWITTER_APP_ID
```
public static final String TWITTER_APP_ID
```
    Twitter app id (for authentication)
  - TWITTER_SECRET
```
public static final String TWITTER_SECRET
```
    Twitter app secret (for authentication)
  - GITHUB_APP_ID
```
public static final String GITHUB_APP_ID
```
    GitHub app id (for authentication)
  - GITHUB_SECRET
```
public static final String GITHUB_SECRET
```
    GitHub app secret (for authentication)
  - OPENX_API_KEY
```
public static final String OPENX_API_KEY
```
    OpenExchangeRates.org API key
  - GMAPS_API_KEY
```
public static final String GMAPS_API_KEY
```
    Google Maps API key
  - ADMIN_IDENT
```
public static final String ADMIN_IDENT
```
    The identifier of the first administrator (can be email, OpenID, or Facebook user id)
  - WORKER_ID
```
public static final String WORKER_ID
```
    The id of this deployment. In a multi-node environment each node should have a unique id.
  - EXECUTOR_THREADS
```
public static final int EXECUTOR_THREADS
```
    The number of threads to use for the ExecutorService thread pool. Default is 2.
  - APP_NAME
```
public static final String APP_NAME
```
    The name of the default application.
  - APP_NAME_NS
```
public static final String APP_NAME_NS
```
    The name of the default application without any spaces.
  - AUTH_COOKIE
```
public static final String AUTH_COOKIE
```
    The name of the authentication cookie.
  - RETURNTO_COOKIE
```
public static final String RETURNTO_COOKIE
```
    The name of the "return to" cookie.
  - SUPPORT_EMAIL
```
public static final String SUPPORT_EMAIL
```
    The email address for support.
  - APP_SECRET_KEY
```
public static final String APP_SECRET_KEY
```
    The secret key for this deployment. Used as salt.
  - CORE_PACKAGE_NAME
```
public static final String CORE_PACKAGE_NAME
```
    The package path (e.g. org.company.app.core) where all domain objects are defined.
  - REQUEST_EXPIRES_AFTER_SEC
```
public static final Long REQUEST_EXPIRES_AFTER_SEC
```
    Expiration of signed API request, in seconds. Default: 15 minutes
  - JWT_EXPIRES_AFTER_SEC
```
public static final Long JWT_EXPIRES_AFTER_SEC
```
    JWT (access token) expiration in seconds. Default: 1 week
  - JWT_REFRESH_INTERVAL_SEC
```
public static final Long JWT_REFRESH_INTERVAL_SEC
```
    JWT refresh interval - tokens will be auto-refreshed at this interval of time. Default: 1 hour
  - SESSION_TIMEOUT_SEC
```
public static final Long SESSION_TIMEOUT_SEC
```
    Session timeout in seconds. Default: 24 hours
  - VOTE_EXPIRES_AFTER_SEC
```
public static final Long VOTE_EXPIRES_AFTER_SEC
```
    Votes expire after X seconds. Default: 30 days
  - VOTE_LOCKED_AFTER_SEC
```
public static final Long VOTE_LOCKED_AFTER_SEC
```
    A vote can be changed within X seconds of casting. Default: 30 seconds
  - PASSRESET_TIMEOUT_SEC
```
public static final Long PASSRESET_TIMEOUT_SEC
```
    Password reset window in seconds. Default: 30 minutes
  - API_ENABLED
```
public static final boolean API_ENABLED
```
    Enable the RESTful API. Default: true
  - CORS_ENABLED
```
public static final boolean CORS_ENABLED
```
    Enable the CORS filter for API requests. Default: true
  - GZIP_ENABLED
```
public static final boolean GZIP_ENABLED
```
    Enable the GZIP filter for API requests. Default: false
  - IN_PRODUCTION
```
public static final boolean IN_PRODUCTION
```
    Production environment flag.
  - IN_DEVELOPMENT
```
public static final boolean IN_DEVELOPMENT
```
    Development environment flag.
  - CLUSTER_NAME
```
public static final String CLUSTER_NAME
```
    The name of the cluster (can be used to separate deployments)
- Constructor Detail
  - Config
```
public Config()
```
- Method Detail
  - init
```
public static void init(com.typesafe.config.Config conf)
```
    Initializes the configuration class by loading the configuration file.
    
    Parameters:
    
    conf - overrides the default configuration
  - getConfigBoolean
```
public static boolean getConfigBoolean(String key,
                                       boolean defaultValue)
```
    Returns the boolean value of a configuration parameter.
    
    Parameters:
    
    key - the param key
    
    defaultValue - the default param value
    
    Returns:
    
    the value of a param
  - getConfigInt
```
public static int getConfigInt(String key,
                               int defaultValue)
```
    Returns the integer value of a configuration parameter.
    
    Parameters:
    
    key - the param key
    
    defaultValue - the default param value
    
    Returns:
    
    the value of a param
  - getConfigDouble
```
public static double getConfigDouble(String key,
                                     double defaultValue)
```
    Returns the double value of a configuration parameter.
    
    Parameters:
    
    key - the param key
    
    defaultValue - the default param value
    
    Returns:
    
    the value of a param
  - getConfigParam
```
public static String getConfigParam(String key,
                                    String defaultValue)
```
    Returns the value of a configuration parameter or its default value. System.getProperty(java.lang.String) has precedence.
    
    Parameters:
    
    key - the param key
    
    defaultValue - the default param value
    
    Returns:
    
    the value of a param
  - getConfigMap
```
public static Map<String,String> getConfigMap()
```
    Returns a map of configuration parameters and their values.
    
    Returns:
    
    the main configuration map
  - getConfig
```
public static com.typesafe.config.Config getConfig()
```
    Returns the Config object.
    
    Returns:
    
    the config object
  - isCacheEnabled
```
public static boolean isCacheEnabled()
```
    Default: true only if ENVIRONMENT = "production"
    
    Returns:
    
    true if caching is enabled
  - isSearchEnabled
```
public static boolean isSearchEnabled()
```
    Default: true
    
    Returns:
    
    true if indexing is enabled

Class Config

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PARA

_TYPE

_APPID

_CREATORID

_ID

_IDENTIFIER

_KEY

_NAME

_PARENTID

_PASSWORD

_RESET_TOKEN

_EMAIL_TOKEN

_TIMESTAMP

_UPDATED

_TAGS

_EMAIL

_GROUPS

DEFAULT_LIMIT

SEPARATOR

FB_PREFIX

GPLUS_PREFIX

LINKEDIN_PREFIX

TWITTER_PREFIX

GITHUB_PREFIX

MAX_ITEMS_PER_PAGE

MAX_PAGES

MAX_IMG_SIZE_PX

MIN_PASS_LENGTH

MAX_DATATYPES_PER_APP

MAX_ENTITY_SIZE_BYTES

DEFAULT_ENCODING

ENVIRONMENT

AWS_ACCESSKEY

AWS_SECRETKEY

AWS_REGION

FB_APP_ID

FB_SECRET

GPLUS_APP_ID

GPLUS_SECRET

LINKEDIN_APP_ID

LINKEDIN_SECRET

TWITTER_APP_ID

TWITTER_SECRET

GITHUB_APP_ID

GITHUB_SECRET

OPENX_API_KEY

GMAPS_API_KEY

ADMIN_IDENT

WORKER_ID

EXECUTOR_THREADS

APP_NAME

APP_NAME_NS

AUTH_COOKIE

RETURNTO_COOKIE

SUPPORT_EMAIL

APP_SECRET_KEY

CORE_PACKAGE_NAME

REQUEST_EXPIRES_AFTER_SEC

JWT_EXPIRES_AFTER_SEC

JWT_REFRESH_INTERVAL_SEC

SESSION_TIMEOUT_SEC

VOTE_EXPIRES_AFTER_SEC

VOTE_LOCKED_AFTER_SEC

PASSRESET_TIMEOUT_SEC

API_ENABLED

CORS_ENABLED

GZIP_ENABLED

IN_PRODUCTION

IN_DEVELOPMENT

CLUSTER_NAME

Constructor Detail

Config

Method Detail

init