Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<h1>Profiles</h1>

<p>Profiles provide the conditional behaviours of the POM and allows for different builds depending on its properties. A couple of the usual properties used are the JDK, and the operating system. Furthermore, profiles can be activated depending on the existence of particular files.</p>

<h2>Generic Property Activation</h2>

<p>You can activate a profile when a specific system property is set. Note only properties set on the Maven command line can activate profiles. Properties set in the POM, the parent POM, or other profiles have no effect.</p>

<p>To activate a profile when a certain property has a certain value (in this case myproperty=myvalue):</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;profiles>
  &lt;profile>
    &lt;activation>
      &lt;property>
        &lt;name>myproperty&lt;/name>
        &lt;value>myvalue&lt;/value>
      &lt;/property>
    &lt;/activation>
    ...
  &lt;/profile>
  ...
&lt;/profiles>
</pre></td></tr></table>
<p>To activate a profile when a certain property exists (regardless of value):</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;profiles>
  &lt;profile>
    &lt;activation>
      &lt;property>
        &lt;name>myproperty&lt;/name>
      &lt;/property>
    &lt;/activation>
    ...
  &lt;/profile>
  ...
&lt;/profiles>
</pre></td></tr></table>
<p><br class="atl-forced-newline" /></p>

<h2>JDK Activation</h2>

<h2>OS Activation</h2>

<p>To configure the activation via the operating system, you can specify at least one out of four items - the project name, family, architecture, and version.</p>

<p>The Profile OS activation part is shown below:
<br class="atl-forced-newline" /></p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;profiles>
  &lt;profile>
    &lt;activation>
      &lt;os>
        &lt;name>windows xp&lt;/name>
        &lt;family>windows&lt;/family>
        &lt;arch>x86&lt;/arch>
        &lt;version>5.1&lt;/version>
      &lt;/os>
    &lt;/activation>
    ...
  &lt;/profile>
  ...
&lt;/profiles>
</pre></td></tr></table>
<p>For the family, architecture, and version properties, these are checked by comparing these values against System.getProperties( &quot;os.name&quot; ), System.getProperties( &quot;os.arch&quot; ), System.getProperties( &quot;os.version&quot; ) respectively. The legal values for these tags are limited to those held by the System properties.</p>

<p>However, for the family property, a range of possible values can be used:</p>
<table class="confluenceTable"><tbody>
<tr>
<th class="confluenceTh"><p> Family Value </p></th>
<th class="confluenceTh"><p> Condition for Activation </p></th>
</tr>
<tr>
<td class="confluenceTd"><p> windows </p></td>
<td class="confluenceTd"><p> if OS name contains the word &quot;windows&quot; </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> os/2 </p></td>
<td class="confluenceTd"><p> if OS name contains the word &quot;os/2&quot; </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> netware </p></td>
<td class="confluenceTd"><p> if OS name contains the word &quot;netware&quot; </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> dos </p></td>
<td class="confluenceTd"><p> if OS family is not &quot;netware&quot;, and its path separator is &quot;;&quot; </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> mac </p></td>
<td class="confluenceTd"><p> if OS name contains the word &quot;mac&quot; </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> tandem </p></td>
<td class="confluenceTd"><p> if OS name contains the word &quot;nonstop_kernel&quot; </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> unix </p></td>
<td class="confluenceTd"><p> if OS family is not &quot;openvms&quot; and not &quot;mac&quot; which names does not end with &quot;X&quot;, and its path separator is &quot;:&quot; </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> win9x </p></td>
<td class="confluenceTd"><p> is OS family is &quot;windows&quot; and OS name contains &quot;95&quot;, &quot;98&quot;, &quot;me&quot;, or &quot;ce&quot; </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> z/os </p></td>
<td class="confluenceTd"><p> if OS name contains the word &quot;z/os&quot; or &quot;os/390&quot; </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> os/400 </p></td>
<td class="confluenceTd"><p> if OS name contains the word &quot;os/400&quot; </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> openvms </p></td>
<td class="confluenceTd"><p> if OS name contains the word &quot;openvms&quot; </p></td>
</tr>
</tbody></table>

<table class="wysiwyg-macro" data-macro-name="warning" data-macro-parameters="title=Warning" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e3dhcm5pbmc6dGl0bGU9V2FybmluZ30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p>For Maven versions prior to 2.0.6, you need to declare your OS family, name, arch and version all in lower case (see <a href="http://jira.codehaus.org/browse/MNG-2814">MNG-2814</a>).</p></td></tr></table>

<h2>File Activation </h2>

<p>Controlling activation upon the existence of specific files:</p>

<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;profiles>
  &lt;profile>
    &lt;activation>
      &lt;file>
        &lt;exists>myfile&lt;/exists>
      &lt;/file>
    &lt;/activation>
    ...
  &lt;/profile>
  ...
&lt;/profiles>
</pre></td></tr></table>
<p>Controlling activation upon the absence of specific files:</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;profiles>
  &lt;profile>
    &lt;activation>
      &lt;missing>
        &lt;exists>myfile&lt;/exists>
      &lt;/missing>
    &lt;/activation>
    ...
  &lt;/profile>
  ...
&lt;/profiles>
</pre></td></tr></table>
<p>The definition of the path <strong>does not support</strong> use of properties, settings or environment variables for Maven 2.0.4. Do not try anything of the form &lt;exists&gt;${user.home}/.m2/com/oracle/ojdbc&lt;/exists&gt; instead you will need to hard code the complete path.</p>

<h2>Others</h2>

<h3>Negation</h3>

<p>Prepend &quot;!&quot; on property name, os family, os name, os version and os arch to negate.</p>

<p>Meaning</p>

<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;profiles>
  &lt;profile>
    &lt;activation>
      &lt;os>
        &lt;name>!windows xp&lt;/name>
        &lt;family>!windows&lt;/family>
        &lt;arch>!x86&lt;/arch>
        &lt;version>!5.1&lt;/version>
      &lt;/os>
    &lt;/activation>
    ...
  &lt;/profile>
  ...
&lt;/profiles>
</pre></td></tr></table>
<p>gets evaluated as true when</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>name != "windows xp" AND family != "windows" AND arch != "x86" AND version != 5.1
</pre></td></tr></table>

<h3>Active by Default </h3>

<p>Set to true to activate by default</p>