org.codehaus.cargo.container.configuration
Interface LocalConfiguration

All Superinterfaces:
Configuration, Loggable
All Known Subinterfaces:
ExistingLocalConfiguration, StandaloneLocalConfiguration
All Known Implementing Classes:
AbstractExistingLocalConfiguration, AbstractLocalConfiguration, AbstractStandaloneLocalConfiguration, AbstractStandaloneLocalConfigurationWithXMLConfigurationBuilder

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.

Version:
$Id: LocalConfiguration.java 1886 2009-02-13 15:23:09Z adriancole $

Method Summary
 void addDeployable(Deployable deployable)
          Deploy a Deployable in the container.
 void addResource(Resource resource)
          Add resources the container can take advantage of.
 void configure(LocalContainer container)
          Setup the container which means setting up a valid directory structure, setting up configuration files and deploying static deployables.
 java.util.List getDeployables()
           
 FileHandler getFileHandler()
           
 java.lang.String getHome()
           
 java.util.List getResources()
           
 void setFileHandler(FileHandler handler)
           
 
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

java.lang.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.

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

java.util.List getDeployables()
Returns:
the list of Deployables that are going to be deployed in the container when it is started

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

addResource

void addResource(Resource resource)
Add resources the container can take advantage of. I.e. datasources.

Parameters:
resource - the Resource to add.

getResources

java.util.List getResources()
Returns:
the list of Resources that are going to be added to the container when it is started.

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.


Copyright © 2004-2011 Codehaus. All Rights Reserved.