Save This Page
Home » cactus-1.8.0-src » org.apache.cactus.integration.ant.container » [javadoc | source]
org.apache.cactus.integration.ant.container
abstract public class: AbstractContainer [javadoc | source]
java.lang.Object
   org.apache.tools.ant.ProjectComponent
      org.apache.cactus.integration.ant.container.AbstractContainer

All Implemented Interfaces:
    Container, Cloneable

Direct Known Subclasses:
    AbstractResinContainer, Resin3xContainer, WebLogic7xContainer, Tomcat5xContainer, Tomcat3xContainer, AbstractOrionContainer, JBoss3xContainer, AbstractCatalinaContainer, AbstractJavaContainer, AbstractTomcatContainer, Orion2xContainer, Tomcat4xContainer, Orion1xContainer, Resin2xContainer

Abstract base class for supporting specific containers as nested elements in the org.apache.cactus.integration.ant.CactusTask .
Field Summary
protected static final  String RESOURCE_PATH    The path under which the container resources are stored in the JAR. 
Method from org.apache.cactus.integration.ant.container.AbstractContainer Summary:
cleanTempDirectory,   createAntTask,   createDirectory,   createExclude,   createFilterChain,   getBaseURL,   getContainerClasspath,   getDeployableFile,   getExcludePatterns,   getLog,   getProtocol,   getServer,   getStartUpWait,   getSystemProperties,   getTestContext,   getToDir,   init,   isEnabled,   isExcluded,   setAntTaskFactory,   setContainerClasspath,   setDeployableFile,   setIf,   setLog,   setProtocol,   setServer,   setStartUpWait,   setSystemProperties,   setToDir,   setUnless,   setupTempDirectory
Methods from org.apache.tools.ant.ProjectComponent:
clone,   getDescription,   getLocation,   getProject,   log,   log,   setDescription,   setLocation,   setProject
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.cactus.integration.ant.container.AbstractContainer Detail:
 protected  void cleanTempDirectory(File theTmpDir) 
    Clean the temporary directory.
 protected final Task createAntTask(String theName) 
 protected final File createDirectory(File theParentDir,
    String theName) throws IOException 
    Convenience method for creating a new directory inside another one.
 public final PatternSet.NameEntry createExclude() 
    Creates a nested exclude element that is added to the pattern set.
 protected final FilterChain createFilterChain() 
    Creates the default filter chain that should be applied while copying container configuration files to the temporary directory from which the container is started. The default filter chain replaces all occurences of @cactus.port@ with the TCP port of the container, and all occurences of @cactus.context@ with the web-application's context path (if the deployable file is a web-app).
 public final String getBaseURL() 
 public Path getContainerClasspath() 
 protected final DeployableFile getDeployableFile() 
    Returns the web-application archive that is to be deployed to the container.
 public final String[] getExcludePatterns() 
    Returns the exclude patterns.
 protected final Log getLog() 
    Returns the log to use.
 public final String getProtocol() 
 public final String getServer() 
 public long getStartUpWait() 
 public Variable[] getSystemProperties() 
 public String getTestContext() 
 public final File getToDir() 
 public  void init() 
    The default implementation does nothing.
 public final boolean isEnabled() 
 public final boolean isExcluded(String theTestName) 
 public final  void setAntTaskFactory(AntTaskFactory theFactory) 
 public  void setContainerClasspath(Path theClasspath) 
 public final  void setDeployableFile(DeployableFile theDeployableFile) 
 public final  void setIf(String theIfCondition) 
    Sets the name of a property that must exist in the project if tests are to be run on the container.
 public final  void setLog(Log theLog) 
 public final  void setProtocol(String theProtocol) 
    Sets the protocol the container should use
 public final  void setServer(String theServer) 
    Sets the server (name or ip) to which the container is living.
 public  void setStartUpWait(long theStartUpWait) 
    Sets the time to wait after the container has been started up. The default time is 1 second. Note: This is a hack while waiting for container specific solutions that tell exactly when the server is started or not. ATM, the only known issue is with JBoss, where the servlet engine is started before the full JBoss is started and thus it may happen that we try to shutdown JBoss before it has finished starting, leading to an exception.
 public  void setSystemProperties(Variable[] theProperties) 
 public final  void setToDir(File theToDir) 
    Sets the directory to which the test reports should be written.
 public final  void setUnless(String theUnlessCondition) 
    Sets the name of a property that must not exist in the project if tests are to be run on the container.
 protected File setupTempDirectory(File theCustomTmpDir,
    String theName) 
    Convenience method that creates a temporary directory or prepares the one passed by the user.