org.codehaus.cargo.container

Interface InstalledLocalContainer

All Superinterfaces:

Container, LocalContainer, Loggable, RunnableContainer, SpawnedContainer

All Known Subinterfaces:

JBoss5xInstalledLocalContainer, JBossInstalledLocalContainer

All Known Implementing Classes:

AbstractCatalinaInstalledLocalContainer, AbstractGlassFishInstalledLocalContainer, AbstractInstalledLocalContainer, AbstractJBoss5xInstalledLocalContainer, AbstractJBossInstalledLocalContainer, AbstractJonasInstalledLocalContainer, AbstractJRunInstalledLocalContainer, AbstractOc4j10xInstalledLocalContainer, AbstractOrionInstalledLocalContainer, AbstractResinInstalledLocalContainer, AbstractWebLogicInstalledLocalContainer, AbstractWildFlyInstalledLocalContainer, AbstractWildFlySwarmInstalledLocalContainer, Geronimo1xInstalledLocalContainer, Geronimo2xInstalledLocalContainer, Geronimo3xInstalledLocalContainer, GlassFish2xInstalledLocalContainer, GlassFish3xInstalledLocalContainer, GlassFish4xInstalledLocalContainer, GlassFish5xInstalledLocalContainer, JBoss3xInstalledLocalContainer, JBoss42xInstalledLocalContainer, JBoss4xInstalledLocalContainer, JBoss51xInstalledLocalContainer, JBoss5xInstalledLocalContainer, JBoss61xInstalledLocalContainer, JBoss6xInstalledLocalContainer, JBoss71xInstalledLocalContainer, JBoss72xInstalledLocalContainer, JBoss73xInstalledLocalContainer, JBoss74xInstalledLocalContainer, JBoss75xInstalledLocalContainer, JBoss7xInstalledLocalContainer, Jetty6xInstalledLocalContainer, Jetty7xInstalledLocalContainer, Jetty8xInstalledLocalContainer, Jetty9xInstalledLocalContainer, Jo1xInstalledLocalContainer, Jonas4xInstalledLocalContainer, Jonas5xInstalledLocalContainer, JRun4xInstalledLocalContainer, LibertyInstalledLocalContainer, Oc4j10xInstalledLocalContainer, Oc4j9xInstalledLocalContainer, Resin2xInstalledLocalContainer, Resin31xInstalledLocalContainer, Resin3xInstalledLocalContainer, Resin4xInstalledLocalContainer, Tomcat4xInstalledLocalContainer, Tomcat5xInstalledLocalContainer, Tomcat6xInstalledLocalContainer, Tomcat7xInstalledLocalContainer, Tomcat8xInstalledLocalContainer, Tomcat9xInstalledLocalContainer, Tomee1xInstalledLocalContainer, Tomee7xInstalledLocalContainer, Tomee8xInstalledLocalContainer, WebLogic103xInstalledLocalContainer, WebLogic10xInstalledLocalContainer, WebLogic121xInstalledLocalContainer, WebLogic122xInstalledLocalContainer, WebLogic12xInstalledLocalContainer, WebLogic8xInstalledLocalContainer, WebLogic9xInstalledLocalContainer, WebSphere85xInstalledLocalContainer, WebSphere9xInstalledLocalContainer, WildFly10xInstalledLocalContainer, WildFly11xInstalledLocalContainer, WildFly12xInstalledLocalContainer, WildFly13xInstalledLocalContainer, WildFly14xInstalledLocalContainer, WildFly15xInstalledLocalContainer, WildFly16xInstalledLocalContainer, WildFly17xInstalledLocalContainer, WildFly8xInstalledLocalContainer, WildFly9xInstalledLocalContainer, WildFlySwarm2017xInstalledLocalContainer

public interface InstalledLocalContainer
extends LocalContainer, SpawnedContainer

Represents a local container that requires an installation to work. The installation is where the container's runtime is located.

Method Summary

Modifier and Type	Method and Description
String	getHome()
void	setHome(String home)

Methods inherited from interface org.codehaus.cargo.container.LocalContainer

getConfiguration, getFileHandler, setConfiguration, setFileHandler

Methods inherited from interface org.codehaus.cargo.container.Container

getCapability, getId, getName, getState, getType

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

getLogger, setLogger

Methods inherited from interface org.codehaus.cargo.container.internal.RunnableContainer

getOutput, getTimeout, isAppend, restart, setAppend, setOutput, setTimeout, start, stop

Methods inherited from interface org.codehaus.cargo.container.internal.SpawnedContainer

addExtraClasspath, addSharedClasspath, getExtraClasspath, getJvmLauncherFactory, getSharedClasspath, getSystemProperties, setExtraClasspath, setJvmLauncherFactory, setSharedClasspath, setSystemProperties

Method Detail

getHome

String getHome()

Returns:

the directory where the container is installed. 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.

setHome

void setHome(String home)

Parameters:

home - the directory where the container is installed. Note that we're passing a String instead of a File because we want to leave the possibility of using URIs for specifying the home location. IMPORTANT: While some containers can deal with this parameter being set as a relative path, some others require this path to be set to an absolute directory. Please refer to the documentation of the server to ensure you give the path in the appropriate way. If in doubt, you can use absolute paths -that is known to work with all containers.