3.2. Add an Explicit Module Dependency to a Deployment

Procedure 3.1. Add dependency configuration to MANIFEST.MF

1. Add MANIFEST.MF file

   If the project has no MANIFEST.MF file, create a file called MANIFEST.MF. For a web application (WAR) add this file to the META-INF directory. For an EJB archive (JAR) add it to the META-INF directory.

2. Add dependencies entry

   Add a dependencies entry to the MANIFEST.MF file with a comma-separated list of dependency module names.

   Dependencies: org.javassist, org.apache.velocity

   Copy to Clipboard Toggle word wrap

3. Optional: Make a dependency optional

   A dependency can be made optional by appending optional to the module name in the dependency entry.

   Dependencies: org.javassist optional, org.apache.velocity

   Copy to Clipboard Toggle word wrap

4. Optional: Export a dependency

   A dependency can be exported by appending export to the module name in the dependency entry.

   Dependencies: org.javassist, org.apache.velocity export

   Copy to Clipboard Toggle word wrap

5. Optional: Dependencies using annotations

   This flag is needed when the module dependency contains annotations which need to be processed during annotation scanning, such as when declaring EJB Interceptors. If this is not done, an EJB interceptor declared in a module cannot be used in a deployment. There are other situations involving annotation scanning when this is needed too.
   Using this flag requires that the module contain a Jandex index. Instructions for creating and using a Jandex index are included at the end of this topic.

Procedure 3.2. Add dependency configuration to jboss-deployment-structure.xml

1. Add jboss-deployment-structure.xml

   If the application has no jboss-deployment-structure.xml file then create a new file called jboss-deployment-structure.xml and add it to the project. This file is an XML file with the root element of <jboss-deployment-structure>.

   <jboss-deployment-structure> 
   
   </jboss-deployment-structure>

   Copy to Clipboard Toggle word wrap
   For a web application (WAR) add this file to the WEB-INF directory. For an EJB archive (JAR) add it to the META-INF directory.

2. Add dependencies section

   Create a <deployment> element within the document root and a <dependencies> element within that.

3. Add module elements

   Within the dependencies node, add a module element for each module dependency. Set the name attribute to the name of the module.

   <module name="org.javassist" />

   Copy to Clipboard Toggle word wrap

4. Optional: Make a dependency optional

   A dependency can be made optional by adding the optional attribute to the module entry with the value of true. The default value for this attribute is false.

   <module name="org.javassist" optional="true" />

   Copy to Clipboard Toggle word wrap

5. Optional: Export a dependency

   A dependency can be exported by adding the export attribute to the module entry with the value of true. The default value for this attribute is false.

   <module name="org.javassist" export="true" />

   Copy to Clipboard Toggle word wrap

Procedure 3.3. 

1. Create the index

   java -jar EAP_HOME/modules/org/jboss/jandex/main/jandex-1.0.3.Final-redhat-1.jar $JAR_FILE

   Copy to Clipboard Toggle word wrap

2. Create a temporary working space

   mkdir /tmp/META-INF

   Copy to Clipboard Toggle word wrap

3. Move the index file to the working directory

   mv $JAR_FILE.ifx /tmp/META-INF/jandex.idx

   Copy to Clipboard Toggle word wrap
4. • Option 1: Include the index in a new JAR file

     jar cf index.jar -C /tmp META-INF/jandex.idx

     Copy to Clipboard Toggle word wrap
     Then place the JAR in the module directory and edit module.xml to add it to the resource roots.
   • Option 2: Add the index to an existing JAR

     java -jar EAP_HOME/modules/org/jboss/jandex/main/jandex-1.0.3.Final-redhat-1.jar -m $JAR_FILE

     Copy to Clipboard Toggle word wrap

5. Tell the module import to utilize the annotation index

   Tell the module import to utilize the annotation index, so that annotation scanning can find the annotations.
   Choose one of the methods below based on your situation:
   • If you are adding a module dependency using MANIFEST.MF, add annotations after the module name.
     For example change:

     Dependencies: test.module, other.module

     Copy to Clipboard Toggle word wrap
     to

     Dependencies: test.module annotations, other.module

     Copy to Clipboard Toggle word wrap
   • If you are adding a module dependency using jboss-deployment-structure.xml add annotations="true" on the module dependency.