Package org.codehaus.cargo.container.jetty

Class Jetty6xInstalledLocalContainer

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.jetty.Jetty6xInstalledLocalContainer

All Implemented Interfaces:

Container, InstalledLocalContainer, RunnableContainer, SpawnedContainer, LocalContainer, Loggable

Direct Known Subclasses:

Jetty7xInstalledLocalContainer

public class Jetty6xInstalledLocalContainer
extends AbstractInstalledLocalContainer

Special container support for the Jetty 6.x servlet container.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
Jetty6xInstalledLocalContainer(LocalConfiguration configuration)	Jetty6xInstalledLocalContainer Constructor.

Method Summary

Modifier and Type	Method	Description
void	doStart(JvmLauncher java)	Implementation of RunnableContainer.start() that all containers extending this class must implement.
void	doStop(JvmLauncher java)	Implementation of RunnableContainer.stop() that all containers extending this class must implement.
ContainerCapability	getCapability()
String	getId()
protected String	getJettyPortPropertyName()
String	getName()
protected String[]	getStartArguments(String classpath)	Returns the arguments to pass to the Jetty start command.
protected String[]	getStopArguments()
protected String	getVersion()	Returns the version of the Jetty installation.
protected void	invoke(JvmLauncher java, boolean isGettingStarted)

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

addExtraClasspath, 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

Jetty6xInstalledLocalContainer

public Jetty6xInstalledLocalContainer(LocalConfiguration configuration)

Jetty6xInstalledLocalContainer Constructor.

Parameters:

configuration - The configuration associated with the container

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).

getVersion

protected String getVersion()

Returns the version of the Jetty installation.

Returns:

The Jetty version

doStart

public void doStart(JvmLauncher java)
             throws Exception

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

Specified by:

doStart in class AbstractInstalledLocalContainer

Parameters:

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

Throws:

Exception - if any error is raised during the container start

doStop

public void doStop(JvmLauncher java)
            throws Exception

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

Specified by:

doStop in class AbstractInstalledLocalContainer

Parameters:

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

Throws:

Exception - if any error is raised during the container stop

invoke

protected void invoke(JvmLauncher java,
                      boolean isGettingStarted)
               throws Exception

Parameters:

java - the predefined JVM launcher to use to start the container, passed by Cargo

isGettingStarted - if true then start the container, stop it otherwise

Throws:

Exception - in case of startup or shutdown error

getStartArguments

protected String[] getStartArguments(String classpath)

Returns the arguments to pass to the Jetty start command.

Parameters:

classpath - Jetty classpath (exludes tools.jar).

Returns:

Arguments to add to the Jetty start.jar command.

getStopArguments

protected String[] getStopArguments()

Returns:

Arguments to add to the Jetty start.jar command.

getJettyPortPropertyName

protected String getJettyPortPropertyName()

Returns:

The Jetty property name for HTTP port.

getCapability

public ContainerCapability getCapability()

Returns:

the ContainerCapability of the container in term of ability to deploy such and such type of Deployables (eg WAR, EAR, etc).