Developing Apama Applications > Developing Apama Applications in Java > Developing and Deploying Java Applications > Creating deployment descriptor files > 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_0.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.0//EN"
  "http://www.apama.com/dtd/jmon-jar_1_0.dtd">
 
<jmon-jar>
 
  <name>Application Name in the Correlator</name>
  <version>Version Number</version>
  <author>Author</author>
  <company>Company Name</company>
  <description>Description of this application</description>
  <application-classes>
 
    <event>
      <event-name>Event Type name in the Correlator</event-name>
      <event-class>Event Type’s class location</event-class>
      <description>Description of Event Type</description>
    </event>
 
    <monitor>
      <monitor-name>Monitor’s name in the Correlator</monitor-name>
      <monitor-class>Monitor’s class location</monitor-class>
      <description>Description of Monitor class</description>
    </monitor>
  </application-classes>
</jmon-jar>
The most important part of the deployment descriptor file is the application-classes element. This element must contain an event element for each event type your Java application defines. It must also contain a monitor element for each monitor your Java application defines.
The application name that you specify in the name element is important because it defines the Java application’s name in the correlator. The engine_inspect management tool displays this name when it lists data for your application. If you want to delete your application, you specify this name. The application name must be unique across all currently loaded applications. If the application name is not unique, injection fails.
Copyright © 2013 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or Terracotta Inc., San Francisco, CA, USA, and/or Software AG (Canada) Inc., Cambridge, Ontario, Canada, and/or, Software AG (UK) Ltd., Derby, United Kingdom, and/or Software A.G. (Israel) Ltd., Or-Yehuda, Israel and/or their licensors.