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

java.lang.Object
  extended by org.codehaus.cargo.util.log.LoggedObject
      extended by org.codehaus.cargo.container.spi.AbstractContainer
          extended by org.codehaus.cargo.container.spi.AbstractLocalContainer
              extended by org.codehaus.cargo.container.spi.AbstractInstalledLocalContainer
                  extended by org.codehaus.cargo.container.tomcat.internal.AbstractCatalinaInstalledLocalContainer
All Implemented Interfaces:
Container, InstalledLocalContainer, RunnableContainer, SpawnedContainer, LocalContainer, Loggable
Direct Known Subclasses:
Tomcat4xInstalledLocalContainer, Tomcat5xInstalledLocalContainer, Tomcat6xInstalledLocalContainer

public abstract class AbstractCatalinaInstalledLocalContainer
extends AbstractInstalledLocalContainer

Base support for Catalina based containers.

Version:
$Id: AbstractCatalinaInstalledLocalContainer.java 1919 2009-03-05 02:23:52Z adriancole $

Constructor Summary
AbstractCatalinaInstalledLocalContainer(LocalConfiguration configuration)
          
 
Method Summary
 void doStart(org.apache.tools.ant.taskdefs.Java java)
          Implementation of RunnableContainer.start() that all containers extending this class must implement.
 void doStop(org.apache.tools.ant.taskdefs.Java java)
          Implementation of RunnableContainer.stop() that all containers extending this class must implement.
 ContainerCapability getCapability()
          
protected  String getVersion(String defaultVersion)
          Returns the version of the Tomcat installation.
protected  void invokeContainer(String action, org.apache.tools.ant.taskdefs.Java 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.spi.AbstractInstalledLocalContainer
addExtraClasspath, addSharedClasspath, addToolsJarToClasspath, getAntUtils, getExtraClasspath, getHome, getHttpUtils, getJdkUtils, getResourceUtils, getSharedClasspath, getSystemProperties, getType, ifPresentAddPathToList, setExtraClasspath, setHome, setJvmToLaunchContainerIn, setLogger, setSharedClasspath, setSystemProperties, startInternal, stopInternal, verify
 
Methods inherited from class org.codehaus.cargo.container.spi.AbstractLocalContainer
getConfiguration, getFileHandler, getOutput, getState, getTimeout, isAppend, setAppend, setConfiguration, setFileHandler, setOutput, setState, setTimeout, start, stop, waitForCompletion
 
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.LocalContainer
getConfiguration, getFileHandler, setConfiguration, setFileHandler
 
Methods inherited from interface org.codehaus.cargo.container.Container
getId, getName, getState
 
Methods inherited from interface org.codehaus.cargo.util.log.Loggable
getLogger
 
Methods inherited from interface org.codehaus.cargo.container.internal.RunnableContainer
getOutput, getTimeout, isAppend, setAppend, setOutput, setTimeout, start, stop
 

Constructor Detail

AbstractCatalinaInstalledLocalContainer

public AbstractCatalinaInstalledLocalContainer(LocalConfiguration configuration)

See Also:
LocalConfiguration.configure(org.codehaus.cargo.container.LocalContainer)
Method Detail

getVersion

protected final String getVersion(String defaultVersion)
Returns the version of the Tomcat installation.

Parameters:
defaultVersion - default version to use if we cannot find out the exact Tomcat version
Returns:
The Tomcat version, or null if the version number could not be retrieved

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).
See Also:
Container.getCapability()

doStart

public final void doStart(org.apache.tools.ant.taskdefs.Java 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 Ant Java command to use to start the container
Throws:
Exception - if any error is raised during the container start
See Also:
AbstractInstalledLocalContainer.doStart(Java)

doStop

public final void doStop(org.apache.tools.ant.taskdefs.Java 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 Ant Java command to use to stop the container
Throws:
Exception - if any error is raised during the container stop
See Also:
AbstractInstalledLocalContainer.doStop(Java)

invokeContainer

protected final void invokeContainer(String action,
                                     org.apache.tools.ant.taskdefs.Java java)
                              throws Exception
Invokes the container bootstrap class to start or stop the container, depending on the value of the provided argument.

Parameters:
action - Either 'start' or 'stop'
java - the prepared Ant Java command that will be executed
Throws:
Exception - in case of container invocation error


Copyright © 2004-2012 Codehaus. All Rights Reserved.