Package org.codehaus.cargo.container.tomcat

Class Tomcat4xInstalledLocalContainer

java.lang.Object

org.codehaus.cargo.util.log.LoggedObject

org.codehaus.cargo.container.spi.AbstractContainer

org.codehaus.cargo.container.spi.AbstractLocalContainer

org.codehaus.cargo.container.spi.AbstractInstalledLocalContainer

org.codehaus.cargo.container.tomcat.internal.AbstractCatalinaInstalledLocalContainer

org.codehaus.cargo.container.tomcat.Tomcat4xInstalledLocalContainer

All Implemented Interfaces:

Container, InstalledLocalContainer, RunnableContainer, SpawnedContainer, LocalContainer, Loggable

public class Tomcat4xInstalledLocalContainer
extends AbstractCatalinaInstalledLocalContainer

Special container support for the Apache Tomcat 4.x servlet container.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ID	Unique container id.

Constructor Summary

Constructors

Constructor	Description
Tomcat4xInstalledLocalContainer(LocalConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
void	doStart(JvmLauncher java)	Implementation of RunnableContainer.start() that all containers extending this class must implement.
String	getId()
String	getName()
protected void	invokeContainer(String action, JvmLauncher java)	Invokes the container bootstrap class to start or stop the container, depending on the value of the provided argument.

Methods inherited from class org.codehaus.cargo.container.tomcat.internal.AbstractCatalinaInstalledLocalContainer

addExtraClasspath, doStop, getCapability, getVersion

Methods inherited from class org.codehaus.cargo.container.spi.AbstractInstalledLocalContainer

addExtraClasspath, addMemoryArguments, addRuntimeArgs, addSharedClasspath, addToolsJarToClasspath, createJvmLauncher, forceStopInternal, getExtraClasspath, getHome, getHttpUtils, getJavaHome, getJvmLauncherFactory, getResourceUtils, getSharedClasspath, getSystemProperties, getType, ifPresentAddPathToList, setExtraClasspath, setHome, setJvmLauncherFactory, setJvmToLaunchContainerIn, setLogger, setSharedClasspath, setSystemProperties, startInternal, stopInternal, verify

Methods inherited from class org.codehaus.cargo.container.spi.AbstractLocalContainer

executePostStartTasks, getConfiguration, getFileHandler, getOutput, getState, getTimeout, isAppend, restart, setAppend, setConfiguration, setFileHandler, setOutput, setState, setTimeout, start, stop, waitForCompletion, waitForPortShutdown, waitForStarting

Methods inherited from class org.codehaus.cargo.util.log.LoggedObject

getLogger

Methods inherited from class java.lang.Object

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

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

getState

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

getConfiguration, getFileHandler, setConfiguration, setFileHandler

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

getLogger

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

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

Field Detail

ID

public static final String ID

Unique container id.

See Also:

Constant Field Values

Constructor Detail

Tomcat4xInstalledLocalContainer

public Tomcat4xInstalledLocalContainer(LocalConfiguration configuration)

See Also:

AbstractCatalinaInstalledLocalContainer(org.codehaus.cargo.container.configuration.LocalConfiguration)

Method Detail

getId

public String getId()

Returns:

the short name of the container. Note: this is not a unique id. It is simply the name in a computer-usable format.

getName

public String getName()

Returns:

the human readable name of the Container (ex: "Resin 3.x", "JBoss 3.0.8", etc).

doStart

public void doStart(JvmLauncher java)
             throws Exception

Implementation of RunnableContainer.start() that all containers extending this class must implement.

Overrides:

doStart in class AbstractCatalinaInstalledLocalContainer

Parameters:

java - the predefined JVM launcher to use to start the container

Throws:

Exception - if any error is raised during the container start

invokeContainer

protected void invokeContainer(String action,
                               JvmLauncher java)
                        throws Exception

Invokes the container bootstrap class to start or stop the container, depending on the value of the provided argument.

Overrides:

invokeContainer in class AbstractCatalinaInstalledLocalContainer

Parameters:

action - Either 'start' or 'stop'

java - the prepared Ant Java command that will be executed

Throws:

Exception - in case of container invocation error