org.nuxeo.launcher.config

Class ServerConfigurator

java.lang.Object

org.nuxeo.launcher.config.ServerConfigurator

Direct Known Subclasses:

JBossConfigurator, JettyConfigurator, TomcatConfigurator

public abstract class ServerConfigurator
extends Object

Author:

jcarsique

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	NUXEO_SYSTEM_PROPERTIES

Constructor Summary

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.
abstract 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()
abstract String	getDefaultTmpDir()
File	getDirectory(String key)
abstract File	getLogConfFile()
File	getLogDir()
File	getNuxeoLibDir()
File	getPidDir()
abstract File	getServerLibDir()
File	getTmpDir()
void	initLogs() Initialize logs
abstract boolean	isWizardAvailable()
abstract 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)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NUXEO_SYSTEM_PROPERTIES

public static final String[] NUXEO_SYSTEM_PROPERTIES

Since:

5.4.2

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

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 abstract 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 abstract void prepareWizardStart()

Since:

5.4.2

cleanupPostWizard

public abstract void cleanupPostWizard()

Since:

5.4.2

isWizardAvailable

public abstract boolean isWizardAvailable()

Returns:

true if configuration wizard is required before starting Nuxeo

Since:

5.4.2

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