stevel 2002/06/23 18:40:41
Modified: src/main/org/apache/tools/ant/taskdefs/optional/j2ee Tag:
ANT_15_BRANCH AbstractHotDeploymentTool.java
GenericHotDeploymentTool.java
JonasHotDeploymentTool.java ServerDeploy.java
WebLogicHotDeploymentTool.java
Log:
javadoc of the serverdeploy task suite
Revision Changes Path
No revision
No revision
1.5.2.1 +8 -10
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.java
Index: AbstractHotDeploymentTool.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.java,v
retrieving revision 1.5
retrieving revision 1.5.2.1
diff -u -r1.5 -r1.5.2.1
--- AbstractHotDeploymentTool.java 17 Apr 2002 05:50:10 -0000 1.5
+++ AbstractHotDeploymentTool.java 24 Jun 2002 01:40:41 -0000 1.5.2.1
@@ -97,8 +97,7 @@
private String server;
/**
- * Add a classpath. Used to handle the nested classpath
- * element.
+ * Add a classpath as a nested element.
* @return A Path object representing the classpath to be used.
*/
public Path createClasspath() {
@@ -147,6 +146,7 @@
/**
* Sets the parent task.
* @param task a ServerDeploy object representing the parent task.
+ * @ant.attribute ignore="true"
*/
public void setTask(ServerDeploy task) {
this.task = task;
@@ -169,8 +169,9 @@
}
/**
- * Sets the classpath field.
- * This is a required attribute.
+ * 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.
* @param classpath A Path object representing the "classpath"
attribute.
*/
public void setClasspath(Path classpath) {
@@ -186,8 +187,7 @@
}
/**
- * Sets the userName field.
- * This is a <b>not</b> required attribute.
+ * The user with privileges to deploy applications to the server;
optional.
* @param userName A String representing the "userName" attribute.
*/
public void setUserName(String userName) {
@@ -203,8 +203,7 @@
}
/**
- * Set the password field.
- * This is a <b>not</b> required attribute.
+ * The password of the user; optional.
* @param password A String representing the "password" attribute.
*/
public void setPassword(String password) {
@@ -220,8 +219,7 @@
}
/**
- * Sets the server field.
- * This is <b>not</b> a required attribute.
+ * The address or URL for the server where the component will be
deployed.
* @param server A String representing the "server" attribute.
*/
public void setServer(String server) {
1.6.2.1 +7 -6
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.java
Index: GenericHotDeploymentTool.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.java,v
retrieving revision 1.6
retrieving revision 1.6.2.1
diff -u -r1.6 -r1.6.2.1
--- GenericHotDeploymentTool.java 17 Apr 2002 05:50:10 -0000 1.6
+++ GenericHotDeploymentTool.java 24 Jun 2002 01:40:41 -0000 1.6.2.1
@@ -80,7 +80,7 @@
private static final String[] VALID_ACTIONS = { ACTION_DEPLOY };
/**
- * Creates a nested arg element.
+ * Add a nested argument element to hand to the deployment tool;
optional.
* @return A Commandline.Argument object representing the
* command line argument being passed when the deployment
* tool is run. IE: "-user=mark", "-password=venture"...
@@ -90,7 +90,8 @@
}
/**
- * Creates a nested jvmarg element.
+ * Add a nested argment element to hand to the JVM running the
+ * deployment tool.
* Creates a nested arg element.
* @return A Commandline.Argument object representing the
* JVM command line argument being passed when the deployment
@@ -114,6 +115,7 @@
/**
* Sets the parent task.
* @param task An ServerDeploy object representing the parent task.
+ * @ant.attribute ignored="true"
*/
public void setTask(ServerDeploy task) {
super.setTask(task);
@@ -147,10 +149,9 @@
}
/**
- * Sets the className field.
- * <p>The className is the name of the class to execute to perfom
- * deployment. IE: "com.foobar.tools.deploy.DeployTool"
- * This is a required attribute.
+ * The name of the class to execute to perfom
+ * deployment; required.
+ * Example: "com.foobar.tools.deploy.DeployTool"
* @param className The fully qualified class name of the class
* to perform deployment.
*/
1.6.2.1 +10 -3
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/JonasHotDeploymentTool.java
Index: JonasHotDeploymentTool.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/JonasHotDeploymentTool.java,v
retrieving revision 1.6
retrieving revision 1.6.2.1
diff -u -r1.6 -r1.6.2.1
--- JonasHotDeploymentTool.java 17 Apr 2002 05:50:10 -0000 1.6
+++ JonasHotDeploymentTool.java 24 Jun 2002 01:40:41 -0000 1.6.2.1
@@ -115,7 +115,8 @@
/**
- * Set the host for the David ORB.
+ * Set the host for the David ORB; required if
+ * ORB==david.
*
[EMAIL PROTECTED] inValue The new davidhost value
*/
@@ -125,7 +126,8 @@
/**
- * Set the port for the David ORB.
+ * Set the port for the David ORB; required if
+ * ORB==david.
*
[EMAIL PROTECTED] inValue The new davidport value
*/
@@ -146,7 +148,12 @@
/**
- * Set the ORB to construct classpath.
+ *
+ * Choose your ORB : RMI, JEREMIE, DAVID, ...; optional.
+ * If omitted, it defaults
+ * to the one present in classpath. The corresponding JOnAS JAR is
+ * automatically added to the classpath. If your orb is DAVID (RMI/IIOP)
you must
+ * specify davidhost and davidport properties.
*
[EMAIL PROTECTED] inValue RMI, JEREMIE, DAVID,...
*/
1.5.2.1 +4 -5
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/ServerDeploy.java
Index: ServerDeploy.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/ServerDeploy.java,v
retrieving revision 1.5
retrieving revision 1.5.2.1
diff -u -r1.5 -r1.5.2.1
--- ServerDeploy.java 15 Apr 2002 13:36:20 -0000 1.5
+++ ServerDeploy.java 24 Jun 2002 01:40:41 -0000 1.5.2.1
@@ -162,8 +162,8 @@
}
/**
- * Sets the action field.
- * This is a required attribute.
+ * The action to be performed, usually "deploy"; required.
+ * Some tools support additional actions, such as "delete", "list",
"undeploy", "update"...
* @param action A String representing the "action" attribute.
*/
public void setAction(String action) {
@@ -180,9 +180,8 @@
}
/**
- * Sets the source field (the path/filename of the component to be
- * deployed.
- * This is <b>not</b> a required attribute.
+ * The filename of the component to be deployed; optional
+ * depending upon the tool and the action.
* @param source String representing the "source" attribute.
*/
public void setSource(File source) {
1.5.2.1 +9 -9
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java
Index: WebLogicHotDeploymentTool.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java,v
retrieving revision 1.5
retrieving revision 1.5.2.1
diff -u -r1.5 -r1.5.2.1
--- WebLogicHotDeploymentTool.java 17 Apr 2002 05:50:10 -0000 1.5
+++ WebLogicHotDeploymentTool.java 24 Jun 2002 01:40:41 -0000 1.5.2.1
@@ -246,8 +246,8 @@
}
/**
- * Sets the debug field.
- * <p>This is not a required attribute.
+ * If set to true, additional information will be
+ * printed during the deployment process; optional.
* @param debug A boolean representing weblogic.deploy "-debug" flag.
*/
public void setDebug(boolean debug) {
@@ -255,8 +255,7 @@
}
/**
- * Sets the application field.
- * <p>This is a required attribute.
+ * The name of the application being deployed; required.
* @param application A String representing the application portion of
the
* weblogic.deploy command line.
*/
@@ -265,12 +264,13 @@
}
/**
- * Sets the component attribute.
- * <p>This attribute is not a required attribute.
+ * the component string for the deployment targets; optional.
+ * It is in the form
<code><component>:<target1>,<target2>...</code>
+ * Where component is the archive name (minus the .jar, .ear, .war
+ * extension). Targets are the servers where the components will be
deployed
+
* @param component A String representing the value of the "-component"
- * argument of the weblogic.deploy command line argument.<br>
- * This string should be in the format of
- *
<<i>componentName</i>>:<<i>target1</i>>,<<i>target2</i>>...
+ * argument of the weblogic.deploy command line argument.
*/
public void setComponent(String component) {
this.component = component;
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
