ServerConfigurator (Nuxeo ECM Projects 7.2 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
`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.
`static List<String>`	`NUXEO_SYSTEM_PROPERTIES`

Constructor Summary

Constructors
Constructor and Description

ServerConfigurator(ConfigurationGenerator configurationGenerator)

Constructors
Constructor and Description
`ServerConfigurator(ConfigurationGenerator configurationGenerator)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkPaths()` Check server paths; warn if existing deprecated paths.
`void`	`cleanupPostWizard()`
`void`	`dumpProperties(Properties userConfig)`
`Properties`	`filterSystemProperties(Properties properties)` Extract Nuxeo properties from given Properties (System properties are removed, except those set by Nuxeo)
`abstract File`	`getConfigDir()`
`File`	`getDataDir()`
`String`	`getDefaultPackagesDir()`
`String`	`getDefaultTmpDir()`
`File`	`getDirectory(String key)`
`abstract File`	`getLogConfFile()`
`File`	`getLogDir()`
`File`	`getNuxeoLibDir()`
`File`	`getPackagesDir()`
`File`	`getPidDir()`
`abstract File`	`getServerLibDir()`
`File`	`getTmpDir()`
`void`	`initLogs()` Initialize logs.
`boolean`	`isWizardAvailable()` Override it to make the wizard available for a given server.
`void`	`prepareWizardStart()`
`void`	`removeExistingLocks()` Remove locks on file system (dedicated to Lucene locks)
`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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NUXEO_SYSTEM_PROPERTIES
```
public static final List<String> NUXEO_SYSTEM_PROPERTIES
```
    Since:
    
    5.4.2
  - 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
  - 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
  - getLogConfFile
```
public abstract File getLogConfFile()
```
    Returns:
    Log4J configuration file
    Since:
    
    5.4.2
  - removeExistingLocks
```
public void removeExistingLocks()
```
    Remove locks on file system (dedicated to Lucene locks)
    
    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(Properties userConfig)
```
    Parameters:
    userConfig - Properties to dump into config directory
    Since:
    
    5.4.2
  - filterSystemProperties
```
public Properties filterSystemProperties(Properties 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
  - 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

NUXEO_SYSTEM_PROPERTIES

DEFAULT_LOG_DIR

DEFAULT_DATA_DIR

DEFAULT_TMP_DIR

Constructor Detail

ServerConfigurator

Method Detail

getDataDir

getLogDir

setDataDir

setLogDir

initLogs

getPidDir

setPidDir

checkPaths

getTmpDir

getDefaultTmpDir

setTmpDir

setDirectory

getDirectory

getLogConfFile

removeExistingLocks

getConfigDir

prepareWizardStart

cleanupPostWizard

isWizardAvailable

dumpProperties

filterSystemProperties

getNuxeoLibDir

getServerLibDir

verifyInstallation

getPackagesDir

getDefaultPackagesDir