| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> |
| <!-- |
| 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> |
| <link rel="shortcut icon" href="http://aries.apache.org/images/favicon.ico"></link> |
| <link type="text/css" rel="stylesheet" href="http://aries.apache.org/resources/site.css"></link> |
| </script><script src="http://aries.apache.org/resources/menus.js" language="javascript" type="text/javascript"></script> |
| <meta name="keywords" content="..."/> |
| <meta name="description" content="..." /> |
| <title> |
| Apache Aries - EBAMavenPluginProject |
| </title> |
| </head> |
| <body onload="SetMenu()"> |
| |
| <table width="100%" cellpadding="0" cellspacing="0"> |
| <tr width="100%"> |
| <td id="cell-0-0" colspan="2"> </td> |
| <td id="cell-0-1"> </td> |
| <td id="cell-0-2" colspan="2"> </td> |
| </tr> |
| <tr width="100%"> |
| <td id="cell-1-0"> </td> |
| <td id="cell-1-1"> </td> |
| <td id="cell-1-2"> |
| <div style="padding: 5px;"> |
| <div id="banner"> |
| <!-- Banner --> |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| <tr> |
| <td align="left" class="topbardiv" nowrap=""> |
| <a href="http://aries.apache.org/" title="Apache Aries"> <img border="0" src="http://aries.apache.org/images/Arieslogo_Horizontal.gif"> </a> |
| </td> |
| <td align="right" nowrap=""> |
| <a href="http://www.apache.org/" title="The Apache Software Foundation"> <img border="0" src="http://aries.apache.org/images/apache_feather.png"> </a> |
| </td> |
| </tr> |
| </table> |
| <!-- Banner --> |
| </div> |
| </div> |
| <div id="top-menu"> |
| <table border="0" cellpadding="1" cellspacing="0" width="100%"> |
| <tr> |
| <td> |
| <div align="left"> |
| <!-- Breadcrumbs --> |
| <!-- Breadcrumbs --> |
| </div> |
| </td> |
| <td> |
| <div align="right"> |
| <!-- Quicklinks --> |
| <DIV style="padding: 5px 5px 0px 25px;"> |
| <FORM action="http://www.google.com/search" method="get" style="font-size: 10px;"> |
| <A href="http://www.apache.org/licenses/LICENSE-2.0.html" class="external-link" rel="nofollow">License</A> |
| <INPUT name="ie" type="hidden" value="UTF-8"></INPUT> |
| <INPUT name="oe" type="hidden" value="UTF-8"></INPUT> |
| <INPUT maxlength="255" name="q" size="15" type="text" value></INPUT> |
| <INPUT name="btnG" type="submit" value="Search"></INPUT> |
| <INPUT name="domains" type="hidden" value="aries.apache.org"></INPUT> |
| <INPUT name="sitesearch" type="hidden" value="aries.apache.org"></INPUT> |
| </FORM> |
| </DIV> |
| <!-- Quicklinks --> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </div> |
| </td> |
| <td id="cell-1-3"> </td> |
| <td id="cell-1-4"> </td> |
| </tr> |
| <tr width="100%"> |
| <td id="cell-2-0" colspan="2"> </td> |
| <td id="cell-2-1"> |
| <table> |
| <tr height="100%" valign="top"> |
| <td height="100%"> |
| <div id="wrapper-menu-page-right"> |
| <div id="wrapper-menu-page-top"> |
| <div id="wrapper-menu-page-bottom"> |
| <div id="menu-page"> |
| <!-- NavigationBar --> |
| <style type="text/css"> |
| /* The following code is added by mdx_elementid.py |
| It was originally lifted from http://subversion.apache.org/style/site.css */ |
| /* |
| * Hide class="elementid-permalink", except when an enclosing heading |
| * has the :hover property. |
| */ |
| .headerlink, .elementid-permalink { |
| visibility: hidden; |
| } |
| h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> |
| <div onclick="SwitchMenu('documentation')" id="documentationTitle" class="menutitle">Documentation</div> |
| |
| <div id="documentation" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="/documentation/integrators-guide.html">Integrators Guide</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/documentation/articles.html">Articles</a> |
| </div> |
| <div class="menuitem"> |
| <a href="https://svn.apache.org/repos/asf/aries/slides/">Slides</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/documentation/tutorials.html">Tutorials</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/documentation/tools.html">Tools</a> |
| </div> |
| </div> |
| |
| <div onclick="SwitchMenu('modules')" id="modulesTitle" class="menutitle">Modules</div> |
| |
| <div id="modules" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="/modules/samples.html">Samples</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/async-svcs.html">Asynchronous Services</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/blueprint.html">Blueprint</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/blueprint-maven-plugin.html">Blueprint-maven-plugin</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/blueprintannotation.html">Blueprint Annotations</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/blueprintnoosgi.html">Blueprint No-OSGi</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/blueprintweb.html">Blueprint Web</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/containers.html">Containers</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/esaanttask.html">ESA Ant Task </a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/ebamavenpluginproject.html">EBA Maven Plugin </a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/esamavenpluginproject.html">ESA Maven Plugin </a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/jmx.html">JMX</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/jndiproject.html">JNDI</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/jpaproject.html">JPA</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/transactioncontrol.html">Transaction Control Service</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/transactionsproject.html">Transactions</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/rsa.html">Remote Service Admin (RSA)</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/spi-fly.html">SPI Fly</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/subsystems.html">Subsystems</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/modules/applications.html">Applications (obsolete)</a> |
| </div> |
| </div> |
| |
| <div onclick="SwitchMenu('downloads')" id="downloadsTitle" class="menutitle">Downloads</div> |
| |
| <div id="downloads" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="/downloads/currentreleases.html">Current Releases</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/downloads/testresults.html">Compliance Tests</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/downloads/archived-releases.html">Archived Releases</a> |
| </div> |
| </div> |
| |
| <div onclick="SwitchMenu('community')" id="communityTitle" class="menutitle">Community</div> |
| |
| <div id="community" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="/community/resources.html">Community Resources</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/community/gettinginvolved.html">Getting Involved</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/community/people.html">Who we are</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/community/boardreports.html">Board Reports</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/community/logos.html">Logos for Users</a> |
| </div> |
| </div> |
| |
| <div onclick="SwitchMenu('development')" id="developmentTitle" class="menutitle">Development</div> |
| |
| <div id="development" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="/development/buildingaries.html">Building Aries </a> |
| </div> |
| <div class="menuitem"> |
| <a href="/development/guidelines.html">Cording Guidelines</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/development/architecture.html">Architecture</a> |
| </div> |
| <div class="menuitem"> |
| <a href="/development/releasingaries.html">Releasing Aries </a> |
| </div> |
| <div class="menuitem"> |
| <a href="/development/compliancetesting.html">OSGi Compliance Tests </a> |
| </div> |
| <div class="menuitem"> |
| <a href="/development/maintainingthewebpages.html">Web Site Maintenance </a> |
| </div> |
| </div> |
| |
| <div onclick="SwitchMenu('sponsorship')" id="sponsorshipTitle" class="menutitle">Sponsorship</div> |
| |
| <div id="sponsorship" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="http://www.apache.org/foundation/thanks.html">Thanks</a> |
| </div> |
| <div class="menuitem"> |
| <a href="http://www.apache.org/foundation/sponsorship.html">Sponsoring Apache</a> |
| </div> |
| </div> |
| |
| <div class="promotion"> |
| <a href="http://www.apache.org/events/current-event.html"> |
| <img src="http://www.apache.org/events/current-event-125x125.png" width="125" height="125"/> |
| </a> |
| </div> |
| <!-- NavigationBar --> |
| </div> |
| </div> |
| </div> |
| </div> |
| </td> |
| <td height="100%" width="100%"> |
| <!-- Content --> |
| <div class="wiki-content"><style type="text/css"> |
| /* The following code is added by mdx_elementid.py |
| It was originally lifted from http://subversion.apache.org/style/site.css */ |
| /* |
| * Hide class="elementid-permalink", except when an enclosing heading |
| * has the :hover property. |
| */ |
| .headerlink, .elementid-permalink { |
| visibility: hidden; |
| } |
| h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> |
| <p><a name="EBAMavenPluginProject-EBAMavenPlugin"></a></p> |
| <h1 id="eba-maven-plugin">EBA Maven Plugin<a class="headerlink" href="#eba-maven-plugin" title="Permanent link">¶</a></h1> |
| <p>The EBA Maven Plugin provides the ability to generate EBA archives using |
| Maven. The EBA archive format is described in <a href="applications.html">Applications</a> |
| . An EBA archive can optionally contain an Application manifest |
| (APPLICATION.MF). This can be added in one of two ways</p> |
| <ol> |
| <li>Hand written and added into the archive.</li> |
| <li>Generated based on pom configuration.</li> |
| </ol> |
| <p><a name="EBAMavenPluginProject-UsingthePlugin"></a></p> |
| <h2 id="using-the-plugin">Using the Plugin<a class="headerlink" href="#using-the-plugin" title="Permanent link">¶</a></h2> |
| <p>The plugin is included by as follows:</p> |
| <div class="codehilite"><pre> <span class="nt"><build></span> |
| <span class="nt"><plugins></span> |
| <span class="nt"><plugin></span> |
| <span class="nt"><groupId></span>org.apache.aries<span class="nt"></groupId></span> |
| <span class="nt"><artifactId></span>eba-maven-plugin<span class="nt"></artifactId></span> |
| <span class="nt"></plugin></span> |
| <span class="nt"></plugins></span> |
| <span class="nt"></build></span> |
| </pre></div> |
| |
| |
| <p>By default it will not generate a manifest, so in the above example it will |
| attempt to copy a pre-defined APPLICATION.MF from |
| src/main/resources/META-INF. If that file does not exist, then no |
| application manifest will be included.</p> |
| <p><a name="EBAMavenPluginProject-GeneratinganAPPLICATION.MF"></a></p> |
| <h2 id="generating-an-applicationmf">Generating an APPLICATION.MF<a class="headerlink" href="#generating-an-applicationmf" title="Permanent link">¶</a></h2> |
| <p>The following example shows how to get the plugin to generate an |
| APPLICATION.MF based on the pom configuration:</p> |
| <div class="codehilite"><pre> <span class="nt"><build></span> |
| <span class="nt"><plugins></span> |
| <span class="nt"><plugin></span> |
| <span class="nt"><groupId></span>org.apache.aries<span class="nt"></groupId></span> |
| <span class="nt"><artifactId></span>eba-maven-plugin<span class="nt"></artifactId></span> |
| <span class="nt"><configuration></span> |
| <span class="nt"><generateManifest></span>true<span class="nt"></generateManifest></span> |
| <span class="nt"></configuration></span> |
| <span class="nt"></plugin></span> |
| <span class="nt"></plugins></span> |
| <span class="nt"></build></span> |
| </pre></div> |
| |
| |
| <p>The pom to application manfiest header mapping is as follows: |
| <em> Pom <groupId/>.<artifactId/> -> Application-SymbolicName |
| </em> Pom <name/> -> Application-Name |
| <em> Pom <version/> -> Application-Version (cleaned up for OSGi) |
| </em> Pom <description/> -> Application-Description |
| * Pom <dependencies/> -> Application-Content</p> |
| <p><a name="EBAMavenPluginProject-OverridingApplication-SymbolicName"></a></p> |
| <h2 id="overriding-application-symbolicname">Overriding Application-SymbolicName<a class="headerlink" href="#overriding-application-symbolicname" title="Permanent link">¶</a></h2> |
| <p>The application symbolic name defaults to the |
| ${project.groupId}.${project.artifaceId}. The following shows how to override |
| this:</p> |
| <div class="codehilite"><pre><span class="nt"><configuration></span> |
| <span class="nt"><instructions></span> |
| <span class="nt"><Application</span><span class="err">-SymbolicName</span><span class="nt">></span><span class="cp">${</span><span class="n">project</span><span class="o">.</span><span class="n">artifaceId</span><span class="cp">}</span><span class="nt"></Application-SymbolicName></span> |
| <span class="nt"></instructions></span> |
| <span class="nt"></configuration></span> |
| </pre></div> |
| |
| |
| <p><a name="EBAMavenPluginProject-AddingApplication-ExportServiceandApplication-ImportServiceheaders"></a></p> |
| <h2 id="adding-application-exportservice-and-application-importservice-headers">Adding Application-ExportService and Application-ImportService headers<a class="headerlink" href="#adding-application-exportservice-and-application-importservice-headers" title="Permanent link">¶</a></h2> |
| <p>The application import service and export service headers can be set as |
| follows. The text inside the elements is included as-is.</p> |
| <div class="codehilite"><pre><span class="nt"><configuration></span> |
| <span class="nt"><instructions></span> |
| <span class="nt"><Application-ExportService></span>...<span class="nt"></Application-ExportService></span> |
| <span class="nt"><Application-ImportService></span>...<span class="nt"></Application-ImportService></span> |
| <span class="nt"></instructions></span> |
| <span class="nt"></configuration></span> |
| </pre></div> |
| |
| |
| <p><a name="EBAMavenPluginProject-AddingUseBundleheader"></a></p> |
| <h2 id="adding-the-use-bundle-header">Adding the Use-Bundle header<a class="headerlink" href="#adding-the-use-bundle-header" title="Permanent link">¶</a></h2> |
| <p>The application Use-Bundle header can be set as |
| follows. The text inside the elements is included as-is.</p> |
| <div class="codehilite"><pre><span class="nt"><configuration></span> |
| <span class="nt"><instructions></span> |
| <span class="nt"><Use-Bundle></span>...<span class="nt"></Use-Bundle></span> |
| <span class="nt"></instructions></span> |
| <span class="nt"></configuration></span> |
| </pre></div> |
| |
| |
| <p><a name="EBAMavenPluginProject-Includingtransitivedependencies"></a></p> |
| <h2 id="including-transitive-dependencies-deprecated">Including transitive dependencies (deprecated)<a class="headerlink" href="#including-transitive-dependencies-deprecated" title="Permanent link">¶</a></h2> |
| <p>This configuration option is deprecated in favor of <archiveContent />.</p> |
| <p>By default, the archive will only include the direct dependencies of the |
| project. Transitive dependencies can be includes as follows:</p> |
| <div class="codehilite"><pre><span class="nt"><configuration></span> |
| <span class="nt"><useTransitiveDependencies></span>true<span class="nt"></useTransitiveDependencies></span> |
| <span class="nt"></configuration></span> |
| </pre></div> |
| |
| |
| <p><a name="EBAMavenPluginProject-Archivecontent"></a></p> |
| <h2 id="including-bundles-in-the-archive">Including bundles in the archive<a class="headerlink" href="#including-bundles-in-the-archive" title="Permanent link">¶</a></h2> |
| <p>By default, the archive will only include the direct dependencies of the project. The <code><archiveContent/></code> element can be used to control the archive artifact contents. The following shows how to include all direct and transitive dependencies.</p> |
| <div class="codehilite"><pre><span class="nt"><configuration></span> |
| <span class="nt"><archiveContent></span>all<span class="nt"></archiveContent></span> |
| <span class="nt"></configuration></span> |
| </pre></div> |
| |
| |
| <p>The following shows how to exclude all dependencies from the archive. This is useful if you just want the application definition and will use a bundle repository to provision the bundles during deployment.</p> |
| <div class="codehilite"><pre><span class="nt"><configuration></span> |
| <span class="nt"><archiveContent></span>none<span class="nt"></archiveContent></span> |
| <span class="nt"></configuration></span> |
| </pre></div> |
| |
| |
| <p>The following specifies the default of including only the direct dependencies (assumes the application contents and direct dependencies are the same).</p> |
| <div class="codehilite"><pre><span class="nt"><configuration></span> |
| <span class="nt"><archiveContent></span>applicationContent<span class="nt"></archiveContent></span> |
| <span class="nt"></configuration></span> |
| </pre></div></div> |
| <!-- Content --> |
| </td> |
| </tr> |
| </table> |
| </td> |
| <td id="cell-2-2" colspan="2"> </td> |
| </tr> |
| <tr width="100%"> |
| <td id="cell-3-0"> </td> |
| <td id="cell-3-1"> </td> |
| <td id="cell-3-2"> |
| <div id="footer"> |
| <!-- Footer --> |
| <div id="site-footer"> |
| <a href="http://aries.apache.org/privacy-policy.html";>Privacy |
| Policy</a> |
| </div> |
| <!-- Footer --> |
| </div> |
| </td> |
| <td id="cell-3-3"> </td> |
| <td id="cell-3-4"> </td> |
| </tr> |
| <tr width="100%"> |
| <td id="cell-4-0" colspan="2"> </td> |
| <td id="cell-4-1"> </td> |
| <td id="cell-4-2" colspan="2"> </td> |
| </tr> |
| </table> |
| </body> |
| </html> |