ServerConfigurator (Nuxeo ECM Projects 8.1 API)

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

Direct Known Subclasses:

JettyConfigurator, TomcatConfigurator, UnknownServerConfigurator
```
public abstract class ServerConfigurator
extends Object
```
Author:

jcarsique

Field Summary

Fields
Modifier and Type	Field and Description
`protected File`	`dataDir`
`protected static String`	`DEFAULT_CONTEXT_NAME`
`static String`	`DEFAULT_DATA_DIR` Deprecated. Since 5.9.4. Use `Environment.DEFAULT_DATA_DIR` instead.
`static String`	`DEFAULT_LOG_DIR` Deprecated. Since 5.9.4. Use `Environment.DEFAULT_LOG_DIR` instead.
`static String`	`DEFAULT_TMP_DIR` Deprecated. Since 5.9.4. Use `Environment.DEFAULT_TMP_DIR` instead.
`protected ConfigurationGenerator`	`generator`
`protected File`	`libDir`
`protected static org.apache.commons.logging.Log`	`log`
`protected File`	`logDir`
`static List<String>`	`NUXEO_SYSTEM_PROPERTIES`
`protected File`	`packagesDir`
`protected File`	`pidDir`
`protected File`	`tmpDir`

Constructor Summary

Constructors
Constructor and Description

ServerConfigurator(ConfigurationGenerator configurationGenerator)

Constructors
Constructor and Description
`ServerConfigurator(ConfigurationGenerator configurationGenerator)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addServerSpecificParameters(Map<String,String> parametersmigration)` Override to add server specific parameters to the list of parameters to migrate
`protected void`	`checkNetwork()` Perform server specific checks, not already done by `ConfigurationGenerator.checkAddressesAndPorts()`
`protected void`	`checkPath(File oldPath, String message)` Check if oldPath exist; if so, then raise a ConfigurationException with information for fixing issue
`void`	`checkPaths()` Check server paths; warn if existing deprecated paths.
`void`	`cleanupPostWizard()`
`void`	`dumpProperties(CryptoProperties userConfig)`
`Properties`	`filterSystemProperties(CryptoProperties properties)` Extract Nuxeo properties from given Properties (System properties are removed, except those set by Nuxeo)
`abstract File`	`getConfigDir()`
`File`	`getDataDir()`
`protected String`	`getDefaultDataDir()`
`String`	`getDefaultPackagesDir()`
`String`	`getDefaultTmpDir()`
`File`	`getDirectory(String key)`
`abstract File`	`getLogConfFile()`
`File`	`getLogDir()`
`File`	`getNuxeoLibDir()`
`protected File`	`getOutputDirectory()`
`File`	`getPackagesDir()`
`File`	`getPidDir()`
`protected abstract File`	`getRuntimeHome()` Returns the Home of NuxeoRuntime (same as Framework.getRuntime().getHome().getAbsolutePath())
`abstract File`	`getServerLibDir()`
`File`	`getTmpDir()`
`void`	`initLogs()` Initialize logs.
`boolean`	`isWizardAvailable()` Override it to make the wizard available for a given server.
`protected void`	`parseAndCopy(Properties config)` Generate configuration files from templates and given configuration parameters
`void`	`prepareWizardStart()`
`void`	`setDataDir(String dataDirStr)`
`void`	`setDirectory(String key, String directory)`
`void`	`setLogDir(String logDirStr)`
`void`	`setPidDir(String pidDirStr)`
`void`	`setTmpDir(String tmpDirStr)`
`void`	`verifyInstallation()`

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

- Field Detail
  - log
```
protected static final org.apache.commons.logging.Log log
```
  - generator
```
protected final ConfigurationGenerator generator
```
  - dataDir
```
protected File dataDir
```
  - logDir
```
protected File logDir
```
  - pidDir
```
protected File pidDir
```
  - libDir
```
protected File libDir
```
  - tmpDir
```
protected File tmpDir
```
  - packagesDir
```
protected File packagesDir
```
  - NUXEO_SYSTEM_PROPERTIES
```
public static final List<String> NUXEO_SYSTEM_PROPERTIES
```
    Since:
    
    5.4.2
  - DEFAULT_CONTEXT_NAME
```
protected static final String DEFAULT_CONTEXT_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_LOG_DIR
```
@Deprecated
public static final String DEFAULT_LOG_DIR
```
    Deprecated. Since 5.9.4. Use Environment.DEFAULT_LOG_DIR instead.
    
    Since:
    
    5.4.2
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DATA_DIR
```
@Deprecated
public static final String DEFAULT_DATA_DIR
```
    Deprecated. Since 5.9.4. Use Environment.DEFAULT_DATA_DIR instead.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TMP_DIR
```
@Deprecated
public static final String DEFAULT_TMP_DIR
```
    Deprecated. Since 5.9.4. Use Environment.DEFAULT_TMP_DIR instead.
    
    Since:
    
    5.4.2
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ServerConfigurator
```
public ServerConfigurator(ConfigurationGenerator configurationGenerator)
```
- Method Detail
  - parseAndCopy
```
protected void parseAndCopy(Properties config)
                     throws IOException,
                            freemarker.template.TemplateException,
                            ConfigurationException
```
    Generate configuration files from templates and given configuration parameters
    
    Parameters:
    
    config - Properties with configuration parameters for template replacement
    
    Throws:
    
    ConfigurationException
    
    IOException
    
    freemarker.template.TemplateException
  - getOutputDirectory
```
protected File getOutputDirectory()
```
    Returns:
    
    output directory for files generation
  - getDefaultDataDir
```
protected String getDefaultDataDir()
```
    Returns:
    
    Default data directory path relative to Nuxeo Home
    
    Since:
    
    5.4.2
  - getRuntimeHome
```
protected abstract File getRuntimeHome()
```
    Returns the Home of NuxeoRuntime (same as Framework.getRuntime().getHome().getAbsolutePath())
  - getDataDir
```
public File getDataDir()
```
    Returns:
    
    Data directory
    
    Since:
    
    5.4.2
  - getLogDir
```
public File getLogDir()
```
    Returns:
    
    Log directory
    
    Since:
    
    5.4.2
  - setDataDir
```
public void setDataDir(String dataDirStr)
```
    Parameters:
    
    dataDirStr - Data directory path to set
    
    Since:
    
    5.4.2
  - setLogDir
```
public void setLogDir(String logDirStr)
```
    Parameters:
    
    logDirStr - Log directory path to set
    
    Since:
    
    5.4.2
  - initLogs
```
public void initLogs()
```
    Initialize logs. This is called before ConfigurationGenerator.init() so the logDir field is not yet initialized
    
    Since:
    
    5.4.2
  - getPidDir
```
public File getPidDir()
```
    Returns:
    
    Pid directory (usually known as "run directory"); Returns log directory if not set by configuration.
    
    Since:
    
    5.4.2
  - setPidDir
```
public void setPidDir(String pidDirStr)
```
    Parameters:
    
    pidDirStr - Pid directory path to set
    
    Since:
    
    5.4.2
  - checkPaths
```
public void checkPaths()
                throws ConfigurationException
```
    Check server paths; warn if existing deprecated paths. Override this method to perform server specific checks.
    
    Throws:
    
    ConfigurationException - If deprecated paths have been detected
    
    Since:
    
    5.4.2
  - getTmpDir
```
public File getTmpDir()
```
    Returns:
    
    Temporary directory
    
    Since:
    
    5.4.2
  - getDefaultTmpDir
```
public String getDefaultTmpDir()
```
    Returns:
    
    Default temporary directory path relative to Nuxeo Home
    
    Since:
    
    5.4.2
  - setTmpDir
```
public void setTmpDir(String tmpDirStr)
```
    Parameters:
    
    tmpDirStr - Temporary directory path to set
    
    Since:
    
    5.4.2
  - setDirectory
```
public void setDirectory(String key,
                         String directory)
```
    Parameters:
    
    key - directory system key
    
    directory - absolute or relative directory path
    
    Since:
    
    5.4.2
    
    See Also:
    
    Environment
  - getDirectory
```
public File getDirectory(String key)
```
    Parameters:
    
    key - directory system key
    
    Returns:
    
    Directory denoted by key
    
    Since:
    
    5.4.2
    
    See Also:
    
    Environment
  - checkPath
```
protected void checkPath(File oldPath,
                         String message)
                  throws ConfigurationException
```
    Check if oldPath exist; if so, then raise a ConfigurationException with information for fixing issue
    
    Parameters:
    
    oldPath - Path that must NOT exist
    
    message - Error message thrown with exception
    
    Throws:
    
    ConfigurationException - If an old path has been discovered
  - getLogConfFile
```
public abstract File getLogConfFile()
```
    Returns:
    
    Log4J configuration file
    
    Since:
    
    5.4.2
  - getConfigDir
```
public abstract File getConfigDir()
```
    Returns:
    
    Nuxeo config directory
    
    Since:
    
    5.4.2
  - prepareWizardStart
```
public void prepareWizardStart()
```
    Since:
    
    5.4.2
  - cleanupPostWizard
```
public void cleanupPostWizard()
```
    Since:
    
    5.4.2
  - isWizardAvailable
```
public boolean isWizardAvailable()
```
    Override it to make the wizard available for a given server.
    
    Returns:
    
    true if configuration wizard is required before starting Nuxeo
    
    Since:
    
    5.4.2
    
    See Also:
    
    prepareWizardStart(), cleanupPostWizard()
  - dumpProperties
```
public void dumpProperties(CryptoProperties userConfig)
```
    Parameters:
    
    userConfig - Properties to dump into config directory
    
    Since:
    
    5.4.2
  - filterSystemProperties
```
public Properties filterSystemProperties(CryptoProperties properties)
```
    Extract Nuxeo properties from given Properties (System properties are removed, except those set by Nuxeo)
    
    Parameters:
    
    properties - Properties to be filtered
    
    Returns:
    
    copy of given properties filtered out of System properties
    
    Since:
    
    5.4.2
  - getNuxeoLibDir
```
public File getNuxeoLibDir()
```
    Returns:
    
    Nuxeo's third party libraries directory
    
    Since:
    
    5.4.1
  - getServerLibDir
```
public abstract File getServerLibDir()
```
    Returns:
    
    Server's third party libraries directory
    
    Since:
    
    5.4.1
  - verifyInstallation
```
public void verifyInstallation()
                        throws ConfigurationException
```
    Throws:
    
    ConfigurationException
    
    Since:
    
    5.7
  - checkNetwork
```
protected void checkNetwork()
                     throws ConfigurationException
```
    Perform server specific checks, not already done by ConfigurationGenerator.checkAddressesAndPorts()
    
    Throws:
    
    ConfigurationException
    
    Since:
    
    5.7
    
    See Also:
    
    ConfigurationGenerator.checkAddressesAndPorts()
  - addServerSpecificParameters
```
protected void addServerSpecificParameters(Map<String,String> parametersmigration)
```
    Override to add server specific parameters to the list of parameters to migrate
    
    Parameters:
    
    parametersmigration -
    
    Since:
    
    5.7
  - getPackagesDir
```
public File getPackagesDir()
```
    Returns:
    
    Marketplace Packages directory
    
    Since:
    
    5.9.4
  - getDefaultPackagesDir
```
public String getDefaultPackagesDir()
```
    Returns:
    
    Default MP directory path relative to Nuxeo Home
    
    Since:
    
    5.9.4

Class ServerConfigurator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

generator

dataDir

logDir

pidDir

libDir

tmpDir

packagesDir

NUXEO_SYSTEM_PROPERTIES

DEFAULT_CONTEXT_NAME

DEFAULT_LOG_DIR

DEFAULT_DATA_DIR

DEFAULT_TMP_DIR

Constructor Detail

ServerConfigurator

Method Detail

parseAndCopy

getOutputDirectory

getDefaultDataDir

getRuntimeHome

getDataDir

getLogDir

setDataDir

setLogDir

initLogs

getPidDir

setPidDir

checkPaths

getTmpDir

getDefaultTmpDir

setTmpDir

setDirectory

getDirectory

checkPath

getLogConfFile

getConfigDir

prepareWizardStart

cleanupPostWizard

isWizardAvailable

dumpProperties

filterSystemProperties

getNuxeoLibDir

getServerLibDir

verifyInstallation

checkNetwork

addServerSpecificParameters

getPackagesDir

getDefaultPackagesDir