Apama 10.15.0 | Developing Apama Applications | Developing EPL Plug-ins | Writing EPL Plug-ins in Java | Creating deployment descriptor files for EPL plug-ins written in Java | Format for deployment descriptor files
 
Format for deployment descriptor files
The format of the deployment descriptor file must be compliant with the XML defined by the following XML Document Type Definition (DTD):
http://www.apama.com/dtd/jmon-jar_1_2.dtd
You should become familiar with this DTD to understand the exact definition of the deployment descriptor file. However, the normal structure of the file is as follows. In the following format, all text inside XML element tags, which is in italic typeface, indicates placeholders for which you would supply an actual value.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE jmon-jar PUBLIC "-//Apama, Inc.//DTD Java Monitors 1.2//EN"
  "http://www.apama.com/dtd/jmon-jar_1_2.dtd">
<jmon-jar>
  <name>Plug-in name in the correlator</name>
  <version>Version number</version>
  <author>Author</author>
  <company>Company name</company>
  <description>Description of this plug-in</description>
  <classpath>${sys:MY_THIRD_PARTY_DIR}/lib/foo.jar;
${sys:MY_THIRD_PARTY_DIR}/lib/bar.jar
</classpath>
  <application-classes>
<plugin>
<plugin-name>The name visible to EPL</plugin-name>
<plugin-class>The class to load from the JAR</plugin-class>
<description>The description that appears in the log messages</description>
</plugin>
  </application-classes>
</jmon-jar>
The most important part of the deployment descriptor file is the application-classes element. This element must contain a plugin element for each plug-in. See also Defining plug-ins in deployment descriptor files.
The plug-in name that you specify in the name element is important because it defines the plug-in's name in the correlator. The engine_inspect management tool displays this name when it lists data for your plug-in. If you want to delete your plug-in, you specify this name. The plug-in name must be unique across all currently loaded plug-ins. If the plug-in name is not unique, injection fails.