Java Doc for AbstractHotDeploymentTool.java in  » Build » ANT » org » apache » tools » ant » taskdefs » optional » j2ee » 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 » Build » ANT » org.apache.tools.ant.taskdefs.optional.j2ee 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool

All known Subclasses:   org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool,  org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool,
AbstractHotDeploymentTool
abstract public class AbstractHotDeploymentTool implements HotDeploymentTool(Code)
Abstract class to support vendor-specific hot deployment tools. This class will validate boilerplate attributes. Subclassing this class for a vendor specific tool involves the following.
  1. Implement the isActionValid() method to insure the action supplied as the "action" attribute of ServerDeploy is valid.
  2. Implement the validateAttributes() method to insure all required attributes are supplied, and are in the correct format.
  3. Add a add<TOOL> method to the ServerDeploy class. This method will be called when Ant encounters a add<TOOL> task nested in the serverdeploy task.
  4. Define the deploy method. This method should perform whatever task it takes to hot-deploy the component. IE: spawn a JVM and run class, exec a native executable, run Java code...
    See Also:   org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
    See Also:   org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy




Method Summary
public  PathcreateClasspath()
     Add a classpath as a nested element.
abstract public  voiddeploy()
     Perform the actual deployment.
public  PathgetClasspath()
     gets the classpath field.
public  StringgetPassword()
     Returns the password field.
public  StringgetServer()
     Returns the server field.
protected  ServerDeploygetTask()
     Returns the task field, a ServerDeploy object.
public  StringgetUserName()
     Returns the userName field.
abstract protected  booleanisActionValid()
     Determines if the "action" attribute defines a valid action.

Subclasses should determine if the action passed in is supported by the vendor's deployment tool.

Actions may by "deploy", "delete", etc...

public  voidsetClasspath(Path classpath)
     The classpath to be passed to the JVM running the tool; optional depending upon the tool.
public  voidsetPassword(String password)
     The password of the user; optional.
public  voidsetServer(String server)
     The address or URL for the server where the component will be deployed.
public  voidsetTask(ServerDeploy task)
     Sets the parent task.
public  voidsetUserName(String userName)
     The user with privileges to deploy applications to the server; optional.
public  voidvalidateAttributes()
     Validates the passed in attributes. Subclasses should chain to this super-method to insure validation of boilerplate attributes.

Only the "action" attribute is required in the base class.




Method Detail
createClasspath
public Path createClasspath()(Code)
Add a classpath as a nested element. A Path object representing the classpath to be used.



deploy
abstract public void deploy() throws BuildException(Code)
Perform the actual deployment. It's up to the subclasses to implement the actual behavior.
exception:
  org.apache.tools.ant.BuildException - if the attributes are invalid or incomplete.



getClasspath
public Path getClasspath()(Code)
gets the classpath field. A Path representing the "classpath" attribute.



getPassword
public String getPassword()(Code)
Returns the password field. A String representing the "password" attribute.



getServer
public String getServer()(Code)
Returns the server field. A String representing the "server" attribute.



getTask
protected ServerDeploy getTask()(Code)
Returns the task field, a ServerDeploy object. An ServerDeploy representing the parent task.



getUserName
public String getUserName()(Code)
Returns the userName field. A String representing the "userName" attribute.



isActionValid
abstract protected boolean isActionValid()(Code)
Determines if the "action" attribute defines a valid action.

Subclasses should determine if the action passed in is supported by the vendor's deployment tool.

Actions may by "deploy", "delete", etc... It all depends on the tool. true if the "action" attribute is valid, false if not.




setClasspath
public void setClasspath(Path classpath)(Code)
The classpath to be passed to the JVM running the tool; optional depending upon the tool. The classpath may also be supplied as a nested element.
Parameters:
  classpath - A Path object representing the "classpath" attribute.



setPassword
public void setPassword(String password)(Code)
The password of the user; optional.
Parameters:
  password - A String representing the "password" attribute.



setServer
public void setServer(String server)(Code)
The address or URL for the server where the component will be deployed.
Parameters:
  server - A String representing the "server" attribute.



setTask
public void setTask(ServerDeploy task)(Code)
Sets the parent task.
Parameters:
  task - a ServerDeploy object representing the parent task.



setUserName
public void setUserName(String userName)(Code)
The user with privileges to deploy applications to the server; optional.
Parameters:
  userName - A String representing the "userName" attribute.



validateAttributes
public void validateAttributes() throws BuildException(Code)
Validates the passed in attributes. Subclasses should chain to this super-method to insure validation of boilerplate attributes.

Only the "action" attribute is required in the base class. Subclasses should check attributes accordingly.
exception:
  org.apache.tools.ant.BuildException - if the attributes are invalid or incomplete.




Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

w___w___w__.__ja_v_a__2_s___.__co___m___ | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.