Java Doc for AbstractContainer.java in  » Testing » jakarta-cactus » org » apache » cactus » integration » ant » container » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Testing » jakarta cactus » org.apache.cactus.integration.ant.container 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.cactus.integration.ant.container.AbstractContainer

All known Subclasses:   org.apache.cactus.integration.ant.container.AbstractJavaContainer,  org.apache.cactus.integration.ant.container.GenericContainer,
AbstractContainer
abstract public class AbstractContainer extends ProjectComponent implements Container(Code)
Abstract base class for supporting specific containers as nested elements in the org.apache.cactus.integration.ant.CactusTask .
version:
   $Id: AbstractContainer.java 239130 2005-01-29 15:49:18Z vmassol $


Field Summary
final protected static  StringRESOURCE_PATH
     The path under which the container resources are stored in the JAR.


Method Summary
protected  voidcleanTempDirectory(File theTmpDir)
     Clean the temporary directory.
final protected  TaskcreateAntTask(String theName)
     Creates and returns a new instance of the Ant task mapped to the specified logical name using the org.apache.cactus.integration.ant.util.AntTaskFactory set.
final protected  FilecreateDirectory(File theParentDir, String theName)
     Convenience method for creating a new directory inside another one.
final public  PatternSet.NameEntrycreateExclude()
     Creates a nested exclude element that is added to the pattern set.
final protected  FilterChaincreateFilterChain()
     Creates the default filter chain that should be applied while copying container configuration files to the temporary directory from which the container is started.
final public  StringgetBaseURL()
    
public  PathgetContainerClasspath()
    
final protected  DeployableFilegetDeployableFile()
     Returns the web-application archive that is to be deployed to the container.
final public  String[]getExcludePatterns()
     Returns the exclude patterns.
final protected  LoggetLog()
     Returns the log to use.
final public  StringgetProtocol()
    
final public  StringgetServer()
    
public  longgetStartUpWait()
    
public  Variable[]getSystemProperties()
    
public  StringgetTestContext()
    
final public  FilegetToDir()
    
public  voidinit()
     The default implementation does nothing.
final public  booleanisEnabled()
    
final public  booleanisExcluded(String theTestName)
    
final public  voidsetAntTaskFactory(AntTaskFactory theFactory)
    
public  voidsetContainerClasspath(Path theClasspath)
    
final public  voidsetDeployableFile(DeployableFile theDeployableFile)
    
final public  voidsetIf(String theIfCondition)
     Sets the name of a property that must exist in the project if tests are to be run on the container.
final public  voidsetLog(Log theLog)
    
final public  voidsetProtocol(String theProtocol)
    
final public  voidsetServer(String theServer)
     Sets the server (name or ip) to which the container is living.
public  voidsetStartUpWait(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.
public  voidsetSystemProperties(Variable[] theProperties)
    
final public  voidsetToDir(File theToDir)
     Sets the directory to which the test reports should be written.
final public  voidsetUnless(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  FilesetupTempDirectory(File theCustomTmpDir, String theName)
     Convenience method that creates a temporary directory or prepares the one passed by the user.

Field Detail
RESOURCE_PATH
final protected static String RESOURCE_PATH(Code)
The path under which the container resources are stored in the JAR.





Method Detail
cleanTempDirectory
protected void cleanTempDirectory(File theTmpDir)(Code)
Clean the temporary directory.
Parameters:
  theTmpDir - the temp directory to clean



createAntTask
final protected Task createAntTask(String theName)(Code)
Creates and returns a new instance of the Ant task mapped to the specified logical name using the org.apache.cactus.integration.ant.util.AntTaskFactory set.
Parameters:
  theName - The logical name of the task to create A new isntance of the task
See Also:   AntTaskFactory.createTask



createDirectory
final protected File createDirectory(File theParentDir, String theName) throws IOException(Code)
Convenience method for creating a new directory inside another one.
Parameters:
  theParentDir - The directory in which the new directory should becreated
Parameters:
  theName - The name of the directory to create The new directory
throws:
  IOException - If the directory could not be created



createExclude
final public PatternSet.NameEntry createExclude()(Code)
Creates a nested exclude element that is added to the pattern set. The created exclude element



createFilterChain
final protected FilterChain createFilterChain()(Code)
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). The default filter chain



getBaseURL
final public String getBaseURL()(Code)

See Also:   Container.getBaseURL



getContainerClasspath
public Path getContainerClasspath()(Code)

See Also:   Container.getContainerClasspath
since:
   Cactus 1.6



getDeployableFile
final protected DeployableFile getDeployableFile()(Code)
Returns the web-application archive that is to be deployed to the container. The WAR file



getExcludePatterns
final public String[] getExcludePatterns()(Code)
Returns the exclude patterns. The exclude patterns



getLog
final protected Log getLog()(Code)
Returns the log to use. The log



getProtocol
final public String getProtocol()(Code)

See Also:   Container.getProtocol



getServer
final public String getServer()(Code)

See Also:   Container.getServer



getStartUpWait
public long getStartUpWait()(Code)

See Also:   Container.getStartUpWait
See Also:   



getSystemProperties
public Variable[] getSystemProperties()(Code)

See Also:   Container.getSystemProperties



getTestContext
public String getTestContext()(Code)

See Also:   Container.getTestContext



getToDir
final public File getToDir()(Code)

See Also:   Container.getToDir



init
public void init()(Code)
The default implementation does nothing.
See Also:   Container.init



isEnabled
final public boolean isEnabled()(Code)

See Also:   Container.isEnabled



isExcluded
final public boolean isExcluded(String theTestName)(Code)

See Also:   Container.isExcluded



setAntTaskFactory
final public void setAntTaskFactory(AntTaskFactory theFactory)(Code)

See Also:   Container.setAntTaskFactory



setContainerClasspath
public void setContainerClasspath(Path theClasspath)(Code)

See Also:   Container.setContainerClasspath(Path)
since:
   Cactus 1.6



setDeployableFile
final public void setDeployableFile(DeployableFile theDeployableFile)(Code)

See Also:   Container.setDeployableFile



setIf
final public void setIf(String theIfCondition)(Code)
Sets the name of a property that must exist in the project if tests are to be run on the container.
Parameters:
  theIfCondition - The property name to set



setLog
final public void setLog(Log theLog)(Code)

See Also:   Container.setLog



setProtocol
final public void setProtocol(String theProtocol)(Code)
Sets the protocol the container should use
Parameters:
  theProtocol - The protocol to set



setServer
final public void setServer(String theServer)(Code)
Sets the server (name or ip) to which the container is living.
Parameters:
  theServer - The server to set



setStartUpWait
public void setStartUpWait(long theStartUpWait)(Code)
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.
Parameters:
  theStartUpWait - The time to wait in milliseconds



setSystemProperties
public void setSystemProperties(Variable[] theProperties)(Code)

See Also:   Container.setSystemProperties



setToDir
final public void setToDir(File theToDir)(Code)
Sets the directory to which the test reports should be written.
Parameters:
  theToDir - The output directory to set



setUnless
final public void setUnless(String theUnlessCondition)(Code)
Sets the name of a property that must not exist in the project if tests are to be run on the container.
Parameters:
  theUnlessCondition - The property name to set



setupTempDirectory
protected File setupTempDirectory(File theCustomTmpDir, String theName)(Code)
Convenience method that creates a temporary directory or prepares the one passed by the user. The temporary directory
Parameters:
  theCustomTmpDir - The user specified custom dir or null if none hasbeen specified (ie we'll create default one).
Parameters:
  theName - The name of the directory relative to the system specifictemporary directory



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.