ConfigurationGenerator (Nuxeo ECM Projects 10.10 API)

java.lang.Object
- org.nuxeo.launcher.config.ConfigurationGenerator

```
public class ConfigurationGenerator
extends Object
```
Builder for server configuration and datasource files from templates and properties.

Author:

jcarsique

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADDRESS_PING_TIMEOUT`
`static String`	`BOUNDARY_BEGIN`
`static String`	`BOUNDARY_END`
`static String[]`	`COMPLIANT_JAVA_VERSIONS` Accurate but not used internally.
`protected static String`	`CONFIGURATION_PROPERTIES`
`static List<String>`	`DB_EXCLUDE_CHECK_LIST`
`static List<String>`	`DB_LIST`
`static List<String>`	`DB_SECONDARY_LIST`
`static String`	`DISTRIBUTION_MP_DIR`
`static String`	`INSTALL_AFTER_RESTART`
`boolean`	`isJetty`
`boolean`	`isTomcat`
`protected static Pattern`	`JAVA_OPTS_PATTERN` Java options split by spaces followed by an even number of quotes (or zero).
`static String`	`JAVA_OPTS_PROP` Java options configured in `bin/nuxeo.conf` and `bin/nuxeoctl`.
`static String`	`JVMCHECK_FAIL`
`static String`	`JVMCHECK_NOFAIL`
`static String`	`JVMCHECK_PROP`
`static int`	`MAX_PORT`
`static int`	`MIN_PORT`
`static String`	`NUXEO_CONF`
`static String`	`NUXEO_DEFAULT_CONF`
`static String`	`NUXEO_DEV_SYSTEM_PROP` Global dev property, duplicated from runtime framework
`static String`	`OLD_PARAM_TEMPLATES_PARSING_EXTENSIONS`
`static String`	`PARAM_BIND_ADDRESS`
`static String`	`PARAM_CONTEXT_PATH`
`static String`	`PARAM_DB_DRIVER`
`static String`	`PARAM_DB_HOST`
`static String`	`PARAM_DB_JDBC_URL`
`static String`	`PARAM_DB_NAME`
`static String`	`PARAM_DB_PORT`
`static String`	`PARAM_DB_PWD`
`static String`	`PARAM_DB_USER`
`static String`	`PARAM_FAKE_WINDOWS`
`static String`	`PARAM_FORCE_GENERATION`
`static String`	`PARAM_HTTP_PORT`
`protected static String`	`PARAM_INCLUDED_TEMPLATES` Absolute or relative PATH to the included templates (comma separated list)
`static String`	`PARAM_LOOPBACK_URL`
`static String`	`PARAM_MONGODB_NAME`
`static String`	`PARAM_MONGODB_SERVER`
`static String`	`PARAM_MP_DIR`
`static String`	`PARAM_NUXEO_URL`
`static String`	`PARAM_PRODUCT_NAME` Deprecated. Since 7.10. Use `Environment.PRODUCT_NAME`
`static String`	`PARAM_PRODUCT_VERSION` Deprecated. Since 7.10. Use `Environment.PRODUCT_VERSION`
`static String`	`PARAM_STATUS_KEY` Deprecated. Since 7.4. Use `Environment.SERVER_STATUS_KEY` instead
`static String`	`PARAM_TEMPLATE_DBNAME`
`static String`	`PARAM_TEMPLATE_DBSECONDARY_NAME`
`static String`	`PARAM_TEMPLATE_DBSECONDARY_TYPE`
`static String`	`PARAM_TEMPLATE_DBTYPE`
`static String`	`PARAM_TEMPLATES_FREEMARKER_EXTENSIONS`
`static String`	`PARAM_TEMPLATES_NAME` Absolute or relative PATH to the user chosen templates (comma separated list)
`static String`	`PARAM_TEMPLATES_PARSING_EXTENSIONS`
`static String`	`PARAM_WIZARD_DONE`
`static String`	`PARAM_WIZARD_RESTART_PARAMS`
`protected static Map<String,String>`	`parametersMigration`
`static String`	`SEAM_DEBUG_SYSTEM_PROP` Seam hot reload property, also controlled by `NUXEO_DEV_SYSTEM_PROP`
`static List<String>`	`SECRET_KEYS` Keys which value must be displayed thoughtfully
`static String`	`TEMPLATE_SEPARATOR`
`static String`	`TEMPLATES`

Constructor Summary

Constructors
Constructor and Description

ConfigurationGenerator()

ConfigurationGenerator(boolean quiet, boolean debug)

Constructors
Constructor and Description
`ConfigurationGenerator()`
`ConfigurationGenerator(boolean quiet, boolean debug)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addTemplate(String templatesToAdd)` Add template(s) to the `PARAM_TEMPLATES_NAME` list if not already present
`void`	`changeDBTemplate(String dbTemplate)` Change templates using given database template
`String`	`changeTemplates(String newTemplates)`
`void`	`checkAddressesAndPorts()` Will check the configured addresses are reachable and Nuxeo required ports are available on those addresses.
`static void`	`checkAddressReachable(InetAddress address)`
`void`	`checkDatabaseConnection(String databaseTemplate, String dbName, String dbUser, String dbPassword, String dbHost, String dbPort)` Check driver availability and database connection
`static Charset`	`checkFileCharset(File propsFile)`
`protected void`	`checkForDeprecatedParameters(Properties properties)` Check for deprecated parameters
`void`	`checkJavaVersion()` Check that the process is executed with a supported Java version.
`static boolean`	`checkJavaVersion(String version, String requiredVersion)` Checks the java version compared to the required one.
`protected static void`	`checkJavaVersion(String version, String[] compliantVersions)` Check the java version compared to compliant ones.
`protected static boolean`	`checkJavaVersion(String version, String requiredVersion, boolean allowNoFailFlag, boolean warnIfLooseCompliance)` Checks the java version compared to the required one.
`void`	`checkLdapConnection(Hashtable<Object,Object> contextEnv)`
`void`	`checkLdapConnection(String ldapUrl, String ldapBindDn, String ldapBindPwd, boolean authenticate)` Check if the LDAP parameters are correct to bind to a LDAP server.
`static void`	`checkPortAvailable(InetAddress address, int port)` Checks if port is available on given address.
`void`	`cleanupPostWizard()` Ensure the wizard won't be started and nuxeo is ready for use
`protected HashMap<String,String>`	`evalDynamicProperties()` Generate properties which values are based on others
`protected void`	`evalEnvironmentVariables(Map<String,String> newParametersToSave)` Expand environment variable for properties values of the form ${env:MY_VAR}.
`String`	`extractDatabaseTemplateName()` Extract a database template from the current list of templates.
`String`	`extractSecondaryDatabaseTemplateName()` Extract a NoSQL database template from the current list of templates.
`protected void`	`generateFiles()`
`InetAddress`	`getBindAddress()` Checks the userConfig bind address is not 0.0.0.0 and replaces it with 127.0.0.1 if needed
`static InetAddress`	`getBindAddress(String hostName)` Checks hostName bind address is not 0.0.0.0 and replaces it with 127.0.0.1 if needed
`Map<String,String>`	`getChangedParameters(Map<String,String> changedParameters)` Filters given parameters including them only if (there was no previous value and new value is not empty/null) or (there was a previous value and it differs from the new value)
`File`	`getConfigDir()`
`Hashtable<Object,Object>`	`getContextEnv(String ldapUrl, String bindDn, String bindPassword, boolean checkAuthentication)` Build a `Hashtable` which contains environment properties to instantiate a `InitialDirContext`
`Crypto`	`getCrypto()`
`File`	`getDataDir()`
`File`	`getDistributionMPDir()`
`File`	`getDumpedConfig()`
`Environment`	`getEnv()`
`protected String`	`getEnvironmentVariableValue(String key)`
`List<File>`	`getIncludedTemplates()`
`File`	`getInstallFile()`
`List<String>`	`getJavaOpts(Function<String,String> mapper)` Gets the Java options defined in Nuxeo configuration files, e.g.
`protected String`	`getJavaOpts(String key, String value)` Deprecated. Since 9.3. Use `getJavaOptsString()` instead.
`protected String`	`getJavaOptsString()`
`File`	`getLogDir()`
`List<String>`	`getLogFiles()`
`File`	`getNuxeoConf()`
`File`	`getNuxeoDefaultConf()`
`File`	`getNuxeoHome()`
`File`	`getPidDir()`
`File`	`getRuntimeHome()`
`ServerConfigurator`	`getServerConfigurator()`
`protected Properties`	`getStoredConfig()`
`File`	`getTemplateConf(String template)`
`List<String>`	`getTemplateList()` Return the list of templates.
`File`	`getTmpDir()`
`CryptoProperties`	`getUserConfig()`
`String`	`getUserTemplates()`
`void`	`hideDeprecationWarnings(boolean hide)`
`protected void`	`includeTemplates()`
`boolean`	`init()` Initialize configurator, check requirements and load current configuration
`boolean`	`init(boolean forceReload)` Initialize configurator, check requirements and load current configuration
`void`	`initLogs()` Delegate logs initialization to serverConfigurator instance
`boolean`	`isConfigurable()`
`boolean`	`isForceGeneration()`
`boolean`	`isInstallInProgress()`
`boolean`	`isWizardRequired()` Check if wizard must and can be ran
`static Properties`	`loadTrimmedProperties(File propsFile)`
`static void`	`loadTrimmedProperties(Properties props, InputStreamReader propsIS)`
`void`	`prepareWizardStart()` Ensure the server will start only wizard application, not Nuxeo
`String`	`rebuildTemplatesStr(String dbTemplate)` Rebuild a templates string for use in nuxeo.conf
`protected void`	`replaceBackslashes()` Read nuxeo.conf, replace backslashes in paths and write new nuxeo.conf
`void`	`rmTemplate(String templatesToRm)` Remove template(s) from the `PARAM_TEMPLATES_NAME` list
`void`	`run()` Runs the configuration files generation.
`void`	`saveConfiguration(Map<String,String> changedParameters)` Save changed parameters in `nuxeo.conf`.
`void`	`saveConfiguration(Map<String,String> changedParameters, boolean setGenerationOnceToFalse, boolean setGenerationFalseToOnce)` Save changed parameters in `nuxeo.conf` calculating templates if changedParameters contains a value for `PARAM_TEMPLATE_DBNAME`.
`void`	`saveFilteredConfiguration(Map<String,String> changedParameters)` Save changed parameters in `nuxeo.conf`, filtering parameters with `getChangedParameters(Map)`
`void`	`setDirectoryWithProperty(String key)`
`void`	`setForceGeneration(boolean forceGeneration)`
`Map<String,String>`	`setProperties(Map<String,String> newParametersToSave)` Set properties in nuxeo configuration
`Map<String,String>`	`setProperties(String template, Map<String,String> newParametersToSave)` Set properties in the given template, if it exists
`String`	`setProperty(String key, String value)` Set a property in nuxeo configuration
`void`	`verifyInstallation()` Create needed directories.

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

- Field Detail
  - TEMPLATE_SEPARATOR
```
public static final String TEMPLATE_SEPARATOR
```
    Since:
    
    6.0
    
    See Also:
    
    Constant Field Values
  - COMPLIANT_JAVA_VERSIONS
```
public static final String[] COMPLIANT_JAVA_VERSIONS
```
    Accurate but not used internally. NXP-18023: Java 8 update 40+ required
    
    Since:
    
    5.7
  - CONFIGURATION_PROPERTIES
```
protected static final String CONFIGURATION_PROPERTIES
```
    Since:
    
    5.6
    
    See Also:
    
    Constant Field Values
  - NUXEO_CONF
```
public static final String NUXEO_CONF
```
    See Also:
    
    Constant Field Values
  - TEMPLATES
```
public static final String TEMPLATES
```
    See Also:
    
    Constant Field Values
  - NUXEO_DEFAULT_CONF
```
public static final String NUXEO_DEFAULT_CONF
```
    See Also:
    
    Constant Field Values
  - PARAM_TEMPLATES_NAME
```
public static final String PARAM_TEMPLATES_NAME
```
    Absolute or relative PATH to the user chosen templates (comma separated list)
    
    See Also:
    
    Constant Field Values
  - PARAM_TEMPLATE_DBNAME
```
public static final String PARAM_TEMPLATE_DBNAME
```
    See Also:
    
    Constant Field Values
  - PARAM_TEMPLATE_DBSECONDARY_NAME
```
public static final String PARAM_TEMPLATE_DBSECONDARY_NAME
```
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - PARAM_TEMPLATE_DBTYPE
```
public static final String PARAM_TEMPLATE_DBTYPE
```
    See Also:
    
    Constant Field Values
  - PARAM_TEMPLATE_DBSECONDARY_TYPE
```
public static final String PARAM_TEMPLATE_DBSECONDARY_TYPE
```
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - OLD_PARAM_TEMPLATES_PARSING_EXTENSIONS
```
public static final String OLD_PARAM_TEMPLATES_PARSING_EXTENSIONS
```
    See Also:
    
    Constant Field Values
  - PARAM_TEMPLATES_PARSING_EXTENSIONS
```
public static final String PARAM_TEMPLATES_PARSING_EXTENSIONS
```
    See Also:
    
    Constant Field Values
  - PARAM_TEMPLATES_FREEMARKER_EXTENSIONS
```
public static final String PARAM_TEMPLATES_FREEMARKER_EXTENSIONS
```
    See Also:
    
    Constant Field Values
  - PARAM_INCLUDED_TEMPLATES
```
protected static final String PARAM_INCLUDED_TEMPLATES
```
    Absolute or relative PATH to the included templates (comma separated list)
    
    See Also:
    
    Constant Field Values
  - PARAM_FORCE_GENERATION
```
public static final String PARAM_FORCE_GENERATION
```
    See Also:
    
    Constant Field Values
  - BOUNDARY_BEGIN
```
public static final String BOUNDARY_BEGIN
```
    See Also:
    
    Constant Field Values
  - BOUNDARY_END
```
public static final String BOUNDARY_END
```
    See Also:
    
    Constant Field Values
  - DB_LIST
```
public static final List<String> DB_LIST
```
  - DB_SECONDARY_LIST
```
public static final List<String> DB_SECONDARY_LIST
```
  - DB_EXCLUDE_CHECK_LIST
```
public static final List<String> DB_EXCLUDE_CHECK_LIST
```
  - PARAM_WIZARD_DONE
```
public static final String PARAM_WIZARD_DONE
```
    See Also:
    
    Constant Field Values
  - PARAM_WIZARD_RESTART_PARAMS
```
public static final String PARAM_WIZARD_RESTART_PARAMS
```
    See Also:
    
    Constant Field Values
  - PARAM_FAKE_WINDOWS
```
public static final String PARAM_FAKE_WINDOWS
```
    See Also:
    
    Constant Field Values
  - PARAM_LOOPBACK_URL
```
public static final String PARAM_LOOPBACK_URL
```
    See Also:
    
    Constant Field Values
  - MIN_PORT
```
public static final int MIN_PORT
```
    See Also:
    
    Constant Field Values
  - MAX_PORT
```
public static final int MAX_PORT
```
    See Also:
    
    Constant Field Values
  - ADDRESS_PING_TIMEOUT
```
public static final int ADDRESS_PING_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - PARAM_BIND_ADDRESS
```
public static final String PARAM_BIND_ADDRESS
```
    See Also:
    
    Constant Field Values
  - PARAM_HTTP_PORT
```
public static final String PARAM_HTTP_PORT
```
    See Also:
    
    Constant Field Values
  - PARAM_STATUS_KEY
```
@Deprecated
public static final String PARAM_STATUS_KEY
```
    Deprecated. Since 7.4. Use Environment.SERVER_STATUS_KEY instead
    
    See Also:
    
    Constant Field Values
  - PARAM_CONTEXT_PATH
```
public static final String PARAM_CONTEXT_PATH
```
    See Also:
    
    Constant Field Values
  - PARAM_MP_DIR
```
public static final String PARAM_MP_DIR
```
    See Also:
    
    Constant Field Values
  - DISTRIBUTION_MP_DIR
```
public static final String DISTRIBUTION_MP_DIR
```
    See Also:
    
    Constant Field Values
  - INSTALL_AFTER_RESTART
```
public static final String INSTALL_AFTER_RESTART
```
    See Also:
    
    Constant Field Values
  - PARAM_DB_DRIVER
```
public static final String PARAM_DB_DRIVER
```
    See Also:
    
    Constant Field Values
  - PARAM_DB_JDBC_URL
```
public static final String PARAM_DB_JDBC_URL
```
    See Also:
    
    Constant Field Values
  - PARAM_DB_HOST
```
public static final String PARAM_DB_HOST
```
    See Also:
    
    Constant Field Values
  - PARAM_DB_PORT
```
public static final String PARAM_DB_PORT
```
    See Also:
    
    Constant Field Values
  - PARAM_DB_NAME
```
public static final String PARAM_DB_NAME
```
    See Also:
    
    Constant Field Values
  - PARAM_DB_USER
```
public static final String PARAM_DB_USER
```
    See Also:
    
    Constant Field Values
  - PARAM_DB_PWD
```
public static final String PARAM_DB_PWD
```
    See Also:
    
    Constant Field Values
  - PARAM_MONGODB_NAME
```
public static final String PARAM_MONGODB_NAME
```
    Since:
    
    8.1
    
    See Also:
    
    Constant Field Values
  - PARAM_MONGODB_SERVER
```
public static final String PARAM_MONGODB_SERVER
```
    Since:
    
    8.1
    
    See Also:
    
    Constant Field Values
  - JAVA_OPTS_PATTERN
```
protected static final Pattern JAVA_OPTS_PATTERN
```
    Java options split by spaces followed by an even number of quotes (or zero).
    
    Since:
    
    9.3
  - SECRET_KEYS
```
public static final List<String> SECRET_KEYS
```
    Keys which value must be displayed thoughtfully
    
    Since:
    
    8.1
  - PARAM_PRODUCT_NAME
```
@Deprecated
public static final String PARAM_PRODUCT_NAME
```
    Deprecated. Since 7.10. Use Environment.PRODUCT_NAME
    
    See Also:
    
    Constant Field Values
  - PARAM_PRODUCT_VERSION
```
@Deprecated
public static final String PARAM_PRODUCT_VERSION
```
    Deprecated. Since 7.10. Use Environment.PRODUCT_VERSION
    
    See Also:
    
    Constant Field Values
  - PARAM_NUXEO_URL
```
public static final String PARAM_NUXEO_URL
```
    Since:
    
    5.6
    
    See Also:
    
    Constant Field Values
  - NUXEO_DEV_SYSTEM_PROP
```
public static final String NUXEO_DEV_SYSTEM_PROP
```
    Global dev property, duplicated from runtime framework
    
    Since:
    
    5.6
    
    See Also:
    
    Constant Field Values
  - SEAM_DEBUG_SYSTEM_PROP
```
public static final String SEAM_DEBUG_SYSTEM_PROP
```
    Seam hot reload property, also controlled by NUXEO_DEV_SYSTEM_PROP
    
    Since:
    
    5.6
    
    See Also:
    
    Constant Field Values
  - JVMCHECK_PROP
```
public static final String JVMCHECK_PROP
```
    Since:
    
    8.4
    
    See Also:
    
    Constant Field Values
  - JVMCHECK_FAIL
```
public static final String JVMCHECK_FAIL
```
    Since:
    
    8.4
    
    See Also:
    
    Constant Field Values
  - JVMCHECK_NOFAIL
```
public static final String JVMCHECK_NOFAIL
```
    Since:
    
    8.4
    
    See Also:
    
    Constant Field Values
  - JAVA_OPTS_PROP
```
public static final String JAVA_OPTS_PROP
```
    Java options configured in bin/nuxeo.conf and bin/nuxeoctl.
    
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - isJetty
```
public boolean isJetty
```
  - isTomcat
```
public boolean isTomcat
```
  - parametersMigration
```
protected static final Map<String,String> parametersMigration
```
- Constructor Detail
  - ConfigurationGenerator
```
public ConfigurationGenerator()
```
  - ConfigurationGenerator
```
public ConfigurationGenerator(boolean quiet,
                              boolean debug)
```
    Parameters:
    
    quiet - Suppress info level messages from the console output
    
    debug - Activate debug level logging
    
    Since:
    
    5.6
- Method Detail
  - isConfigurable
```
public boolean isConfigurable()
```
  - getStoredConfig
```
protected Properties getStoredConfig()
```
    Since:
    
    5.7
  - hideDeprecationWarnings
```
public void hideDeprecationWarnings(boolean hide)
```
  - setForceGeneration
```
public void setForceGeneration(boolean forceGeneration)
```
    See Also:
    
    PARAM_FORCE_GENERATION
  - isForceGeneration
```
public boolean isForceGeneration()
```
    Returns:
    
    true if configuration will be generated from templates
    
    Since:
    
    5.4.2
    
    See Also:
    
    PARAM_FORCE_GENERATION
  - getUserConfig
```
public CryptoProperties getUserConfig()
```
  - getServerConfigurator
```
public final ServerConfigurator getServerConfigurator()
```
    Since:
    
    5.4.2
  - run
```
public void run()
         throws ConfigurationException
```
    Runs the configuration files generation.
    
    Throws:
    
    ConfigurationException
  - init
```
public boolean init()
```
    Initialize configurator, check requirements and load current configuration
    
    Returns:
    
    returns true if current install is configurable, else returns false
  - init
```
public boolean init(boolean forceReload)
```
    Initialize configurator, check requirements and load current configuration
    
    Parameters:
    
    forceReload - If true, forces configuration reload.
    
    Returns:
    
    returns true if current install is configurable, else returns false
    
    Since:
    
    5.6
  - changeTemplates
```
public String changeTemplates(String newTemplates)
```
    Returns:
    
    Old templates
  - changeDBTemplate
```
public void changeDBTemplate(String dbTemplate)
```
    Change templates using given database template
    
    Parameters:
    
    dbTemplate - new database template
    
    Since:
    
    5.4.2
  - includeTemplates
```
protected void includeTemplates()
                         throws IOException
```
    Throws:
    
    IOException
    
    Since:
    
    5.7
  - evalDynamicProperties
```
protected HashMap<String,String> evalDynamicProperties()
                                                throws ConfigurationException
```
    Generate properties which values are based on others
    
    Returns:
    
    Map with new parameters to save in nuxeoConf
    
    Throws:
    
    ConfigurationException
    
    Since:
    
    5.5
  - evalEnvironmentVariables
```
protected void evalEnvironmentVariables(Map<String,String> newParametersToSave)
```
    Expand environment variable for properties values of the form ${env:MY_VAR}.
    
    Since:
    
    9.1
  - replaceBackslashes
```
protected void replaceBackslashes()
                           throws ConfigurationException
```
    Read nuxeo.conf, replace backslashes in paths and write new nuxeo.conf
    
    Throws:
    
    ConfigurationException - if any error reading or writing nuxeo.conf
    
    Since:
    
    5.4.1
  - setDirectoryWithProperty
```
public void setDirectoryWithProperty(String key)
```
    Parameters:
    
    key - Directory system key
    
    Since:
    
    5.4.2
    
    See Also:
    
    Environment
  - getUserTemplates
```
public String getUserTemplates()
```
  - generateFiles
```
protected void generateFiles()
                      throws ConfigurationException
```
    Throws:
    
    ConfigurationException
  - checkForDeprecatedParameters
```
protected void checkForDeprecatedParameters(Properties properties)
```
    Check for deprecated parameters
    
    Since:
    
    5.6
  - getNuxeoHome
```
public File getNuxeoHome()
```
  - getNuxeoDefaultConf
```
public File getNuxeoDefaultConf()
```
  - getIncludedTemplates
```
public List<File> getIncludedTemplates()
```
  - saveConfiguration
```
public void saveConfiguration(Map<String,String> changedParameters)
                       throws ConfigurationException
```
    Save changed parameters in nuxeo.conf. This method does not check values in map. Use saveFilteredConfiguration(Map) for parameters filtering.
    
    Parameters:
    
    changedParameters - Map of modified parameters
    
    Throws:
    
    ConfigurationException
    
    See Also:
    
    saveFilteredConfiguration(Map)
  - saveConfiguration
```
public void saveConfiguration(Map<String,String> changedParameters,
                              boolean setGenerationOnceToFalse,
                              boolean setGenerationFalseToOnce)
                       throws ConfigurationException
```
    Save changed parameters in nuxeo.conf calculating templates if changedParameters contains a value for PARAM_TEMPLATE_DBNAME. If a parameter value is empty ("" or null), then the property is unset. PARAM_WIZARD_DONE, PARAM_TEMPLATES_NAME and PARAM_FORCE_GENERATION cannot be unset, but their value can be changed.
    This method does not check values in map: use saveFilteredConfiguration(Map) for parameters filtering.
    
    Parameters:
    
    changedParameters - Map of modified parameters
    
    setGenerationOnceToFalse - If generation was on (true or once), then set it to false or not?
    
    setGenerationFalseToOnce - If generation was off (false), then set it to once?
    
    Throws:
    
    ConfigurationException
    
    Since:
    
    5.5
    
    See Also:
    
    saveFilteredConfiguration(Map)
  - saveFilteredConfiguration
```
public void saveFilteredConfiguration(Map<String,String> changedParameters)
                               throws ConfigurationException
```
    Save changed parameters in nuxeo.conf, filtering parameters with getChangedParameters(Map)
    
    Parameters:
    
    changedParameters - Maps of modified parameters
    
    Throws:
    
    ConfigurationException
    
    Since:
    
    5.4.2
    
    See Also:
    
    saveConfiguration(Map), getChangedParameters(Map)
  - getChangedParameters
```
public Map<String,String> getChangedParameters(Map<String,String> changedParameters)
```
    Filters given parameters including them only if (there was no previous value and new value is not empty/null) or (there was a previous value and it differs from the new value)
    
    Parameters:
    
    changedParameters - parameters to be filtered
    
    Returns:
    
    filtered map
    
    Since:
    
    5.4.2
  - extractDatabaseTemplateName
```
public String extractDatabaseTemplateName()
```
    Extract a database template from the current list of templates. Return the last one if there are multiples.
    
    See Also:
    
    rebuildTemplatesStr(String)
  - extractSecondaryDatabaseTemplateName
```
public String extractSecondaryDatabaseTemplateName()
```
    Extract a NoSQL database template from the current list of templates. Return the last one if there are multiples.
    
    Since:
    
    8.1
    
    See Also:
    
    rebuildTemplatesStr(String)
  - getNuxeoConf
```
public File getNuxeoConf()
```
    Returns:
    
    nuxeo.conf file used
  - initLogs
```
public void initLogs()
```
    Delegate logs initialization to serverConfigurator instance
    
    Since:
    
    5.4.2
  - getLogDir
```
public File getLogDir()
```
    Returns:
    
    log directory
    
    Since:
    
    5.4.2
  - getPidDir
```
public File getPidDir()
```
    Returns:
    
    pid directory
    
    Since:
    
    5.4.2
  - getDataDir
```
public File getDataDir()
```
    Returns:
    
    Data directory
    
    Since:
    
    5.4.2
  - verifyInstallation
```
public void verifyInstallation()
                        throws ConfigurationException
```
    Create needed directories. Check existence of old paths. If old paths have been found and they cannot be upgraded automatically, then upgrading message is logged and error thrown.
    
    Throws:
    
    ConfigurationException - If a deprecated directory has been detected.
    
    Since:
    
    5.4.2
    
    See Also:
    
    ServerConfigurator.verifyInstallation()
  - checkJavaVersion
```
public void checkJavaVersion()
                      throws ConfigurationException
```
    Check that the process is executed with a supported Java version. See J2SE SDK/JRE Version String Naming Convention
    
    Throws:
    
    ConfigurationException
    
    Since:
    
    5.6
  - checkJavaVersion
```
protected static void checkJavaVersion(String version,
                                       String[] compliantVersions)
                                throws ConfigurationException
```
    Check the java version compared to compliant ones.
    
    Parameters:
    
    version - the java version
    
    compliantVersions - the compliant java versions
    
    Throws:
    
    ConfigurationException
    
    Since:
    
    9.1
  - checkJavaVersion
```
protected static boolean checkJavaVersion(String version,
                                          String requiredVersion,
                                          boolean allowNoFailFlag,
                                          boolean warnIfLooseCompliance)
```
    Checks the java version compared to the required one.
    Loose compliance is assumed if the major version is greater than the required major version or a jvmcheck=nofail flag is set.
    
    Parameters:
    
    version - the java version
    
    requiredVersion - the required java version
    
    allowNoFailFlag - if true then check jvmcheck=nofail flag to always have loose compliance
    
    warnIfLooseCompliance - if true then log a WARN if the is loose compliance
    
    Returns:
    
    true if the java version is compliant (maybe loosely) with the required version
    
    Since:
    
    8.4
  - checkJavaVersion
```
public static boolean checkJavaVersion(String version,
                                       String requiredVersion)
```
    Checks the java version compared to the required one.
    If major version is same as required major version and minor is greater or equal, it is compliant.
    If major version is greater than required major version, it is compliant.
    
    Parameters:
    
    version - the java version
    
    requiredVersion - the required java version
    
    Returns:
    
    true if the java version is compliant with the required version
    
    Since:
    
    8.4
  - checkAddressesAndPorts
```
public void checkAddressesAndPorts()
                            throws ConfigurationException
```
    Will check the configured addresses are reachable and Nuxeo required ports are available on those addresses. Server specific implementations should override this method in order to check for server specific ports. PARAM_BIND_ADDRESS must be set before.
    
    Throws:
    
    ConfigurationException
    
    Since:
    
    5.5
    
    See Also:
    
    ServerConfigurator.verifyInstallation()
  - getBindAddress
```
public InetAddress getBindAddress()
                           throws ConfigurationException
```
    Checks the userConfig bind address is not 0.0.0.0 and replaces it with 127.0.0.1 if needed
    
    Returns:
    
    the userConfig bind address if not 0.0.0.0 else 127.0.0.1
    
    Throws:
    
    ConfigurationException
    
    Since:
    
    5.7
  - getBindAddress
```
public static InetAddress getBindAddress(String hostName)
                                  throws ConfigurationException
```
    Checks hostName bind address is not 0.0.0.0 and replaces it with 127.0.0.1 if needed
    
    Parameters:
    
    hostName - the hostname of Nuxeo server (works also with the IP)
    
    Returns:
    
    the bind address matching hostName parameter if not 0.0.0.0 else 127.0.0.1
    
    Throws:
    
    ConfigurationException
    
    Since:
    
    9.2
  - checkAddressReachable
```
public static void checkAddressReachable(InetAddress address)
                                  throws ConfigurationException
```
    Parameters:
    
    address - address to check for availability
    
    Throws:
    
    ConfigurationException
    
    Since:
    
    5.5
  - checkPortAvailable
```
public static void checkPortAvailable(InetAddress address,
                                      int port)
                               throws ConfigurationException
```
    Checks if port is available on given address.
    
    Parameters:
    
    port - port to check for availability
    
    Throws:
    
    ConfigurationException - Throws an exception if address is unavailable.
    
    Since:
    
    5.5
  - getTmpDir
```
public File getTmpDir()
```
    Returns:
    
    Temporary directory
  - getLogFiles
```
public List<String> getLogFiles()
```
    Returns:
    
    Log files produced by Log4J configuration without loading this configuration instead of current active one.
    
    Since:
    
    5.4.2
  - isWizardRequired
```
public boolean isWizardRequired()
```
    Check if wizard must and can be ran
    
    Returns:
    
    true if configuration wizard is required before starting Nuxeo
    
    Since:
    
    5.4.2
  - rebuildTemplatesStr
```
public String rebuildTemplatesStr(String dbTemplate)
```
    Rebuild a templates string for use in nuxeo.conf
    
    Parameters:
    
    dbTemplate - database template to use instead of current one
    
    Returns:
    
    new templates string using given dbTemplate
    
    Since:
    
    5.4.2
    
    See Also:
    
    extractDatabaseTemplateName(), changeDBTemplate(String), changeTemplates(String)
  - getConfigDir
```
public File getConfigDir()
```
    Returns:
    
    Nuxeo config directory
    
    Since:
    
    5.4.2
  - prepareWizardStart
```
public void prepareWizardStart()
```
    Ensure the server will start only wizard application, not Nuxeo
    
    Since:
    
    5.4.2
  - cleanupPostWizard
```
public void cleanupPostWizard()
```
    Ensure the wizard won't be started and nuxeo is ready for use
    
    Since:
    
    5.4.2
  - getRuntimeHome
```
public File getRuntimeHome()
```
    Returns:
    
    Nuxeo runtime home
  - isInstallInProgress
```
public boolean isInstallInProgress()
```
    Returns:
    
    true if there's an install in progress
    
    Since:
    
    5.4.2
  - getDistributionMPDir
```
public File getDistributionMPDir()
```
    Returns:
    
    File pointing to the directory containing the marketplace packages included in the distribution
    
    Since:
    
    5.6
  - getInstallFile
```
public File getInstallFile()
```
    Returns:
    
    Install/upgrade file
    
    Since:
    
    5.4.1
  - addTemplate
```
public void addTemplate(String templatesToAdd)
                 throws ConfigurationException
```
    Add template(s) to the PARAM_TEMPLATES_NAME list if not already present
    
    Parameters:
    
    templatesToAdd - Comma separated templates to add
    
    Throws:
    
    ConfigurationException
    
    Since:
    
    5.5
  - getTemplateList
```
public List<String> getTemplateList()
```
    Return the list of templates.
    
    Since:
    
    9.2
  - rmTemplate
```
public void rmTemplate(String templatesToRm)
                throws ConfigurationException
```
    Remove template(s) from the PARAM_TEMPLATES_NAME list
    
    Parameters:
    
    templatesToRm - Comma separated templates to remove
    
    Throws:
    
    ConfigurationException
    
    Since:
    
    5.5
  - setProperty
```
public String setProperty(String key,
                          String value)
                   throws ConfigurationException
```
    Set a property in nuxeo configuration
    
    Returns:
    
    The old value
    
    Throws:
    
    ConfigurationException
    
    Since:
    
    5.5
  - setProperties
```
public Map<String,String> setProperties(Map<String,String> newParametersToSave)
                                 throws ConfigurationException
```
    Set properties in nuxeo configuration
    
    Returns:
    
    The old values
    
    Throws:
    
    ConfigurationException
    
    Since:
    
    7.4
  - setProperties
```
public Map<String,String> setProperties(String template,
                                        Map<String,String> newParametersToSave)
                                 throws ConfigurationException,
                                        IOException
```
    Set properties in the given template, if it exists
    
    Returns:
    
    The old values
    
    Throws:
    
    ConfigurationException
    
    IOException
    
    Since:
    
    7.4
  - checkDatabaseConnection
```
public void checkDatabaseConnection(String databaseTemplate,
                                    String dbName,
                                    String dbUser,
                                    String dbPassword,
                                    String dbHost,
                                    String dbPort)
                             throws IOException,
                                    DatabaseDriverException,
                                    SQLException
```
    Check driver availability and database connection
    
    Parameters:
    
    databaseTemplate - Nuxeo database template
    
    dbName - nuxeo.db.name parameter in nuxeo.conf
    
    dbUser - nuxeo.db.user parameter in nuxeo.conf
    
    dbPassword - nuxeo.db.password parameter in nuxeo.conf
    
    dbHost - nuxeo.db.host parameter in nuxeo.conf
    
    dbPort - nuxeo.db.port parameter in nuxeo.conf
    
    Throws:
    
    IOException
    
    DatabaseDriverException
    
    SQLException
    
    Since:
    
    5.6
  - getEnv
```
public Environment getEnv()
```
    Returns:
    
    an Environment initialized with a few basics
    
    Since:
    
    5.6
  - checkFileCharset
```
public static Charset checkFileCharset(File propsFile)
                                throws IOException
```
    Parameters:
    
    propsFile - Properties file
    
    Returns:
    
    String with the charset encoding for this file
    
    Throws:
    
    IOException
    
    Since:
    
    10.2
  - loadTrimmedProperties
```
public static Properties loadTrimmedProperties(File propsFile)
                                        throws IOException
```
    Parameters:
    
    propsFile - Properties file
    
    Returns:
    
    new Properties containing trimmed keys and values read in propsFile
    
    Throws:
    
    IOException
    
    Since:
    
    5.6
  - loadTrimmedProperties
```
public static void loadTrimmedProperties(Properties props,
                                         InputStreamReader propsIS)
                                  throws IOException
```
    Parameters:
    
    props - Properties object to be filled
    
    propsIS - Properties InputStream
    
    Throws:
    
    IOException
    
    Since:
    
    5.6
  - getDumpedConfig
```
public File getDumpedConfig()
```
    Returns:
    
    The generated properties file with dumped configuration.
    
    Since:
    
    5.6
  - getContextEnv
```
public Hashtable<Object,Object> getContextEnv(String ldapUrl,
                                              String bindDn,
                                              String bindPassword,
                                              boolean checkAuthentication)
```
    Build a Hashtable which contains environment properties to instantiate a InitialDirContext
    
    Since:
    
    6.0
  - checkLdapConnection
```
public void checkLdapConnection(String ldapUrl,
                                String ldapBindDn,
                                String ldapBindPwd,
                                boolean authenticate)
                         throws NamingException
```
    Check if the LDAP parameters are correct to bind to a LDAP server. if authenticate argument is true, it will also check if the authentication against the LDAP server succeeds
    
    Parameters:
    
    authenticate - Indicates if authentication against LDAP should be checked.
    
    Throws:
    
    NamingException
    
    Since:
    
    6.0
  - checkLdapConnection
```
public void checkLdapConnection(Hashtable<Object,Object> contextEnv)
                         throws NamingException
```
    Parameters:
    
    contextEnv - Environment properties to build a InitialDirContext
    
    Throws:
    
    NamingException
    
    Since:
    
    6.0
  - getCrypto
```
public Crypto getCrypto()
```
    Returns:
    
    a Crypto instance initialized with the configuration parameters
    
    Since:
    
    7.4
    
    See Also:
    
    Crypto
  - getTemplateConf
```
public File getTemplateConf(String template)
                     throws ConfigurationException
```
    Parameters:
    
    template - path to configuration template directory
    
    Returns:
    
    A nuxeo.defaults file if it exists.
    
    Throws:
    
    ConfigurationException - if the template file is not found.
    
    Since:
    
    7.4
  - getJavaOpts
```
@Deprecated
protected String getJavaOpts(String key,
                                         String value)
```
    Deprecated. Since 9.3. Use getJavaOptsString() instead.
    
    Gets the Java options with 'nuxeo.*' properties substituted. It enables usage of property like ${nuxeo.log.dir} inside JAVA_OPTS.
    
    Returns:
    
    the Java options string.
  - getJavaOpts
```
public List<String> getJavaOpts(Function<String,String> mapper)
```
    Gets the Java options defined in Nuxeo configuration files, e.g. bin/nuxeo.conf and bin/nuxeoctl.
    
    Returns:
    
    the Java options.
    
    Since:
    
    9.3
  - getJavaOptsString
```
protected String getJavaOptsString()
```
    Returns:
    
    the Java options string.
    
    Since:
    
    9.3
    
    See Also:
    
    getJavaOpts(Function)
  - getEnvironmentVariableValue
```
protected String getEnvironmentVariableValue(String key)
```
    Returns:
    
    the value of an environment variable. Overriden for testing.
    
    Since:
    
    9.1

Class ConfigurationGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TEMPLATE_SEPARATOR

COMPLIANT_JAVA_VERSIONS

CONFIGURATION_PROPERTIES

NUXEO_CONF

TEMPLATES

NUXEO_DEFAULT_CONF

PARAM_TEMPLATES_NAME

PARAM_TEMPLATE_DBNAME

PARAM_TEMPLATE_DBSECONDARY_NAME

PARAM_TEMPLATE_DBTYPE

PARAM_TEMPLATE_DBSECONDARY_TYPE

OLD_PARAM_TEMPLATES_PARSING_EXTENSIONS

PARAM_TEMPLATES_PARSING_EXTENSIONS

PARAM_TEMPLATES_FREEMARKER_EXTENSIONS

PARAM_INCLUDED_TEMPLATES

PARAM_FORCE_GENERATION

BOUNDARY_BEGIN

BOUNDARY_END

DB_LIST

DB_SECONDARY_LIST

DB_EXCLUDE_CHECK_LIST

PARAM_WIZARD_DONE

PARAM_WIZARD_RESTART_PARAMS

PARAM_FAKE_WINDOWS

PARAM_LOOPBACK_URL

MIN_PORT

MAX_PORT

ADDRESS_PING_TIMEOUT

PARAM_BIND_ADDRESS

PARAM_HTTP_PORT

PARAM_STATUS_KEY

PARAM_CONTEXT_PATH

PARAM_MP_DIR

DISTRIBUTION_MP_DIR

INSTALL_AFTER_RESTART

PARAM_DB_DRIVER

PARAM_DB_JDBC_URL

PARAM_DB_HOST

PARAM_DB_PORT

PARAM_DB_NAME

PARAM_DB_USER

PARAM_DB_PWD

PARAM_MONGODB_NAME

PARAM_MONGODB_SERVER

JAVA_OPTS_PATTERN

SECRET_KEYS

PARAM_PRODUCT_NAME

PARAM_PRODUCT_VERSION

PARAM_NUXEO_URL

NUXEO_DEV_SYSTEM_PROP

SEAM_DEBUG_SYSTEM_PROP

JVMCHECK_PROP

JVMCHECK_FAIL

JVMCHECK_NOFAIL

JAVA_OPTS_PROP

isJetty

isTomcat

parametersMigration

Constructor Detail

ConfigurationGenerator

ConfigurationGenerator

Method Detail

isConfigurable

getStoredConfig

hideDeprecationWarnings

setForceGeneration

isForceGeneration

getUserConfig

getServerConfigurator

run

init

init

changeTemplates

changeDBTemplate