Package org.codehaus.cargo.ant

Class ConfigurationElement

java.lang.Object

org.codehaus.cargo.ant.ConfigurationElement

public class ConfigurationElement
extends Object

Nested Ant element to wrap the DefaultConfigurationFactory class.

Constructor Summary

Constructors

Constructor	Description
ConfigurationElement()

Method Summary

Modifier and Type	Method	Description
void	addConfiguredConfigfile(FileConfig configfileElement)
void	addConfiguredDataSource(DataSourceElement dataSourceElement)
void	addConfiguredDeployable(DeployableElement deployableElement)
void	addConfiguredFile(FileConfig fileConfigElement)
void	addConfiguredProperty(Property property)	Add a container property.
void	addConfiguredUser(UserElement userElement)
void	addConfiguredXmlreplacement(XmlReplacement xmlReplacement)
Configuration	createConfiguration(String containerId, ContainerType containerType, org.apache.tools.ant.Project antProject, Logger log)
protected Class	getConfigurationClass()
List<DataSourceElement>	getDataSources()
protected List<DeployableElement>	getDeployables()
protected List<FileConfig>	getFileConfigs()	Get the list of configFiles
protected List<FileConfig>	getFiles()	Get the list of files
String	getHome()
protected List<Property>	getProperties()
File	getPropertiesFile()
ConfigurationType	getType()
protected List<UserElement>	getUsers()
protected List<XmlReplacement>	getXmlReplacements()
void	setClass(Class configurationClass)
void	setHome(String home)
void	setPropertiesFile(File propertiesFile)
void	setType(String typeAsString)	Defaults to the standalone configuration if type is not specified by the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationElement

public ConfigurationElement()

Method Detail

setClass

public void setClass(Class configurationClass)

Parameters:

configurationClass - the configuration class to associate to the containing container

getConfigurationClass

protected Class getConfigurationClass()

Returns:

the configuration class associated with the containing container

addConfiguredDeployable

public void addConfiguredDeployable(DeployableElement deployableElement)

Parameters:

deployableElement - the nested deployable element to deploy

getDeployables

protected List<DeployableElement> getDeployables()

Returns:

the nested deployable elements to deploy

addConfiguredConfigfile

public void addConfiguredConfigfile(FileConfig configfileElement)

Parameters:

configfileElement - the nested config element to deploy

getFileConfigs

protected List<FileConfig> getFileConfigs()

Get the list of configFiles

Returns:

the configFiles

addConfiguredFile

public void addConfiguredFile(FileConfig fileConfigElement)

Parameters:

fileConfigElement - the nested file element to deploy

getFiles

protected List<FileConfig> getFiles()

Get the list of files

Returns:

the files

addConfiguredProperty

public void addConfiguredProperty(Property property)

Add a container property.

Parameters:

property - the container property to add

getProperties

protected List<Property> getProperties()

Returns:

the list of container properties

getPropertiesFile

public File getPropertiesFile()

Returns:

Container properties loaded from file.

setPropertiesFile

public void setPropertiesFile(File propertiesFile)

Parameters:

propertiesFile - Container properties loaded from file.

addConfiguredXmlreplacement

public void addConfiguredXmlreplacement(XmlReplacement xmlReplacement)

Parameters:

xmlReplacement - the list of XML replacements

getXmlReplacements

protected List<XmlReplacement> getXmlReplacements()

Returns:

the list of XML replacements

addConfiguredDataSource

public void addConfiguredDataSource(DataSourceElement dataSourceElement)

Parameters:

dataSourceElement - the nested datasource element

getDataSources

public List<DataSourceElement> getDataSources()

Returns:

the nested datasource elements

addConfiguredUser

public void addConfiguredUser(UserElement userElement)

Parameters:

userElement - the nested user element

getUsers

protected List<UserElement> getUsers()

Returns:

the nested user elements

setType

public void setType(String typeAsString)

Defaults to the standalone configuration if type is not specified by the user.

Parameters:

typeAsString - the configuration type as a string

See Also:

ConfigurationFactory

getType

public ConfigurationType getType()

Returns:

the configuration type

setHome

public void setHome(String home)

Parameters:

home - the home directory to set

getHome

public String getHome()

Returns:

the home directory

createConfiguration

public Configuration createConfiguration(String containerId,
                                         ContainerType containerType,
                                         org.apache.tools.ant.Project antProject,
                                         Logger log)

Parameters:

containerId - the container id associated with this configuration

containerType - the container type associated with this configuration

antProject - the Ant project

log - the logger

Returns:

a configuration instance matching this container and the defined type