org.nuxeo.launcher.config

Class TomcatConfigurator

java.lang.Object

org.nuxeo.launcher.config.ServerConfigurator

org.nuxeo.launcher.config.TomcatConfigurator

public class TomcatConfigurator
extends ServerConfigurator

Author:

jcarsique

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_HTTP_TOMCAT_ADMIN_PORT
static String	STARTUP_CLASS
static String	TOMCAT_CONFIG Deprecated. Use getTomcatConfig()
static String	TOMCAT_HOME

Fields inherited from class org.nuxeo.launcher.config.ServerConfigurator

dataDir, DEFAULT_CONTEXT_NAME, DEFAULT_DATA_DIR, DEFAULT_LOG_DIR, DEFAULT_TMP_DIR, generator, libDir, log, logDir, NUXEO_SYSTEM_PROPERTIES, packagesDir, pidDir, tmpDir

Constructor Summary

Constructors

Constructor and Description
TomcatConfigurator(ConfigurationGenerator configurationGenerator)

Method Summary

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()
void	checkPaths() Check server paths; warn if existing deprecated paths.
void	cleanupPostWizard()
File	getConfigDir()
String	getContextName()
protected String	getDefaultDataDir()
File	getLogConfFile()
File	getRuntimeHome() Returns the Home of NuxeoRuntime (same as Framework.getRuntime().getHome().getAbsolutePath())
File	getServerLibDir()
String	getTomcatConfig()
protected boolean	isConfigured()
boolean	isWizardAvailable() Override it to make the wizard available for a given server.
void	prepareWizardStart()

Methods inherited from class org.nuxeo.launcher.config.ServerConfigurator

checkPath, dumpProperties, filterSystemProperties, getDataDir, getDefaultPackagesDir, getDefaultTmpDir, getDirectory, getInfo, getLogDir, getNuxeoLibDir, getOutputDirectory, getPackagesDir, getPidDir, getTmpDir, initLogs, parseAndCopy, setDataDir, setDirectory, setLogDir, setPidDir, setTmpDir, verifyInstallation

Methods inherited from class java.lang.Object

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

Field Detail

TOMCAT_CONFIG

@Deprecated
public static final String TOMCAT_CONFIG

Deprecated. Use getTomcatConfig()

See Also:

Constant Field Values

STARTUP_CLASS

public static final String STARTUP_CLASS

Since:

5.4.2

See Also:

Constant Field Values

TOMCAT_HOME

public static final String TOMCAT_HOME

Since:

5.6

See Also:

Constant Field Values

PARAM_HTTP_TOMCAT_ADMIN_PORT

public static final String PARAM_HTTP_TOMCAT_ADMIN_PORT

Since:

5.7

See Also:

Constant Field Values

Constructor Detail

TomcatConfigurator

public TomcatConfigurator(ConfigurationGenerator configurationGenerator)

Method Detail

isConfigured

protected boolean isConfigured()

Returns:

true if getTomcatConfig() file already exists

getDefaultDataDir

protected String getDefaultDataDir()

Overrides:

getDefaultDataDir in class ServerConfigurator

Returns:

Default data directory path relative to Nuxeo Home

checkPaths

public void checkPaths()
                throws ConfigurationException

Description copied from class: ServerConfigurator

Check server paths; warn if existing deprecated paths. Override this method to perform server specific checks.

Overrides:

checkPaths in class ServerConfigurator

Throws:

ConfigurationException - If deprecated paths have been detected

getLogConfFile

public File getLogConfFile()

Specified by:

getLogConfFile in class ServerConfigurator

Returns:

Log4J configuration file

getConfigDir

public File getConfigDir()

Specified by:

getConfigDir in class ServerConfigurator

Returns:

Nuxeo config directory

getTomcatConfig

public String getTomcatConfig()

Returns:

Path to Tomcat configuration of Nuxeo context

Since:

5.4.2

getContextName

public String getContextName()

Returns:

Configured context name

Since:

5.4.2

prepareWizardStart

public void prepareWizardStart()

Overrides:

prepareWizardStart in class ServerConfigurator

cleanupPostWizard

public void cleanupPostWizard()

Overrides:

cleanupPostWizard in class ServerConfigurator

isWizardAvailable

public boolean isWizardAvailable()

Description copied from class: ServerConfigurator

Override it to make the wizard available for a given server.

Overrides:

isWizardAvailable in class ServerConfigurator

Returns:

true if configuration wizard is required before starting Nuxeo

See Also:

ServerConfigurator.prepareWizardStart(), ServerConfigurator.cleanupPostWizard()

getRuntimeHome

public File getRuntimeHome()

Description copied from class: ServerConfigurator

Returns the Home of NuxeoRuntime (same as Framework.getRuntime().getHome().getAbsolutePath())

Specified by:

getRuntimeHome in class ServerConfigurator

getServerLibDir

public File getServerLibDir()

Specified by:

getServerLibDir in class ServerConfigurator

Returns:

Server's third party libraries directory

checkNetwork

protected void checkNetwork()
                     throws ConfigurationException

Description copied from class: ServerConfigurator

Perform server specific checks, not already done by ConfigurationGenerator.checkAddressesAndPorts()

Overrides:

checkNetwork in class ServerConfigurator

Throws:

ConfigurationException

See Also:

ConfigurationGenerator.checkAddressesAndPorts()

addServerSpecificParameters

protected void addServerSpecificParameters(Map<String,String> parametersmigration)

Description copied from class: ServerConfigurator

Override to add server specific parameters to the list of parameters to migrate

Overrides:

addServerSpecificParameters in class ServerConfigurator