Package org.codehaus.cargo.container.tomcat.internal

Class AbstractCatalinaStandaloneLocalConfiguration

java.lang.Object

org.codehaus.cargo.util.log.LoggedObject

org.codehaus.cargo.container.spi.configuration.AbstractConfiguration

org.codehaus.cargo.container.spi.configuration.AbstractLocalConfiguration

org.codehaus.cargo.container.spi.configuration.AbstractStandaloneLocalConfiguration

org.codehaus.cargo.container.spi.configuration.builder.AbstractStandaloneLocalConfigurationWithXMLConfigurationBuilder

org.codehaus.cargo.container.tomcat.internal.AbstractCatalinaStandaloneLocalConfiguration

All Implemented Interfaces:

Configuration, DataSourceSupport, ResourceSupport, LocalConfiguration, StandaloneLocalConfiguration, ContainerConfiguration, Loggable

Direct Known Subclasses:

Tomcat4xStandaloneLocalConfiguration, Tomcat5xStandaloneLocalConfiguration

public abstract class AbstractCatalinaStandaloneLocalConfiguration
extends AbstractStandaloneLocalConfigurationWithXMLConfigurationBuilder

Catalina standalone ContainerConfiguration implementation.

Field Summary

Fields inherited from class org.codehaus.cargo.container.spi.configuration.AbstractLocalConfiguration

RESOURCE_PATH

Constructor Summary

Constructors

Constructor	Description
AbstractCatalinaStandaloneLocalConfiguration(String dir)

Method Summary

Modifier and Type	Method	Description
protected String	connectorXpath()	XPath expression for identifying the "Connector" element in the server.xml file.
protected String	createContextToken(WAR deployable)
protected TomcatCopyingInstalledLocalDeployer	createDeployer(LocalContainer container)	Creates the Tomcat deployer.
protected String	createTomcatWebappsToken()	Create the Tomcat <webapp> token.
protected void	doConfigure(LocalContainer container)	Implementation of LocalConfiguration.configure(LocalContainer) that all local configuration using this class must implement.
protected String	escapePath(String path)	Escapes a Windows path: backslashes become slashes, drive paths get prefixed with a slash.
protected Map<String,String>	getNamespaces()	Implementations should avoid passing null, and instead pass Collections.emptyMap(), if the document is DTD bound.
String	getOrCreateDataSourceConfigurationFile(DataSource ds, LocalContainer container)	note that this file could hold other configuration besides datasources.
protected String	getSecurityToken()
protected String	getTomcatLoggingLevel(String cargoLoggingLevel)	Translate Cargo logging levels into Tomcat logging levels.
protected String	getXpathForDataSourcesParent()	Resource entries must be stored in the xml configuration file.
void	setProperty(String name, String value)	A property is a configuration value for the container (eg the web port, the number of executing threads, etc).
protected abstract void	setupConfFiles(String confDir)	setup the files in the configuration's conf directory.
protected abstract void	setupManager(LocalContainer container)	Setup the manager webapp.
protected void	setupWebApps(LocalContainer container)	Setup the web apps directory and deploy applications.
String	toString()

Methods inherited from class org.codehaus.cargo.container.spi.configuration.builder.AbstractStandaloneLocalConfigurationWithXMLConfigurationBuilder

configure, configure, configure, configureDataSources, configureResources, createConfigurationBuilder, getOrCreateResourceConfigurationFile, getXpathForResourcesParent, writeConfigurationToXpath

Methods inherited from class org.codehaus.cargo.container.spi.configuration.AbstractStandaloneLocalConfiguration

addXmlReplacement, addXmlReplacement, addXmlReplacement, addXmlReplacement, configureFiles, getType, getXmlReplacements, performXmlReplacements, removeXmlReplacement, removeXmlReplacement, replaceInFile, setupConfigurationDir, verify

Methods inherited from class org.codehaus.cargo.container.spi.configuration.AbstractLocalConfiguration

addDataSource, addDataSourcesFromProperties, addDeployable, addResource, addResourcesFromProperties, addUser, addUsersFromProperties, applyPortOffset, applyPortOffset, collectUnsupportedDataSourcesAndThrowException, collectUnsupportedResourcesAndThrowException, flagOffsetApplied, getDataSources, getDeployables, getDestDirectoryLocation, getDestFileLocation, getFileHandler, getFileProperties, getHome, getPropertyValue, getReplacements, getResources, getResourceUtils, getUsers, isOffsetApplied, isOffsetApplied, parsePropertiesForPendingConfiguration, revertPortOffset, revertPortOffset, setConfigFileProperty, setFileHandler, setFileProperty, setLogger

Methods inherited from class org.codehaus.cargo.container.spi.configuration.AbstractConfiguration

getProperties

Methods inherited from class org.codehaus.cargo.util.log.LoggedObject

getLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.codehaus.cargo.container.configuration.Configuration

getCapability, getProperties, getPropertyValue

Methods inherited from interface org.codehaus.cargo.container.configuration.LocalConfiguration

addDataSource, addDeployable, addResource, addUser, applyPortOffset, getDataSources, getDeployables, getFileHandler, getFileProperties, getHome, getResources, getUsers, isOffsetApplied, revertPortOffset, setConfigFileProperty, setFileHandler, setFileProperty

Methods inherited from interface org.codehaus.cargo.util.log.Loggable

getLogger, setLogger

Constructor Detail

AbstractCatalinaStandaloneLocalConfiguration

public AbstractCatalinaStandaloneLocalConfiguration(String dir)

See Also:

AbstractStandaloneLocalConfigurationWithXMLConfigurationBuilder(String)

Method Detail

setProperty

public void setProperty(String name,
                        String value)

A property is a configuration value for the container (eg the web port, the number of executing threads, etc).

Specified by:

setProperty in interface Configuration

Overrides:

setProperty in class AbstractConfiguration

Parameters:

name - the property name

value - the property value

doConfigure

protected void doConfigure(LocalContainer container)
                    throws Exception

Implementation of LocalConfiguration.configure(LocalContainer) that all local configuration using this class must implement. This provides the ability to perform generic actions before and after the container-specific implementation. Another way would be to use AOP...

Specified by:

doConfigure in class AbstractLocalConfiguration

Parameters:

container - the container to configure

Throws:

Exception - if any error is raised during the configuration

escapePath

protected String escapePath(String path)

Escapes a Windows path: backslashes become slashes, drive paths get prefixed with a slash.

Parameters:

path - Path to escape.

Returns:

Escaped path.

setupManager

protected abstract void setupManager(LocalContainer container)

Setup the manager webapp.

Parameters:

container - the container to configure

setupWebApps

protected void setupWebApps(LocalContainer container)

Setup the web apps directory and deploy applications.

Parameters:

container - the container to configure

getTomcatLoggingLevel

protected String getTomcatLoggingLevel(String cargoLoggingLevel)

Translate Cargo logging levels into Tomcat logging levels.

Parameters:

cargoLoggingLevel - Cargo logging level

Returns:

the corresponding Tomcat logging level

createTomcatWebappsToken

protected String createTomcatWebappsToken()

Create the Tomcat <webapp> token.

Returns:

The Tomcat <webapp> token.

createContextToken

protected String createContextToken(WAR deployable)

Parameters:

deployable - the WAR to deploy

Returns:

the "context" XML element to instert in the Tomcat server.xml configuration file

toString

public String toString()

Overrides:

toString in class Object

getSecurityToken

protected String getSecurityToken()

Returns:

an Ant filter token containing all the user-defined users

setupConfFiles

protected abstract void setupConfFiles(String confDir)

setup the files in the configuration's conf directory.

Parameters:

confDir - - the conf directory.

getXpathForDataSourcesParent

protected String getXpathForDataSourcesParent()

Resource entries must be stored in the xml configuration file. Under which element do we insert the entries? example: //Engine/DefaultContext

Specified by:

getXpathForDataSourcesParent in class AbstractStandaloneLocalConfigurationWithXMLConfigurationBuilder

Returns:

path the the parent element resources should be inserted under.

getOrCreateDataSourceConfigurationFile

public String getOrCreateDataSourceConfigurationFile(DataSource ds,
                                                     LocalContainer container)

note that this file could hold other configuration besides datasources.

Specified by:

getOrCreateDataSourceConfigurationFile in class AbstractStandaloneLocalConfigurationWithXMLConfigurationBuilder

Parameters:

ds - the DataSource configuration you wish to install on the container.

container - the container whose configuration you wish to affect.

Returns:

the file that holds datasource configuration.

getNamespaces

protected Map<String,String> getNamespaces()

Implementations should avoid passing null, and instead pass Collections.emptyMap(), if the document is DTD bound.

Specified by:

getNamespaces in class AbstractStandaloneLocalConfigurationWithXMLConfigurationBuilder

Returns:

a map of prefixes to the url namespaces used in the datasource or resource configuration file.

createDeployer

protected TomcatCopyingInstalledLocalDeployer createDeployer(LocalContainer container)

Creates the Tomcat deployer.

Parameters:

container - Container to create a deployer for.

Returns:

Tomcat deployer.

connectorXpath

protected String connectorXpath()

XPath expression for identifying the "Connector" element in the server.xml file.

Handles the fact that this connector protocol value might have changed.

Returns:

the xpath expression for a http connector