Package org.codehaus.cargo.container.configuration

Interface LocalConfiguration

All Superinterfaces:

Configuration, Loggable

All Known Subinterfaces:

ExistingLocalConfiguration, StandaloneLocalConfiguration

All Known Implementing Classes:

AbstractCatalinaStandaloneLocalConfiguration, AbstractExistingLocalConfiguration, AbstractGeronimoStandaloneLocalConfiguration, AbstractGlassFishStandaloneLocalConfiguration, AbstractJBoss5xStandaloneLocalConfiguration, AbstractJettyEmbeddedStandaloneLocalConfiguration, AbstractJettyExistingLocalConfiguration, AbstractJettyStandaloneLocalConfiguration, AbstractJonasExistingLocalConfiguration, AbstractJonasStandaloneLocalConfiguration, AbstractLocalConfiguration, AbstractOrionStandaloneLocalConfiguration, AbstractResinStandaloneLocalConfiguration, AbstractStandaloneLocalConfiguration, AbstractStandaloneLocalConfigurationWithXMLConfigurationBuilder, AbstractWebLogicWlstExistingLocalConfiguration, AbstractWebLogicWlstStandaloneLocalConfiguration, AbstractWildFlyStandaloneLocalConfiguration, Geronimo1xStandaloneLocalConfiguration, Geronimo2xStandaloneLocalConfiguration, Geronimo3xStandaloneLocalConfiguration, GeronimoExistingLocalConfiguration, GlassFish2xStandaloneLocalConfiguration, GlassFish3xStandaloneLocalConfiguration, GlassFish4xStandaloneLocalConfiguration, GlassFish5xStandaloneLocalConfiguration, GlassFish6xStandaloneLocalConfiguration, GlassFish7xStandaloneLocalConfiguration, GlassFish8xStandaloneLocalConfiguration, GlassFishExistingLocalConfiguration, JBoss3x4xExistingLocalConfiguration, JBoss3x4xStandaloneLocalConfiguration, JBoss42xExistingLocalConfiguration, JBoss42xStandaloneLocalConfiguration, JBoss51xStandaloneLocalConfiguration, JBoss5xExistingLocalConfiguration, JBoss5xStandaloneLocalConfiguration, JBoss6xExistingLocalConfiguration, JBoss6xStandaloneLocalConfiguration, JBoss71xExistingLocalConfiguration, JBoss71xStandaloneLocalConfiguration, JBoss72xExistingLocalConfiguration, JBoss72xStandaloneLocalConfiguration, JBoss73xStandaloneLocalConfiguration, JBoss75xStandaloneLocalConfiguration, JBoss7xExistingLocalConfiguration, JBoss7xStandaloneLocalConfiguration, Jetty10xEmbeddedStandaloneLocalConfiguration, Jetty10xExistingLocalConfiguration, Jetty10xStandaloneLocalConfiguration, Jetty11xEmbeddedStandaloneLocalConfiguration, Jetty11xExistingLocalConfiguration, Jetty11xStandaloneLocalConfiguration, Jetty12xEmbeddedStandaloneLocalConfiguration, Jetty12xExistingLocalConfiguration, Jetty12xStandaloneLocalConfiguration, Jetty5xEmbeddedStandaloneLocalConfiguration, Jetty6xEmbeddedStandaloneLocalConfiguration, Jetty6xExistingLocalConfiguration, Jetty6xStandaloneLocalConfiguration, Jetty7xEmbeddedStandaloneLocalConfiguration, Jetty7xExistingLocalConfiguration, Jetty7xStandaloneLocalConfiguration, Jetty8xEmbeddedStandaloneLocalConfiguration, Jetty8xExistingLocalConfiguration, Jetty8xStandaloneLocalConfiguration, Jetty9xEmbeddedStandaloneLocalConfiguration, Jetty9xExistingLocalConfiguration, Jetty9xStandaloneLocalConfiguration, Jo1xStandaloneLocalConfiguration, Jonas4xExistingLocalConfiguration, Jonas4xStandaloneLocalConfiguration, Jonas5xExistingLocalConfiguration, Jonas5xStandaloneLocalConfiguration, JRun4xExistingLocalConfiguration, JRun4xStandaloneLocalConfiguration, LibertyStandaloneLocalConfiguration, Oc4j10xExistingLocalConfiguration, Oc4j9xStandaloneLocalConfiguration, PayaraExistingLocalConfiguration, PayaraStandaloneLocalConfiguration, Resin31xStandaloneLocalConfiguration, Resin3xExistingLocalConfiguration, Resin3xStandaloneLocalConfiguration, Resin4xStandaloneLocalConfiguration, Tomcat10xStandaloneLocalConfiguration, Tomcat11xStandaloneLocalConfiguration, Tomcat4xStandaloneLocalConfiguration, Tomcat5xStandaloneLocalConfiguration, Tomcat6xStandaloneLocalConfiguration, Tomcat7xStandaloneLocalConfiguration, Tomcat8xStandaloneLocalConfiguration, Tomcat9xStandaloneLocalConfiguration, TomcatExistingLocalConfiguration, Tomee10xStandaloneLocalConfiguration, Tomee1xStandaloneLocalConfiguration, Tomee7xStandaloneLocalConfiguration, Tomee8xStandaloneLocalConfiguration, Tomee9xStandaloneLocalConfiguration, TomeeExistingLocalConfiguration, WebLogic103xStandaloneLocalConfiguration, WebLogic10xStandaloneLocalConfiguration, WebLogic121xExistingLocalConfiguration, WebLogic121xStandaloneLocalConfiguration, WebLogic122xExistingLocalConfiguration, WebLogic122xStandaloneLocalConfiguration, WebLogic12xStandaloneLocalConfiguration, WebLogic14xExistingLocalConfiguration, WebLogic14xStandaloneLocalConfiguration, WebLogic8xExistingLocalConfiguration, WebLogic8xStandaloneLocalConfiguration, WebLogic9x10x12x14xExistingLocalConfiguration, WebLogic9xStandaloneLocalConfiguration, WebSphere85xExistingLocalConfiguration, WebSphere85xStandaloneLocalConfiguration, WebSphere9xExistingLocalConfiguration, WebSphere9xStandaloneLocalConfiguration, WildFly10xExistingLocalConfiguration, WildFly10xStandaloneLocalConfiguration, WildFly11xExistingLocalConfiguration, WildFly11xStandaloneLocalConfiguration, WildFly12xExistingLocalConfiguration, WildFly12xStandaloneLocalConfiguration, WildFly13xExistingLocalConfiguration, WildFly13xStandaloneLocalConfiguration, WildFly14xExistingLocalConfiguration, WildFly14xStandaloneLocalConfiguration, WildFly15xExistingLocalConfiguration, WildFly15xStandaloneLocalConfiguration, WildFly16xExistingLocalConfiguration, WildFly16xStandaloneLocalConfiguration, WildFly17xExistingLocalConfiguration, WildFly17xStandaloneLocalConfiguration, WildFly18xExistingLocalConfiguration, WildFly18xStandaloneLocalConfiguration, WildFly19xExistingLocalConfiguration, WildFly19xStandaloneLocalConfiguration, WildFly20xExistingLocalConfiguration, WildFly20xStandaloneLocalConfiguration, WildFly21xExistingLocalConfiguration, WildFly21xStandaloneLocalConfiguration, WildFly22xExistingLocalConfiguration, WildFly22xStandaloneLocalConfiguration, WildFly23xExistingLocalConfiguration, WildFly23xStandaloneLocalConfiguration, WildFly24xExistingLocalConfiguration, WildFly24xStandaloneLocalConfiguration, WildFly25xExistingLocalConfiguration, WildFly25xStandaloneLocalConfiguration, WildFly26xExistingLocalConfiguration, WildFly26xStandaloneLocalConfiguration, WildFly27xExistingLocalConfiguration, WildFly27xStandaloneLocalConfiguration, WildFly28xExistingLocalConfiguration, WildFly28xStandaloneLocalConfiguration, WildFly29xExistingLocalConfiguration, WildFly29xStandaloneLocalConfiguration, WildFly30xExistingLocalConfiguration, WildFly30xStandaloneLocalConfiguration, WildFly31xExistingLocalConfiguration, WildFly31xStandaloneLocalConfiguration, WildFly32xExistingLocalConfiguration, WildFly32xStandaloneLocalConfiguration, WildFly33xExistingLocalConfiguration, WildFly33xStandaloneLocalConfiguration, WildFly34xExistingLocalConfiguration, WildFly34xStandaloneLocalConfiguration, WildFly35xExistingLocalConfiguration, WildFly35xStandaloneLocalConfiguration, WildFly36xExistingLocalConfiguration, WildFly36xStandaloneLocalConfiguration, WildFly37xExistingLocalConfiguration, WildFly37xStandaloneLocalConfiguration, WildFly38xExistingLocalConfiguration, WildFly38xStandaloneLocalConfiguration, WildFly8xExistingLocalConfiguration, WildFly8xStandaloneLocalConfiguration, WildFly9xExistingLocalConfiguration, WildFly9xStandaloneLocalConfiguration, WildFlySwarmStandaloneLocalConfiguration

public interface LocalConfiguration
extends Configuration

A local configuration represents a container configuration located somewhere on the local file system. A local configuration is activated before the container is started. In addition, a local configuration allows you to deploy Deployables before the container is started.

Method Summary

Modifier and Type	Method	Description
void	addDataSource(DataSource dataSource)	Add data source the container can take advantage of.
void	addDeployable(Deployable deployable)	Deploy a Deployable in the container.
void	addResource(Resource resource)	Add resources the container can take advantage of.
void	addUser(User user)	Add user to container.
void	applyPortOffset()	Apply the port offset to the configuration port properties.
void	configure(LocalContainer container)	Setup the container which means setting up a valid directory structure, setting up configuration files and deploying static deployables.
List<DataSource>	getDataSources()
List<Deployable>	getDeployables()
FileHandler	getFileHandler()
List<FileConfig>	getFileProperties()	Returns the file configurations.
String	getHome()
Map<String,String>	getReplacements()	Returns (while, if necessary, creating) the default filter chain that should be applied while copying container configuration files to the working directory from which the container is started.
List<Resource>	getResources()
List<User>	getUsers()
boolean	isOffsetApplied()	Checks whether the offset is already applied or not.
void	revertPortOffset()	Revert the port offset on the configuration port properties.
void	setConfigFileProperty(FileConfig fileConfig)	set the config file property for a configuration.
void	setFileHandler(FileHandler handler)
void	setFileProperty(FileConfig fileConfig)	set the file property for a configuration.

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

getCapability, getProperties, getPropertyValue, getType, setProperty

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

getLogger, setLogger

Method Detail

getHome

String getHome()

Returns:

the configuration home directory. Note that we're returning a String instead of a File because we want to leave the possibility of using URIs for specifying the home location.

setFileHandler

void setFileHandler(FileHandler handler)

Parameters:

handler - means by which we affect local files.

getFileHandler

FileHandler getFileHandler()

Returns:

the means by which we affect local files.

setConfigFileProperty

void setConfigFileProperty(FileConfig fileConfig)

set the config file property for a configuration.

Parameters:

fileConfig - The FileConfig to use

setFileProperty

void setFileProperty(FileConfig fileConfig)

set the file property for a configuration.

Parameters:

fileConfig - The FileConfig to use

getFileProperties

List<FileConfig> getFileProperties()

Returns the file configurations.

Returns:

The configuration file properies

getReplacements

Map<String,String> getReplacements()

Returns (while, if necessary, creating) the default filter chain that should be applied while copying container configuration files to the working directory from which the container is started.

Returns:

The default filter chain

addDeployable

void addDeployable(Deployable deployable)

Deploy a Deployable in the container. It installs the Deployable in the container's configuration directory.

Parameters:

deployable - the Deployable to deploy

getDeployables

List<Deployable> getDeployables()

Returns:

the list of Deployables that are going to be deployed in the container when it is started

addResource

void addResource(Resource resource)

Add resources the container can take advantage of. I.e. datasources.

Parameters:

resource - the Resource to add.

getResources

List<Resource> getResources()

Returns:

the list of Resources that are going to be added to the container when it is started.

addUser

void addUser(User user)

Add user to container.

Parameters:

user - the User to add.

getUsers

List<User> getUsers()

Returns:

the list of Users that are going to be added to the container.

addDataSource

void addDataSource(DataSource dataSource)

Add data source the container can take advantage of.

Parameters:

dataSource - the DataSource to add.

getDataSources

List<DataSource> getDataSources()

Returns:

the configured DataSources for this container.

applyPortOffset

void applyPortOffset()

Apply the port offset to the configuration port properties.

revertPortOffset

void revertPortOffset()

Revert the port offset on the configuration port properties.

isOffsetApplied

boolean isOffsetApplied()

Checks whether the offset is already applied or not.

Returns:

true if the offset is already applied

configure

void configure(LocalContainer container)

Setup the container which means setting up a valid directory structure, setting up configuration files and deploying static deployables.

Parameters:

container - the container to configure