ApiManagerConfig (apiman-manager-api-core 1.1.8.Final API)

java.lang.Object
- io.apiman.manager.api.core.config.ApiManagerConfig

```
@ApplicationScoped
public class ApiManagerConfig
extends Object
```
Configuration object for the API Manager.

Author:

eric.wittmann@redhat.com

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`APIMAN_MANAGER_CONFIG_LOGGER`
`static String`	`APIMAN_MANAGER_IDM_STORAGE_TYPE`
`static String`	`APIMAN_MANAGER_METRICS_ES_CLUSTER_NAME`
`static String`	`APIMAN_MANAGER_METRICS_ES_HOST`
`static String`	`APIMAN_MANAGER_METRICS_ES_PASSWORD`
`static String`	`APIMAN_MANAGER_METRICS_ES_PORT`
`static String`	`APIMAN_MANAGER_METRICS_ES_PROTOCOL`
`static String`	`APIMAN_MANAGER_METRICS_ES_USERNAME`
`static String`	`APIMAN_MANAGER_METRICS_TYPE`
`static String`	`APIMAN_MANAGER_SECURITY_CONTEXT_TYPE`
`static String`	`APIMAN_MANAGER_STORAGE_ES_CLUSTER_NAME`
`static String`	`APIMAN_MANAGER_STORAGE_ES_HOST`
`static String`	`APIMAN_MANAGER_STORAGE_ES_INITIALIZE`
`static String`	`APIMAN_MANAGER_STORAGE_ES_PASSWORD`
`static String`	`APIMAN_MANAGER_STORAGE_ES_PORT`
`static String`	`APIMAN_MANAGER_STORAGE_ES_PROTOCOL`
`static String`	`APIMAN_MANAGER_STORAGE_ES_USERNAME`
`static String`	`APIMAN_MANAGER_STORAGE_QUERY_TYPE`
`static String`	`APIMAN_MANAGER_STORAGE_TYPE`
`static String`	`APIMAN_PLUGIN_REPOSITORIES`
`static String`	`DEFAULT_ES_CLUSTER_NAME`

Constructor Summary

Constructors
Constructor and Description

ApiManagerConfig()
Constructor.

Constructors
Constructor and Description
`ApiManagerConfig()` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`org.apache.commons.configuration.Configuration`	`getConfig()`
`Map<String,String>`	`getIdmStorageProperties()`
`String`	`getIdmStorageType()`
`String`	`getLoggerName()` 'Simple', 'JSON' or FQDN with `IApimanLogger` implementation.
`String`	`getMetricsESClusterName()`
`String`	`getMetricsESHost()`
`String`	`getMetricsESPassword()`
`int`	`getMetricsESPort()`
`String`	`getMetricsESProtocol()`
`String`	`getMetricsESUsername()`
`Map<String,String>`	`getMetricsProperties()`
`String`	`getMetricsType()`
`Set<URL>`	`getPluginRepositories()`
`protected Map<String,String>`	`getPrefixedProperties(String prefix)` Gets a map of properties prefixed by the given string.
`String`	`getSecurityContextType()`
`String`	`getStorageESClusterName()`
`String`	`getStorageESHost()`
`String`	`getStorageESPassword()`
`int`	`getStorageESPort()`
`String`	`getStorageESProtocol()`
`String`	`getStorageESUsername()`
`Map<String,String>`	`getStorageProperties()`
`Map<String,String>`	`getStorageQueryProperties()`
`String`	`getStorageQueryType()`
`String`	`getStorageType()`
`boolean`	`isInitializeStorageES()`
`protected org.apache.commons.configuration.Configuration`	`loadProperties()` Loads the config properties.

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

- Field Detail
  - APIMAN_MANAGER_CONFIG_LOGGER
```
public static final String APIMAN_MANAGER_CONFIG_LOGGER
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_STORAGE_TYPE
```
public static final String APIMAN_MANAGER_STORAGE_TYPE
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_STORAGE_ES_PROTOCOL
```
public static final String APIMAN_MANAGER_STORAGE_ES_PROTOCOL
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_STORAGE_ES_HOST
```
public static final String APIMAN_MANAGER_STORAGE_ES_HOST
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_STORAGE_ES_PORT
```
public static final String APIMAN_MANAGER_STORAGE_ES_PORT
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_STORAGE_ES_CLUSTER_NAME
```
public static final String APIMAN_MANAGER_STORAGE_ES_CLUSTER_NAME
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_STORAGE_ES_USERNAME
```
public static final String APIMAN_MANAGER_STORAGE_ES_USERNAME
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_STORAGE_ES_PASSWORD
```
public static final String APIMAN_MANAGER_STORAGE_ES_PASSWORD
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_STORAGE_ES_INITIALIZE
```
public static final String APIMAN_MANAGER_STORAGE_ES_INITIALIZE
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_STORAGE_QUERY_TYPE
```
public static final String APIMAN_MANAGER_STORAGE_QUERY_TYPE
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_IDM_STORAGE_TYPE
```
public static final String APIMAN_MANAGER_IDM_STORAGE_TYPE
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_METRICS_TYPE
```
public static final String APIMAN_MANAGER_METRICS_TYPE
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_METRICS_ES_PROTOCOL
```
public static final String APIMAN_MANAGER_METRICS_ES_PROTOCOL
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_METRICS_ES_HOST
```
public static final String APIMAN_MANAGER_METRICS_ES_HOST
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_METRICS_ES_PORT
```
public static final String APIMAN_MANAGER_METRICS_ES_PORT
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_METRICS_ES_CLUSTER_NAME
```
public static final String APIMAN_MANAGER_METRICS_ES_CLUSTER_NAME
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_METRICS_ES_USERNAME
```
public static final String APIMAN_MANAGER_METRICS_ES_USERNAME
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_METRICS_ES_PASSWORD
```
public static final String APIMAN_MANAGER_METRICS_ES_PASSWORD
```
    See Also:
    Constant Field Values
  - APIMAN_MANAGER_SECURITY_CONTEXT_TYPE
```
public static final String APIMAN_MANAGER_SECURITY_CONTEXT_TYPE
```
    See Also:
    Constant Field Values
  - APIMAN_PLUGIN_REPOSITORIES
```
public static final String APIMAN_PLUGIN_REPOSITORIES
```
    See Also:
    Constant Field Values
  - DEFAULT_ES_CLUSTER_NAME
```
public static final String DEFAULT_ES_CLUSTER_NAME
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ApiManagerConfig
```
public ApiManagerConfig()
```
    Constructor.
- Method Detail
  - loadProperties
```
protected org.apache.commons.configuration.Configuration loadProperties()
```
    Loads the config properties.
  - getPluginRepositories
```
public Set<URL> getPluginRepositories()
```
    Returns:
    the configured plugin repositories
  - getSecurityContextType
```
public String getSecurityContextType()
```
  - getStorageType
```
public String getStorageType()
```
    Returns:
    the configured storage type
  - getStorageQueryType
```
public String getStorageQueryType()
```
    Returns:
    the configured storage query type
  - getIdmStorageType
```
public String getIdmStorageType()
```
    Returns:
    the configured storage query type
  - getStorageESProtocol
```
public String getStorageESProtocol()
```
    Returns:
    the elasticsearch protocol
  - getStorageESHost
```
public String getStorageESHost()
```
    Returns:
    the elasticsearch host
  - getStorageESPort
```
public int getStorageESPort()
```
    Returns:
    the elasticsearch port
  - getStorageESClusterName
```
public String getStorageESClusterName()
```
    Returns:
    the elasticsearch cluster name
  - getStorageESUsername
```
public String getStorageESUsername()
```
    Returns:
    the elasticsearch username
  - getStorageESPassword
```
public String getStorageESPassword()
```
    Returns:
    the elasticsearch username
  - isInitializeStorageES
```
public boolean isInitializeStorageES()
```
    Returns:
    true if the elasticsearch index should be initialized if not found
  - getMetricsType
```
public String getMetricsType()
```
    Returns:
    the configured storage type
  - getMetricsESProtocol
```
public String getMetricsESProtocol()
```
    Returns:
    the elasticsearch protocol
  - getMetricsESHost
```
public String getMetricsESHost()
```
    Returns:
    the elasticsearch host
  - getMetricsESPort
```
public int getMetricsESPort()
```
    Returns:
    the elasticsearch port
  - getMetricsESClusterName
```
public String getMetricsESClusterName()
```
    Returns:
    the elasticsearch cluster name
  - getMetricsESUsername
```
public String getMetricsESUsername()
```
    Returns:
    the elasticsearch username
  - getMetricsESPassword
```
public String getMetricsESPassword()
```
    Returns:
    the elasticsearch password
  - getStorageProperties
```
public Map<String,String> getStorageProperties()
```
    Returns:
    any custom properties associated with the storage (useful for custom impls)
  - getStorageQueryProperties
```
public Map<String,String> getStorageQueryProperties()
```
    Returns:
    any custom properties associated with the storage query impl
  - getIdmStorageProperties
```
public Map<String,String> getIdmStorageProperties()
```
    Returns:
    any custom properties associated with the IDM storage impl (useful for custom impls)
  - getMetricsProperties
```
public Map<String,String> getMetricsProperties()
```
    Returns:
    any custom properties associated with the metrics accessor impl
  - getPrefixedProperties
```
protected Map<String,String> getPrefixedProperties(String prefix)
```
    Gets a map of properties prefixed by the given string.
  - getConfig
```
public org.apache.commons.configuration.Configuration getConfig()
```
    Returns:
    the configuration
  - getLoggerName
```
public String getLoggerName()
```
    'Simple', 'JSON' or FQDN with IApimanLogger implementation.
    
    Returns:
    Logger name or FQDN

Class ApiManagerConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

APIMAN_MANAGER_CONFIG_LOGGER

APIMAN_MANAGER_STORAGE_TYPE

APIMAN_MANAGER_STORAGE_ES_PROTOCOL

APIMAN_MANAGER_STORAGE_ES_HOST

APIMAN_MANAGER_STORAGE_ES_PORT

APIMAN_MANAGER_STORAGE_ES_CLUSTER_NAME

APIMAN_MANAGER_STORAGE_ES_USERNAME

APIMAN_MANAGER_STORAGE_ES_PASSWORD

APIMAN_MANAGER_STORAGE_ES_INITIALIZE

APIMAN_MANAGER_STORAGE_QUERY_TYPE

APIMAN_MANAGER_IDM_STORAGE_TYPE

APIMAN_MANAGER_METRICS_TYPE

APIMAN_MANAGER_METRICS_ES_PROTOCOL

APIMAN_MANAGER_METRICS_ES_HOST

APIMAN_MANAGER_METRICS_ES_PORT

APIMAN_MANAGER_METRICS_ES_CLUSTER_NAME

APIMAN_MANAGER_METRICS_ES_USERNAME

APIMAN_MANAGER_METRICS_ES_PASSWORD

APIMAN_MANAGER_SECURITY_CONTEXT_TYPE

APIMAN_PLUGIN_REPOSITORIES

DEFAULT_ES_CLUSTER_NAME

Constructor Detail

ApiManagerConfig

Method Detail

loadProperties

getPluginRepositories

getSecurityContextType

getStorageType

getStorageQueryType

getIdmStorageType

getStorageESProtocol

getStorageESHost

getStorageESPort

getStorageESClusterName

getStorageESUsername

getStorageESPassword

isInitializeStorageES

getMetricsType

getMetricsESProtocol

getMetricsESHost

getMetricsESPort

getMetricsESClusterName

getMetricsESUsername

getMetricsESPassword

getStorageProperties

getStorageQueryProperties

getIdmStorageProperties

getMetricsProperties

getPrefixedProperties

getConfig

getLoggerName