Configuring the Ant Task

The task supports the following configuration attributes:

The ant task can take additional inputs using nested war, ear, aspectpath and extraclasspath tags. These are described in the subsequent sections.

Specifying applications

The ant task can take nested war and ear tags which specifies the applications to instrument. Their attributes are desribed below.

• War tag

  <war> tag specifies a WAR web application. It can take nested includes and excludes tags which specify what portion of the war needs instrumentation. If neither includes or excludes is specified nothing gets instrumented. Attributes of the war tag are described below:

  Attribue	Description	Default Value
  src	Specifies the source of the war application. This can be file or a directory (exploded wars).Mandatory attribute.	-
  dest	Specifies the destination of the instrumented war application. If 'src' was an exploded war, the output would be an exploded war, else it would be a compressed war file. Mandatory attribute.	-

  Example:

      
  <war src="my.war" dest="my.instrumented.war">
      <include name="WEB-INF/classes/**"/>
      <exclude name="WEB-INF/classes/do/not/instrument/**"/>
      <include name="WEB-INF/lib/*.jar"/>
      <exclude name="WEB-INF/lib/log4j*.jar"/>
  </war>
                           
                      

• Ear tag

  <ear> tag specifies an EAR application. It can take nested <module> tags which specify which portions of the archive should be instrumented. If no modules are specified nothing gets instrumented. Attributes of the ear tag are described below:

  Attribue	Description	Default Value
  src	Specifies the source of the ear application. This can be file or a directory (exploded wars).Mandatory attribute.	-
  dest	Specifies the destination of the instrumented ear application. If 'src' was an exploded ear, the output would be an exploded ear, else it would be a compressed war file. Mandatory attribute.	-

  The <module> tag identifies a module with an ear, and is very similar to <war> tag

  , except that it has a name attribute instead of src and dest attributes which <war> has. The name attribute identifies the name of the module within an ear. <module> tag also supports a type attribute, the legal values of which are ejb, java, war, classes and jar.

  Attribue	Description	Default Value
  name	Specifies the name of the module within an ear. Mandatory attribute.	-
  type	ejb|java|war|classes|jar. Specifies the type of the module. ejb = ejb module java = java module war = web module classes = directory of classes jar = a jar file Mandatory attribute.	-

  Again like <war>, you can provide nested includes and excludes tags which specify what portion of a moudle needs instrumentation

  Example:

      
  <ear src="my.ear" dest="my.instrumented.ear">
      <module name="ejb-module" type="ejb">
          <include name="**/*.class"/>
          <exclude name="do/not/instrument/**"/>
      </module>
          
      <module name="web-module" type="war">
          <include name="WEB-INF/classes/**"/>
          <exclude name="WEB-INF/classes/do/not/instrument/**"/>
      </module>    
      
      <module name="APP-INF/classes" type="classes">
          <include name="**/*.class"/>        
      </module>    
  </war>
                           
                      

Specifying aspects and classpath

Aspects are specified using the <aspectpath> tag. This is a regular Ant <path> tag. This path should refer to the compiled aspect classes. When using AspectWerkz system, you might need to have a META-INF/aop.xml file also in this path. The aspect classes specified by this path would be copied into the appropriate location within the application.

Often you might needs some classes that is needed for compilation, but are not packaged withing the application itself - for example, the jars containing J2EE classes. These needs to be specified using the <extraclasspath> tag. The classes in this path will be used for aspect compilation, but will not be copied into the application.

The aspects that are shipped with InfraRED are packaged in INFRARED_HOME/infrared-agent-all-servlet-2.4.1.BETA.jar. If you need offline process you application to using these, add them as part of the <extraclasspath>. We dont need to copy these into the application because they are available in the server's classpath.

Preserving the working directory

The Ant task uncompresses your application archive into a working directory, and deletes this directory when the task finishes execution. Sometimes you might want to inspect this directory to debug issues you might run into with the Ant task. In that case, enabling the system propery infrared.dont.clean preserves the working directory.

Deploying the aspected ear/war

After the Infrared integrated ear/war is created, the following steps need to be done before you start the server and deploy the applicaton.