| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <html> |
| |
| <head> |
| <meta http-equiv="Content-Language" content="en-us"> |
| <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> |
| <title>EAR Task</title> |
| </head> |
| |
| <body> |
| |
| <h2><a name="ear">Ear</a></h2> |
| <h3>Description</h3> |
| <p>An extension of the <a href="jar.html">Jar</a> task with special |
| treatment for files that should end up in an Enterprise Application archive.</p> |
| <p>(The Ear task is a shortcut for specifying the particular layout of a EAR file. |
| The same thing can be accomplished by using the <i>prefix</i> and <i>fullpath</i> |
| attributes of zipfilesets in a Zip or Jar task.)</p> |
| <p>The extended zipfileset element from the zip task (with attributes <i>prefix</i>, <i>fullpath</i>, and <i>src</i>) is available in the Ear task.</p> |
| |
| <p><b>Please note that the zip format allows multiple files of the same |
| fully-qualified name to exist within a single archive. This has been |
| documented as causing various problems for unsuspecting users. If you wish |
| to avoid this behavior you must set the <code>duplicate</code> attribute |
| to a value other than its default, <code>"add"</code>.</b></p> |
| |
| <h3>Parameters</h3> |
| <table border="1" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td valign="top"><b>Attribute</b></td> |
| <td valign="top"><b>Description</b></td> |
| <td align="center" valign="top"><b>Required</b></td> |
| </tr> |
| <tr> |
| <td valign="top">destfile</td> |
| <td valign="top">the EAR file to create.</td> |
| <td valign="top" align="center">Yes</td> |
| </tr> |
| <tr> |
| <td valign="top">appxml</td> |
| <td valign="top">The deployment descriptor to use (META-INF/application.xml).</td> |
| <td valign="top" align="center">Yes, unless update is set to true</td> |
| </tr> |
| <tr> |
| <td valign="top">basedir</td> |
| <td valign="top">the directory from which to jar the files.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">compress</td> |
| <td valign="top">Not only store data but also compress them, |
| defaults to true. Unless you set the <em>keepcompression</em> |
| attribute to false, this will apply to the entire archive, not |
| only the files you've added while updating.</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">keepcompression</td> |
| <td valign="top">For entries coming from existing archives (like |
| nested <em>zipfileset</em>s or while updating the archive), keep |
| the compression as it has been originally instead of using the |
| <em>compress</em> attribute. Defaults false. <em>Since Apache Ant |
| 1.6</em></td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">encoding</td> |
| <td valign="top">The character encoding to use for filenames |
| inside the archive. Defaults to UTF8. <strong>It is not |
| recommended to change this value as the created archive will most |
| likely be unreadable for Java otherwise.</strong> |
| <br/>See also the <a href="zip.html#encoding">discussion in the |
| zip task page</a></td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">filesonly</td> |
| <td valign="top">Store only file entries, defaults to false</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">includes</td> |
| <td valign="top">comma- or space-separated list of patterns of files that must be |
| included. All files are included when omitted.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">includesfile</td> |
| <td valign="top">the name of a file. Each line of this file is |
| taken to be an include pattern</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">excludes</td> |
| <td valign="top">comma- or space-separated list of patterns of files that must be |
| excluded. No files (except default excludes) are excluded when omitted.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">excludesfile</td> |
| <td valign="top">the name of a file. Each line of this file is |
| taken to be an exclude pattern</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">defaultexcludes</td> |
| <td valign="top">indicates whether default excludes should be used or not |
| ("yes"/"no"). Default excludes are used when omitted.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">manifest</td> |
| <td valign="top">the manifest file to use.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">filesetmanifest</td> |
| <td valign="top">behavior when a Manifest is found in a zipfileset or zipgroupfileset file is found. Valid values are "skip", "merge", and "mergewithoutmain". "merge" will merge all of the manifests together, and merge this into any other specified manifests. "mergewithoutmain" merges everything but the Main section of the manifests. Default value is "skip". |
| </td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">whenmanifestonly</td> |
| <td valign="top">behavior when no files match. Valid values are "fail", "skip", and "create". Default is "create".</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">manifestencoding</td> |
| <td valign="top">The encoding used to read the JAR manifest, when a manifest file is specified.</td> |
| <td valign="top" align="center">No, defaults to the platform encoding.</td> |
| </tr> |
| <tr> |
| <td valign="top">index</td> |
| <td valign="top">whether to create an <A |
| HREF="http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index">index |
| list</A> to speed up classloading. This is a JDK 1.3+ specific |
| feature. Unless you specify additional jars with nested <a |
| href="jar.html#indexjars"><code>indexjars</code></a> elements, only the |
| contents of this jar will be included in the index. Defaults to |
| false.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">indexMetaInf</td> |
| <td valign="top">whether to include META-INF and its children in |
| the index. Doesn't have any effect if <em>index</em> is |
| false.<br/> |
| Oracle's jar implementation used to skip the META-INF directory and |
| Ant followed that example. The behavior has been changed with |
| <a href="https://bugs.openjdk.java.net/browse/JDK-4408526">Java |
| 5</a>. In order to avoid problems with Ant generated jars on |
| Java 1.4 or earlier Ant will not include META-INF unless |
| explicitly asked to.<br/> |
| <em>Ant 1.8.0</em> - Defaults to false.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">update</td> |
| <td valign="top">indicates whether to update or overwrite |
| the destination file if it already exists. Default is "false".</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">duplicate</td> |
| <td valign="top">behavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". </td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">roundup</td> |
| <td valign="top">Whether the file modification times will be |
| rounded up to the next even number of seconds.<br> |
| Zip archives store file modification times with a granularity of |
| two seconds, so the times will either be rounded up or down. If |
| you round down, the archive will always seem out-of-date when you |
| rerun the task, so the default is to round up. Rounding up may |
| lead to a different type of problems like JSPs inside a web |
| archive that seem to be slightly more recent than precompiled |
| pages, rendering precompilation useless.<br> |
| Defaults to true. <em>Since Ant 1.6.2</em></td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">level</td> |
| <td valign="top">Non-default level at which file compression should be |
| performed. Valid values range from 0 (no compression/fastest) to 9 |
| (maximum compression/slowest). <em>Since Ant 1.7</em></td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">preserve0permissions</td> |
| <td valign="top">when updating an archive or adding entries from a |
| different archive Ant will assume that a Unix permissions value of |
| 0 (nobody is allowed to do anything to the file/directory) means |
| that the permissions haven't been stored at all rather than real |
| permissions and will instead apply its own default values.<br/> |
| Set this attribute to true if you really want to preserve the |
| original permission field.<em>since Ant 1.8.0</em> |
| </td> |
| <td valign="top" align="center">No, default is false</td> |
| </tr> |
| <tr> |
| <td valign="top">useLanguageEncodingFlag</td> |
| <td valign="top">Whether to set the language encoding flag if the |
| encoding is UTF-8. This setting doesn't have any effect if the |
| encoding is not UTF-8. |
| <em>Since Ant 1.8.0</em>. |
| <br/>See also the <a href="zip.html#encoding">discussion in the |
| zip task page</a></td> |
| <td valign="top" align="center">No, default is true</td> |
| </tr> |
| <tr> |
| <td valign="top">createUnicodeExtraFields</td> |
| <td valign="top">Whether to create unicode extra fields to store |
| the file names a second time inside the entry's metadata. |
| <br>Possible values are "never", "always" and "not-encodeable" |
| which will only add Unicode extra fields if the file name cannot |
| be encoded using the specified encoding. |
| <em>Since Ant 1.8.0</em>. |
| <br/>See also the <a href="zip.html#encoding">discussion in the |
| zip task page</a></td> |
| <td align="center" valign="top">No, default is "never"</td> |
| </tr> |
| <tr> |
| <td valign="top">fallbacktoUTF8</td> |
| <td valign="top">Whether to use UTF-8 and the language encoding |
| flag instead of the specified encoding if a file name cannot be |
| encoded using the specified encoding. |
| <em>Since Ant 1.8.0</em>. |
| <br/>See also the <a href="zip.html#encoding">discussion in the |
| zip task page</a></td> |
| <td align="center" valign="top">No, default is false</td> |
| </tr> |
| <tr> |
| <td valign="top">mergeClassPathAttributes</td> |
| <td valign="top">Whether to merge the Class-Path attributes found |
| in different manifests (if merging manifests). If false, only |
| the attribute of the last merged manifest will be preserved. |
| <em>Since Ant 1.8.0</em>. |
| <br/>unless you also set flattenAttributes to true this may |
| result in manifests containing multiple Class-Path attributes |
| which violates the manifest specification.</td> |
| <td align="center" valign="top">No, default is false</td> |
| </tr> |
| <tr> |
| <td valign="top">flattenAttributes</td> |
| <td valign="top">Whether to merge attributes occurring more than |
| once in a section (this can only happen for the Class-Path |
| attribute) into a single attribute. |
| <em>Since Ant 1.8.0</em>.</td> |
| <td align="center" valign="top">No, default is false</td> |
| </tr> |
| <tr> |
| <td valign="top">zip64Mode</td> |
| <td valign="top">When to use Zip64 extensions for entries. The |
| possible values are "never", "always" and "as-needed". |
| <em>Since Ant 1.9.1</em>. |
| <br/>See also the <a href="zip.html#zip64">discussion in the |
| zip task page</a></td> |
| <td align="center" valign="top">No, default is "never"</td> |
| </tr> |
| <tr> |
| <td valign="top">modificationtime</td> |
| <td valign="top">Set all stored file modification times to the |
| given time. This can either be a number interpreted as |
| milliseconds since 1970-01-01T00:00:00Z or a string that can be |
| parsed as a ISO 8601 timestamp with optional timezone. |
| <em>Since Ant 1.9.10</em>. |
| </td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| </table> |
| |
| <h3>Nested elements</h3> |
| |
| <h4>metainf</h4> |
| <p>The nested <code>metainf</code> element specifies a <a |
| href="../Types/fileset.html">FileSet</a>. All files included in this fileset will |
| end up in the <code>META-INF</code> directory of the ear file. If this |
| fileset includes a file named <code>MANIFEST.MF</code>, the file is |
| ignored and you will get a warning.</p> |
| |
| <h4>manifest, indexjars, service</h4> |
| These are inherited from <a href="jar.html"><jar></a> |
| |
| <h2>Example</h2> |
| <pre> |
| <ear destfile="${build.dir}/myapp.ear" appxml="${src.dir}/metadata/application.xml"> |
| <fileset dir="${build.dir}" includes="*.jar,*.war"/> |
| </ear> |
| </pre> |
| |
| |
| </body> |
| </html> |
| |
| |
