ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ste...@apache.org
Subject cvs commit: jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb GenericDeploymentTool.java WeblogicDeploymentTool.java WLRun.java WLStop.java
Date Mon, 24 Jun 2002 01:39:57 GMT
stevel      2002/06/23 18:39:57

  Modified:    src/main/org/apache/tools/ant/taskdefs/optional/ejb Tag:
                        ANT_15_BRANCH GenericDeploymentTool.java
                        WeblogicDeploymentTool.java WLRun.java WLStop.java
  Log:
  a little bit of weblogic javadocing
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.37.2.2  +2 -3      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java
  
  Index: GenericDeploymentTool.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java,v
  retrieving revision 1.37.2.1
  retrieving revision 1.37.2.2
  diff -u -r1.37.2.1 -r1.37.2.2
  --- GenericDeploymentTool.java	30 May 2002 15:20:31 -0000	1.37.2.1
  +++ GenericDeploymentTool.java	24 Jun 2002 01:39:57 -0000	1.37.2.2
  @@ -169,8 +169,7 @@
   
   
       /**
  -     * Setter used to store the value of destination directory prior to
  -     * execute() being called.
  +     * Set the destination directory; usually required.
        * @param inDir the destination directory.
        */
       public void setDestdir(File inDir) {
  @@ -225,7 +224,7 @@
       }
   
       /**
  -     * Setter used to store the suffix for the generated jar file.
  +     * Set the suffix for the generated jar file.
        * @param inString the string to use as the suffix.
        */
       public void setGenericJarSuffix(String inString) {
  
  
  
  1.40.2.5  +65 -15    jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicDeploymentTool.java
  
  Index: WeblogicDeploymentTool.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicDeploymentTool.java,v
  retrieving revision 1.40.2.4
  retrieving revision 1.40.2.5
  diff -u -r1.40.2.4 -r1.40.2.5
  --- WeblogicDeploymentTool.java	14 Jun 2002 16:26:16 -0000	1.40.2.4
  +++ WeblogicDeploymentTool.java	24 Jun 2002 01:39:57 -0000	1.40.2.5
  @@ -78,6 +78,17 @@
   import org.apache.tools.ant.types.Environment;
   import org.apache.tools.ant.util.FileUtils;
   
  +/**
  +    The weblogic element is used to control the weblogic.ejbc compiler for
  +    generating weblogic EJB jars. Prior to Ant 1.3, the method of locating CMP
  +    descriptors was to use the ejbjar naming convention. So if your ejb-jar was
  +    called, Customer-ejb-jar.xml, your weblogic descriptor was called Customer-
  +    weblogic-ejb-jar.xml and your CMP descriptor had to be Customer-weblogic-cmp-
  +    rdbms-jar.xml. In addition, the <type-storage> element in the weblogic
  +    descriptor had to be set to the standard name META-INF/weblogic-cmp-rdbms-
  +    jar.xml, as that is where the CMP descriptor was mapped to in the generated
  +    jar.
  +*/
   public class WeblogicDeploymentTool extends GenericDeploymentTool {
       public static final String PUBLICID_EJB11
            = "-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN";
  @@ -193,12 +204,31 @@
       }
   
   
  +    /**
  +     * Optional classpath to WL6.0.
  +     * Weblogic 6.0 will give a warning if the home and remote interfaces
  +     * of a bean are on the system classpath used to run weblogic.ejbc.
  +     * In that case, the standard weblogic classes should be set with
  +     * this attribute (or equivalent nested element) and the
  +     * home and remote interfaces located with the standard classpath
  +     * attribute
  +     */
       public void setWLClasspath(Path wlClasspath) {
           this.wlClasspath = wlClasspath;
       }
   
   
  -    /** The compiler (switch <code>-compiler</code>) to use  */
  +    /** 
  +     * The compiler (switch <code>-compiler</code>) to use; optional.
  +     * This allows for the selection of a different compiler
  +     * to be used for the compilation of the generated Java
  +     * files. This could be set, for example, to Jikes to
  +     * compile with the Jikes compiler. If this is not set
  +     * and the <code>build.compiler</code> property is set
  +     * to jikes, the Jikes compiler will be used. If this
  +     * is not desired, the value &quot;<code>default</code>&quot;
  +     * may be given to use the default compiler
  +     */
       public void setCompiler(String compiler) {
           this.compiler = compiler;
       }
  @@ -206,7 +236,13 @@
   
       /**
        * Set the rebuild flag to false to only update changes in the jar rather
  -     * than rerunning ejbc
  +     * than rerunning ejbc; optional, default true.
  +     * This flag controls whether weblogic.ejbc is always
  +     * invoked to build the jar file. In certain circumstances,
  +     * such as when only a bean class has been changed, the jar
  +     * can be generated by merely replacing the changed classes
  +     * and not rerunning ejbc. Setting this to false will reduce
  +     * the time to run ejbjar.     
        */
       public void setRebuild(boolean rebuild) {
           this.alwaysRebuild = rebuild;
  @@ -240,9 +276,10 @@
   
   
       /**
  -     * Setter used to store the value of keepGeneric
  +     * controls whether the generic file used as input to
  +     * ejbc is retained; defaults to false
        *
  -     * @param inValue a string, either 'true' or 'false'.
  +     * @param inValue true for keep generic
        */
       public void setKeepgeneric(boolean inValue) {
           this.keepGeneric = inValue;
  @@ -250,8 +287,9 @@
   
   
       /**
  -     * Sets whether -keepgenerated is passed to ejbc (that is, the .java
  -     * source files are kept).
  +     * Controls whether weblogic will keep the generated Java
  +     * files used to build the class files added to the
  +     * jar. This can be useful when debugging; default is false.
        *
        * @param inValue either 'true' or 'false'
        */
  @@ -260,7 +298,10 @@
       }
   
   
  -    /** sets some additional args to send to ejbc.  */
  +    /** 
  +     * Any optional extra arguments pass to the weblogic.ejbc
  +     * tool.
  +     */
       public void setArgs(String args) {
           this.additionalArgs = args;
       }
  @@ -273,7 +314,9 @@
           this.additionalJvmArgs = args;
       }
   
  -    /** Set the classname of the ejbc compiler  */
  +    /** 
  +     * Set the classname of the ejbc compiler;  optional  
  +     */
       public void setEjbcClass(String ejbcClass) {
           this.ejbcClass = ejbcClass;
       }
  @@ -286,8 +329,9 @@
   
   
       /**
  -     * Setter used to store the location of the ejb-jar DTD. This can be a
  -     * file on the system or a resource on the classpath.
  +     * <b>Deprecated</b>. Defines the location of the ejb-jar DTD in
  +     *  the weblogic class hierarchy. Should not be needed, and the
  +     * nested &lt;dtd&gt; element is recommended when it is.
        *
        * @param inString the string to use as the DTD location.
        */
  @@ -297,8 +341,9 @@
   
   
       /**
  -     * Setter used to store the location of the weblogic DTD. This can be a
  -     * file on the system or a resource on the classpath.
  +     * <b>Deprecated</b>. Defines the location of weblogic DTD in
  +     *  the weblogic class hierarchy. Should not be needed, and the
  +     * nested &lt;dtd&gt; element is recommended when it is.
        *
        * @param inString the string to use as the DTD location.
        */
  @@ -308,8 +353,9 @@
   
   
       /**
  -     * Setter used to store the location of the Sun's Generic EJB DTD. This
  -     * can be a file on the system or a resource on the classpath.
  +     * <b>Deprecated</b>. Defines the location of Sun's EJB DTD in
  +     *  the weblogic class hierarchy. Should not be needed, and the
  +     * nested &lt;dtd&gt; element is recommended when it is.
        *
        * @param inString the string to use as the DTD location.
        */
  @@ -320,6 +366,7 @@
   
       /**
        * Set the value of the oldCMP scheme. This is an antonym for newCMP
  +     * @ant.attribute ignore="true'
        */
       public void setOldCMP(boolean oldCMP) {
           this.newCMP = !oldCMP;
  @@ -327,7 +374,10 @@
   
   
       /**
  -     * Set the value of the newCMP scheme. The old CMP scheme locates the
  +     * If this is set to true, the new method for locating
  +     * CMP descriptors will be used; optional, default false.
  +     * <P>
  +     * The old CMP scheme locates the
        * weblogic CMP descriptor based on the naming convention where the
        * weblogic CMP file is expected to be named with the bean name as the
        * prefix. Under this scheme the name of the CMP descriptor does not match
  
  
  
  1.19.2.1  +34 -16    jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WLRun.java
  
  Index: WLRun.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WLRun.java,v
  retrieving revision 1.19
  retrieving revision 1.19.2.1
  diff -u -r1.19 -r1.19.2.1
  --- WLRun.java	15 Apr 2002 14:56:31 -0000	1.19
  +++ WLRun.java	24 Jun 2002 01:39:57 -0000	1.19.2.1
  @@ -64,7 +64,8 @@
   
   /**
    * Execute a Weblogic server.
  - 
  + * A number of parameters are used to control the operation of the weblogic instance. Note
that the task,
  + * and hence ant, will not complete until the weblogic instance is stopped.</p>
    *
    * @author Conor MacNeill, Cortex ebusiness Pty Limited
    */
  @@ -311,7 +312,10 @@
   
       
       /**
  -     * Set the classpath to be used for this execution.
  +     * The classpath to be used with the Java Virtual Machine that runs the Weblogic
  +     * Server; required. Prior to Weblogic 6.0, this is typically set to the Weblogic
  +     * boot classpath. Under Weblogic 6.0 this should include all the
  +     * weblogic jars
        *
        * @param s the classpath to use when executing the weblogic server.
        */
  @@ -320,7 +324,8 @@
       }
       
       /**
  -     * Set the weblogic classpath.
  +     * Set the weblogic classpath used by the Weblogic Server;
  +     * optional, and only applicable to WL4.5.1
        *
        * The weblogic classpath is used by weblogic to support dynamic class loading.
        *
  @@ -331,7 +336,9 @@
       }
       
       /**
  -     * Set the security policy for this invocation of weblogic.
  +     * The name of the security policy file within the weblogic home directory that
  +     * is to be used. If not specified, the default policy file <code>weblogic.policy</code>
  +     * is used.
        *
        * @param securityPolicy the security policy to use.
        */
  @@ -341,7 +348,8 @@
       
       /**
        * The location where weblogic lives.
  -     *
  +     * Required. This is the absolute location, not relative to
  +     *  BEA home.
        * @param weblogicHome the home directory of weblogic.
        *
        */
  @@ -350,7 +358,8 @@
       }
   
       /**
  -     * The location of the BEA Home.
  +     * The location of the BEA Home; implicitly 
  +     * selects Weblogic 6.0; optional.
        *
        * @param beaHome the BEA Home directory.
        *
  @@ -360,7 +369,8 @@
       }
       
       /**
  -     * Set the name of the server to run
  +     * The name of the weblogic server within the weblogic home which is to be run.
  +     * Optiona, defaults to &quot;myserver&quot;
        *
        * @param systemName the name of the server.
        */
  @@ -369,7 +379,7 @@
       }
       
       /**
  -     * Set the Domain to run in
  +     * Set the Domain to run in; required for WL6.0
        *
        * @param domain the domain
        */
  @@ -378,9 +388,10 @@
       }
       
       /**
  -     * Set the properties file to use.
  +     * The name of the server's properties file within the weblogic home directory
  +     * used to control the weblogic instance; 
  +     * required for WL4.5.1
        *
  -     * The location of the properties file is relative to the weblogi system home
        *
        * @param propertiesFilename the properties file name
        */
  @@ -397,7 +408,8 @@
       }
       
       /**
  -     * Set the management username to run the server
  +     * Set the management username to run the server; 
  +     * optional and only applicable to WL6.0.
        *
        * @param username the management username of the server.
        */
  @@ -407,8 +419,8 @@
       
   
       /**
  -     * Set the management password of the server
  -     *
  +     * Set the management password of the server;
  +     * optional and only applicable to WL6.0.
        * @param password the management pasword of the server.
        */
       public void setPassword(String password) {
  @@ -416,19 +428,25 @@
       }
       
       /**
  -     * Set the private key password so the server can decrypt the SSL private key file.
  -     *
  +     * Set the private key password so the server can decrypt the SSL private key file;
  +     * optional and only applicable to WL6.0.
        * @param pkpassword the private key password,
        */
       public void setPKPassword(String pkpassword) {
           this.pkPassword = pkpassword;
       }
       
  +    /**
  +     * Additional argument string passed to the Weblogic instance;
  +     * optional.
  +     */
       public void setArgs(String args) {
           additionalArgs = args;
       }
   
  -    
  +    /**
  +     * name of the main class for weblogic; optional.
  +     */
       public void setWeblogicMainClass(String c) {
           weblogicMainClass = c;
       }
  
  
  
  1.11.2.1  +16 -8     jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WLStop.java
  
  Index: WLStop.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WLStop.java,v
  retrieving revision 1.11
  retrieving revision 1.11.2.1
  diff -u -r1.11 -r1.11.2.1
  --- WLStop.java	18 Mar 2002 02:44:29 -0000	1.11
  +++ WLStop.java	24 Jun 2002 01:39:57 -0000	1.11.2.1
  @@ -63,7 +63,8 @@
   
   /**
    * Shutdown a Weblogic server.
  -
  + * To shut down an instance you must supply both a username and
  + * a password. 
    *
    * @author Conor MacNeill, Cortex ebusiness Pty Limited
    */
  @@ -136,7 +137,8 @@
       }
   
       /**
  -     * Set the classpath to be used for this compilation.
  +     * The classpath to be used with the Java Virtual Machine that runs the Weblogic
  +     * Shutdown command; 
        *
        * @param s the classpath to use when executing the weblogic admin task.
        */
  @@ -145,7 +147,8 @@
       }
   
       /**
  -     * Add the classpath for the user classes
  +     * The classpath to be used with the Java Virtual Machine that runs the Weblogic
  +     * Shutdown command; 
        */
       public Path createClasspath() {
           if (classpath == null) {
  @@ -155,7 +158,8 @@
       }
   
       /**
  -     * Set the username to use to request shutdown of the server.
  +     * The username of the account which will be used to shutdown the server;
  +     * required.
        *
        * @param s the username.
        */
  @@ -164,7 +168,8 @@
       }
   
       /**
  -     * Set the password to use to request shutdown of the server.
  +     * The password for the account specified in the
  +     * user parameter; required
        *
        * @param s the password.
        */
  @@ -173,7 +178,8 @@
       }
   
       /**
  -     * Set the URL to which the weblogic server is listening.
  +     * Set the URL to which the weblogic server is listening
  +     * for T3 connections; required.
        *
        * @param s the url.
        */
  @@ -183,7 +189,8 @@
   
   
       /**
  -     * Set the delay (in seconds) before shutting down the server.
  +     * Set the delay (in seconds) before shutting down the server;
  +     * optional.
        *
        * @param s the selay.
        */
  @@ -192,7 +199,8 @@
       }
   
       /**
  -     * The location of the BEA Home.
  +     * The location of the BEA Home; implicitly 
  +     * selects Weblogic 6.0 shutdown; optional.
        *
        * @param beaHome the BEA Home directory.
        *
  
  
  

--
To unsubscribe, e-mail:   <mailto:ant-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:ant-dev-help@jakarta.apache.org>


Mime
View raw message