Interface MidpointConfiguration
-
- All Known Implementing Classes:
StartupConfiguration
public interface MidpointConfiguration
-
-
Field Summary
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description org.apache.commons.configuration2.Configuration
getConfiguration()
org.apache.commons.configuration2.Configuration
getConfiguration(String component)
Get configuration for symbolic name of the component from configuration subsystem.String
getMidpointHome()
@NotNull ProfilingMode
getProfilingMode()
@NotNull SystemConfigurationSection
getSystemSection()
boolean
isProfilingEnabled()
boolean
isSafeMode()
boolean
keyMatches(String key, String... regexPatterns)
Returns true if the configuration key matches any of provided regular expression patterns.
-
-
-
Field Detail
-
MIDPOINT_SILENT_PROPERTY
static final String MIDPOINT_SILENT_PROPERTY
- See Also:
- Constant Field Values
-
MIDPOINT_HOME_PROPERTY
static final String MIDPOINT_HOME_PROPERTY
- See Also:
- Constant Field Values
-
MIDPOINT_SCHRODINGER_PROPERTY
static final String MIDPOINT_SCHRODINGER_PROPERTY
- See Also:
- Constant Field Values
-
MIDPOINT_LOGGING_ALT_ENABLED_PROPERTY
static final String MIDPOINT_LOGGING_ALT_ENABLED_PROPERTY
- See Also:
- Constant Field Values
-
MIDPOINT_LOGGING_ALT_FILENAME_PROPERTY
static final String MIDPOINT_LOGGING_ALT_FILENAME_PROPERTY
- See Also:
- Constant Field Values
-
MIDPOINT_LOGGING_ALT_PREFIX_PROPERTY
static final String MIDPOINT_LOGGING_ALT_PREFIX_PROPERTY
- See Also:
- Constant Field Values
-
USER_HOME_PROPERTY
static final String USER_HOME_PROPERTY
- See Also:
- Constant Field Values
-
MIDPOINT_CONFIG_FILE_PROPERTY
static final String MIDPOINT_CONFIG_FILE_PROPERTY
Property for config file name override; if empty, default value is used.- See Also:
- Constant Field Values
-
MIDPOINT_NODE_ID_PROPERTY
static final String MIDPOINT_NODE_ID_PROPERTY
- See Also:
- Constant Field Values
-
MIDPOINT_NODE_ID_SOURCE_PROPERTY
static final String MIDPOINT_NODE_ID_SOURCE_PROPERTY
- See Also:
- Constant Field Values
-
MIDPOINT_URL_PROPERTY
static final String MIDPOINT_URL_PROPERTY
- See Also:
- Constant Field Values
-
MIDPOINT_HOST_NAME_PROPERTY
static final String MIDPOINT_HOST_NAME_PROPERTY
- See Also:
- Constant Field Values
-
MIDPOINT_HTTP_PORT_PROPERTY
static final String MIDPOINT_HTTP_PORT_PROPERTY
- See Also:
- Constant Field Values
-
AUDIT_CONFIGURATION
static final String AUDIT_CONFIGURATION
- See Also:
- Constant Field Values
-
SYSTEM_CONFIGURATION
static final String SYSTEM_CONFIGURATION
- See Also:
- Constant Field Values
-
GLOBAL_CONFIGURATION
static final String GLOBAL_CONFIGURATION
- See Also:
- Constant Field Values
-
PROTECTOR_CONFIGURATION
static final String PROTECTOR_CONFIGURATION
- See Also:
- Constant Field Values
-
REPOSITORY_CONFIGURATION
static final String REPOSITORY_CONFIGURATION
- See Also:
- Constant Field Values
-
ROOT_MIDPOINT_CONFIGURATION
static final String ROOT_MIDPOINT_CONFIGURATION
- See Also:
- Constant Field Values
-
CONSTANTS_CONFIGURATION
static final String CONSTANTS_CONFIGURATION
- See Also:
- Constant Field Values
-
ICF_CONFIGURATION
static final String ICF_CONFIGURATION
- See Also:
- Constant Field Values
-
TASK_MANAGER_CONFIGURATION
static final String TASK_MANAGER_CONFIGURATION
- See Also:
- Constant Field Values
-
DOT_CONFIGURATION
static final String DOT_CONFIGURATION
- See Also:
- Constant Field Values
-
WEB_APP_CONFIGURATION
static final String WEB_APP_CONFIGURATION
- See Also:
- Constant Field Values
-
WORKFLOW_CONFIGURATION
static final String WORKFLOW_CONFIGURATION
- See Also:
- Constant Field Values
-
INTERNALS_CONFIGURATION
static final String INTERNALS_CONFIGURATION
- See Also:
- Constant Field Values
-
MIDPOINT_SYSTEM_PROPERTIES_BASE_PATH
static final String MIDPOINT_SYSTEM_PROPERTIES_BASE_PATH
Reference to midpoint-system.properties generated in system-init component. It is generated during the build. This file contains various system properties such midPoint version, build ID, build timestamp and so on. This is a base path (without extension).- See Also:
- Constant Field Values
-
-
Method Detail
-
getMidpointHome
String getMidpointHome()
- Returns:
- midPoint home directory. Currently, it is the same value as in "midpoint.home" system property.
-
getConfiguration
org.apache.commons.configuration2.Configuration getConfiguration(String component)
Get configuration for symbolic name of the component from configuration subsystem.- Parameters:
component
- name of the component Samples of names:- repository -> midpoint.repository
- provisioning -> midpoint.provisioning
- Returns:
- Configuration object
Sample how to get config value:
config.getInt("port", 1234);
-
getConfiguration
org.apache.commons.configuration2.Configuration getConfiguration()
- Returns:
- Global configuration.
-
isSafeMode
boolean isSafeMode()
- Returns:
- True if we are running in safe mode (the exact meaning gradually evolves; but the overall idea is to make midPoint barely usable to be able to fix the worst problems preventing it from running normally).
-
isProfilingEnabled
boolean isProfilingEnabled()
- Returns:
- True if the profiling interceptor should be loaded.
-
getProfilingMode
@NotNull @NotNull ProfilingMode getProfilingMode()
- Returns:
- Current profiling mode e.g. on, off, dynamic.
-
getSystemSection
@NotNull @NotNull SystemConfigurationSection getSystemSection()
- Returns:
- "midpoint.system" section of the system configuration
-
keyMatches
boolean keyMatches(String key, String... regexPatterns)
Returns true if the configuration key matches any of provided regular expression patterns. Provided pattern must match the whole value, seeString.matches(java.lang.String)
. Some examples:x\.y.*
- value starts withx.y
(dot must be escaped, in Java String syntax double backslash must be used!)(?i)sql
- value is exactly SQL, ignoring casing
- Parameters:
key
- key from configuration, starting atconfiguration
element (root), can be complex, e.g.midpoint.repository.type
.regexPatterns
- regular expression patterns that must match the whole value. It is possible to matchnull
too, if no regex pattern is used, or if the first pattern itself is null.
-
-