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
implements ResourceSupport

Catalina standalone ContainerConfiguration implementation.

Version:

$Id: AbstractCatalinaStandaloneLocalConfiguration.java 3401 2012-09-05 16:56:50Z alitokmen $

Field Summary

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

RESOURCE_PATH

Constructor Summary

Constructors

Constructor and Description
AbstractCatalinaStandaloneLocalConfiguration(String dir)

Method Summary

Methods

Modifier and Type	Method and Description
void	configureDataSources(LocalContainer container) Configure the DataSources defined for this configuration.
protected String	createContextToken(WAR deployable)
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.
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 abstract void	setupTransactionManager() Adds an implementation of UserTransaction to the configuration.
String	toString()

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

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

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

addXmlReplacement, addXmlReplacement, configureFiles, createFilterChain, getDestDirectoryLocation, getDestFileLocation, getFileProperties, getFilterChain, getType, performXmlReplacements, removeXmlReplacement, removeXmlReplacement, replaceInFile, setConfigFileProperty, setFileProperty, setupConfigurationDir, verify

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

addDataSource, addDataSourcesFromProperties, addDeployable, addResource, addResourcesFromProperties, applyPortOffset, applyPortOffset, collectUnsupportedDataSourcesAndThrowException, collectUnsupportedResourcesAndThrowException, getAntUtils, getDataSources, getDeployables, getFileHandler, getHome, getResources, getResourceUtils, parsePropertiesForPendingConfiguration, revertPortOffset, revertPortOffset, setFileHandler, setLogger

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

getProperties, getPropertyValue, setProperty

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.entry.ResourceSupport

configure, configureResources

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

addDataSource, addDeployable, addResource, applyPortOffset, getDataSources, getDeployables, getFileHandler, getHome, getResources, revertPortOffset, setFileHandler

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

getCapability, getProperties, getPropertyValue, setProperty

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

getLogger, setLogger

Constructor Detail

AbstractCatalinaStandaloneLocalConfiguration

public AbstractCatalinaStandaloneLocalConfiguration(String dir)

See Also:

AbstractStandaloneLocalConfigurationWithXMLConfigurationBuilder#AbstractStandaloneLocalConfigurationWithDataSourceSupport(String)

Method Detail

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

See Also:

AbstractLocalConfiguration.configure(LocalContainer)

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.

configureDataSources

public void configureDataSources(LocalContainer container)

Configure the DataSources defined for this configuration. note that if there is any datasource configured, this will imply an addition of the transaction manager.

Specified by:

configureDataSources in interface DataSourceSupport

Overrides:

configureDataSources in class AbstractStandaloneLocalConfigurationWithXMLConfigurationBuilder

Parameters:

container - the container whose configuration you wish to affect.

See Also:

setupTransactionManager()

setupTransactionManager

protected abstract void setupTransactionManager()

Adds an implementation of UserTransaction to the configuration.

setupManager

protected abstract void setupManager(LocalContainer container)

Setup the manager webapp.

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

See Also:

Object.toString()

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.