<?xml version="1.0" encoding="UTF-8"?>
<section version="5.0" xml:id="deployment-plan-common" xml:lang="en"
         xmlns="http://docbook.org/ns/docbook"
         xmlns:xlink="http://www.w3.org/1999/xlink"
         xmlns:xi="http://www.w3.org/2001/XInclude"
         xmlns:svg="http://www.w3.org/2000/svg"
         xmlns:mml="http://www.w3.org/1998/Math/MathML"
         xmlns:html="http://www.w3.org/1999/xhtml"
         xmlns:db="http://docbook.org/ns/docbook">
  <title>Deployment common parts</title>

  <para>The common part of the deployment syntax is described in <link
  xlink:arcrole=""
  xlink:href="http://jonas.ow2.org/ns/deployment-plan/deployment-plan-1.0.xsd">the
  XML Schema Definition</link>.</para>

  <para>Those are the information pieces that are common to all deployment
  types: <itemizedlist>
      <listitem>
        <para xml:id="property-id"><varname>id</varname>: this information is
        mandatory and gives a identifier to the deployment plan.</para>
      </listitem>

      <listitem>
        <para xml:id="repository-ref-id"><varname>repository-ref</varname>:
        this information is optional. The value is the id of a repository
        known by the server. When given, the server will only search the
        resource on this repository.</para>
      </listitem>

      <listitem>
        <para xml:id="reloadable-id"><varname>reloadable</varname>: this
        information is a boolean (true or false), is optional and its default
        value is true. When set to true, after the resource is correctly
        deployed, the server will check the resource on the repository
        periodically. If the resources changes, the server will redeploy
        it.</para>
      </listitem>

      <listitem>
        <para xml:id="start"><varname>start</varname>: this information is a
        boolean (true or false), is optional and its default value is true.
        When set to true, if the resource to deploy is an OSGi bundle, the
        server will install and start the bundle on the framework. When set to
        false, the server will only install the bundle on the
        framework.</para>
      </listitem>

      <listitem>
        <para><varname>reference</varname>: this information is a boolean
        (true or false), is optional and its default value is false. When set
        to true, if the resource to deploy is an OSGi bundle, the server will
        install the OSGi bundle as a referenced JAR file, i.e. the JAR of the
        bundle (and its embedded JARs) will not be copied in the cache of the
        OSGi framework. When set to false, the server will install the bundle
        on the framework in the standard way.</para>
      </listitem>

      <listitem>
        <para><varname>startlevel</varname>: this information is a number
        greater than or equal to 1, is optional and its default value is 1.
        When set to true, if the resource to deploy is an OSGi bundle, the
        server will install the OSGi bundle with the given start level. When
        the OSGi framework is launched, the framework will enter start level
        one and all bundles which are assigned to start level one are started.
        The framework will continue to increase the start level, starting
        bundles at each start level, until the framework has reached a
        beginning start level.</para>
      </listitem>

      <listitem>
        <para><varname>starttransient</varname>: this information is a boolean
        (true or false), is optional and its default value is true. When set
        to true, if the resource to deploy is an OSGi bundle, the bundle start
        operation is transient, which means that the persistent autostart
        setting of the bundle is not modified.</para>
      </listitem>
    </itemizedlist></para>
</section>
