AbstractInstalledContainerUtil (Integration test utility project 1.5.0-M2 API)

java.lang.Object
- nl.tranquilizedquality.itest.cargo.AbstractInstalledContainerUtil

All Implemented Interfaces:

ContainerUtil

Direct Known Subclasses:

AbstractGlassfishContainerUtil, AbstractJBossContainerUtil, AbstractJettyContainerUtil, AbstractJOnasContainerUtil, AbstractTomcatContainerUtil
```
public abstract class AbstractInstalledContainerUtil
extends Object
implements ContainerUtil
```
Base container class where every container should extend from. It contains all the basic stuff which every container utility should have like cleaning up the container before doing a fresh run.

Since:

23 apr 2009

Author:

Salomo Petrus (sape)

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`cargoLogFilePath` The path where the Cargo log files will be written to.
`protected String`	`configResourcesPath` The path where all configuration resource files are
`protected String`	`containerFile` The ZIP file of the container to use i.e.
`protected String`	`containerHome` The path where the installedLocalContainer server is installed.
`protected Integer`	`containerPort` The port where the container will run on.
`protected List<DeployableLocationConfiguration>`	`deployableLocationConfigurations` The deployable location configurations that will be used in the integration tests.
`protected Map<String,String>`	`deployableLocations` The deployable locations that will be used in the integration tests.
`protected org.codehaus.cargo.container.InstalledLocalContainer`	`installedLocalContainer` The installedLocalContainer where the server application will be run in.
`protected List<String>`	`jvmArguments` The JVM arguments to use when starting up the installedLocalContainer
`protected String`	`remoteLocation` The URL where the container and configuration ZIP files are.
`protected Map<String,String>`	`systemProperties` The system property that can be set to be used in the JVM.

Constructor Summary

Constructors
Constructor and Description

AbstractInstalledContainerUtil()
Default constructor.

Constructors
Constructor and Description
`AbstractInstalledContainerUtil()` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addDeployableLocation(String location, String type)` Adds a location of a deployable with the according type.
`protected void`	`cleanUpContainer()` Cleans up the container if there is any to make sure we start with a fresh container.
`protected abstract void`	`deploy()` Deploys the application to the correct
`String`	`getConfigResourcesPath()`
`Integer`	`getContainerPort()` Retrieves the port where the container is running on.
`List<String>`	`getJvmArguments()` Retrieves the JVM arguments
`void`	`setCargoLogFilePath(String cargoLogFilePath)`
`void`	`setConfigResourcesPath(String configResourcesPath)`
`void`	`setContainerFile(String containerFile)`
`protected void`	`setContainerName(String containerName)`
`void`	`setContainerPort(Integer containerPort)`
`void`	`setDeployableLocationConfigurations(List<DeployableLocationConfiguration> deployableLocationConfigurations)`
`void`	`setDeployableLocations(Map<String,String> deployableLocations)`
`void`	`setJvmArguments(List<String> jvmArguments)`
`void`	`setRemoteLocation(String remoteLocation)`
`void`	`setSystemProperties(Map<String,String> systemProperties)`
`protected abstract void`	`setupConfiguration()` Sets up the configuration needed for the deployable to be able to run correctly.
`protected void`	`setupContainer()` Installs the container and the application configuration.
`void`	`start()` Starts up the installedLocalContainer and its deployed applications
`void`	`stop()` Stops the installedLocalContainer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nl.tranquilizedquality.itest.cargo.ContainerUtil
getConfDirectory, getSharedLibDirectory

- Field Detail
  - configResourcesPath
```
protected String configResourcesPath
```
    The path where all configuration resource files are
  - installedLocalContainer
```
protected org.codehaus.cargo.container.InstalledLocalContainer installedLocalContainer
```
    The installedLocalContainer where the server application will be run in.
  - jvmArguments
```
protected List<String> jvmArguments
```
    The JVM arguments to use when starting up the installedLocalContainer
  - containerHome
```
protected String containerHome
```
    The path where the installedLocalContainer server is installed.
  - containerPort
```
protected Integer containerPort
```
    The port where the container will run on. Use the property ${cargo.server.port} to set the port dynamically and set the system properties with this value.
  - cargoLogFilePath
```
protected String cargoLogFilePath
```
    The path where the Cargo log files will be written to.
  - systemProperties
```
protected Map<String,String> systemProperties
```
    The system property that can be set to be used in the JVM.
  - remoteLocation
```
protected String remoteLocation
```
    The URL where the container and configuration ZIP files are.
  - containerFile
```
protected String containerFile
```
    The ZIP file of the container to use i.e. jboss-4.0.4.GA.zip.
  - deployableLocations
```
protected Map<String,String> deployableLocations
```
    The deployable locations that will be used in the integration tests.
  - deployableLocationConfigurations
```
protected List<DeployableLocationConfiguration> deployableLocationConfigurations
```
    The deployable location configurations that will be used in the integration tests.
- Constructor Detail
  - AbstractInstalledContainerUtil
```
public AbstractInstalledContainerUtil()
```
    Default constructor.
- Method Detail
  - cleanUpContainer
```
protected void cleanUpContainer()
```
    Cleans up the container if there is any to make sure we start with a fresh container.
  - setupConfiguration
```
protected abstract void setupConfiguration()
                                    throws Exception
```
    Sets up the configuration needed for the deployable to be able to run correctly.
    
    Throws:
    
    Exception - Is thrown when something went wrong if the configuration setup fails.
  - setupContainer
```
protected void setupContainer()
                       throws Exception
```
    Installs the container and the application configuration. It also sets some system properties so the container can startup properly. Finally it sets up additional configuration like jndi.proprties files etc.
    
    Throws:
    
    Exception - Is thrown when something goes wrong during the setup of the container.
  - deploy
```
protected abstract void deploy()
```
    Deploys the application to the correct
  - start
```
public void start()
           throws Exception
```
    Description copied from interface: ContainerUtil
    
    Starts up the installedLocalContainer and its deployed applications
    
    Specified by:
    
    start in interface ContainerUtil
    
    Throws:
    
    Exception - Is thrown when something went wrong during start up.
  - stop
```
public void stop()
```
    Description copied from interface: ContainerUtil
    
    Stops the installedLocalContainer.
    
    Specified by:
    
    stop in interface ContainerUtil
  - setConfigResourcesPath
```
public void setConfigResourcesPath(String configResourcesPath)
```
    Parameters:
    configResourcesPath - the configResourcesPath to set
  - getConfigResourcesPath
```
public String getConfigResourcesPath()
```
    Returns:
    the configResourcesPath
  - setDeployableLocations
```
public void setDeployableLocations(Map<String,String> deployableLocations)
```
    Parameters:
    deployableLocations - the deployableLocations to set
  - setDeployableLocationConfigurations
```
public void setDeployableLocationConfigurations(List<DeployableLocationConfiguration> deployableLocationConfigurations)
```
    Parameters:
    locations - the deployable configuration locations that will be set.
  - addDeployableLocation
```
public void addDeployableLocation(String location,
                         String type)
```
    Description copied from interface: ContainerUtil
    
    Adds a location of a deployable with the according type.
    Specified by:
    
    addDeployableLocation in interface ContainerUtil
    
    Parameters:
    location - The location where to get the deployable.
    type - The type of deployable. This can be one of the following three:
    
    WAR
    
    EAR
    
    EJB
  - getContainerPort
```
public Integer getContainerPort()
```
    Description copied from interface: ContainerUtil
    
    Retrieves the port where the container is running on.
    
    Specified by:
    
    getContainerPort in interface ContainerUtil
    
    Returns:
    Returns an integer value representing the port the container is running on.
  - setSystemProperties
```
public void setSystemProperties(Map<String,String> systemProperties)
```
    Parameters:
    systemProperties - the systemProperties to set
  - getJvmArguments
```
public List<String> getJvmArguments()
```
    Retrieves the JVM arguments
    
    Returns:
    Returns a unmodifiable list containing the current JVM arguments.
  - setJvmArguments
```
public void setJvmArguments(List<String> jvmArguments)
```
    Parameters:
    jvmArguments - the jvmArguments to set
  - setCargoLogFilePath
```
public void setCargoLogFilePath(String cargoLogFilePath)
```
  - setContainerPort
```
public void setContainerPort(Integer containerPort)
```
    Parameters:
    containerPort - the containerPort to set
  - setRemoteLocation
```
public void setRemoteLocation(String remoteLocation)
```
    Parameters:
    remoteLocation - the remoteLocation to set
  - setContainerFile
```
public void setContainerFile(String containerFile)
```
    Parameters:
    containerFile - the containerFile to set
  - setContainerName
```
protected void setContainerName(String containerName)
```
    Parameters:
    containerName - the containerName to set

Class AbstractInstalledContainerUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface nl.tranquilizedquality.itest.cargo.ContainerUtil

Field Detail

configResourcesPath

installedLocalContainer

jvmArguments

containerHome

containerPort

cargoLogFilePath

systemProperties

remoteLocation

containerFile

deployableLocations

deployableLocationConfigurations

Constructor Detail

AbstractInstalledContainerUtil

Method Detail

cleanUpContainer

setupConfiguration

setupContainer

deploy

start

stop

setConfigResourcesPath

getConfigResourcesPath

setDeployableLocations

setDeployableLocationConfigurations

addDeployableLocation

getContainerPort

setSystemProperties

getJvmArguments

setJvmArguments

setCargoLogFilePath

setContainerPort

setRemoteLocation

setContainerFile

setContainerName