Maven2 Best practice for Enterprise Project EAR file

Question

I am just switching from Ant to Maven and am trying to figure out the best practice to set up a EAR file based Enterprise project   Let s say I want to create a pretty standard project with a jar file for the EJBs  a WAR file for the Web tier and the encapsulating EAR file  with the corresponding deployment descriptors   How would I go about it  Create the project with archetypeArtifactId maven-archetype-webapp as with a war file  and extend from there  What is the best project structure  and POM file example  for this  Where do you stick the ear file related deployment descriptors  etc    Thanks for any help

User · Answer

This is a good example of the maven-ear-plugin part.

You can also check the maven archetypes that are available as an example. If you just runt mvn archetype:generate you'll get a list of available archetypes. One of them is

maven-archetype-j2ee-simple

User · Answer

You create a new project   The new project is your EAR assembly project which contains your two dependencies for your EJB project and your WAR project   So you actually have three maven projects here   One EJB   One WAR  One EAR that pulls the two parts together and creates the ear   Deployment descriptors can be generated by maven  or placed inside the resources directory in the EAR project structure   The maven-ear-plugin is what you use to configure it  and the documentation is good  but not quite clear if you re still figuring out how maven works in general     So as an example you might do something like this    lt  xml version  1 0  encoding  utf-8   gt   lt project xmlns  http   maven apache org POM 4 0 0  xmlns xsi  http   www w3 org 2001 XMLSchema-instance  xsi schemaLocation  http   maven apache org POM 4 0 0 http   maven apache org maven-v4 0 0 xsd  gt     lt modelVersion gt 4 0 0 lt  modelVersion gt     lt groupId gt com mycompany lt  groupId gt     lt artifactId gt myEar lt  artifactId gt     lt packaging gt ear lt  packaging gt     lt name gt My EAR lt  name gt      lt build gt       lt plugins gt         lt plugin gt           lt artifactId gt maven-compiler-plugin lt  artifactId gt           lt configuration gt             lt source gt 1 5 lt  source gt             lt target gt 1 5 lt  target gt             lt encoding gt UTF-8 lt  encoding gt           lt  configuration gt         lt  plugin gt         lt plugin gt           lt artifactId gt maven-ear-plugin lt  artifactId gt           lt configuration gt             lt version gt 1 4 lt  version gt             lt modules gt               lt webModule gt                 lt groupId gt com mycompany lt  groupId gt                 lt artifactId gt myWar lt  artifactId gt                 lt bundleFileName gt myWarNameInTheEar war lt  bundleFileName gt                 lt contextRoot gt  myWarConext lt  contextRoot gt               lt  webModule gt               lt ejbModule gt                 lt groupId gt com mycompany lt  groupId gt                 lt artifactId gt myEjb lt  artifactId gt                 lt bundleFileName gt myEjbNameInTheEar jar lt  bundleFileName gt               lt  ejbModule gt             lt  modules gt             lt displayName gt My Ear Name displayed in the App Server lt  displayName gt             lt  -- If I want maven to generate the application xml  set this to true -- gt             lt generateApplicationXml gt true lt  generateApplicationXml gt           lt  configuration gt         lt  plugin gt         lt plugin gt           lt artifactId gt maven-resources-plugin lt  artifactId gt           lt version gt 2 3 lt  version gt           lt configuration gt             lt encoding gt UTF-8 lt  encoding gt           lt  configuration gt         lt  plugin gt       lt  plugins gt       lt finalName gt myEarName lt  finalName gt     lt  build gt      lt  -- Define the versions of your ear components here -- gt     lt dependencies gt       lt dependency gt         lt groupId gt com mycompany lt  groupId gt         lt artifactId gt myWar lt  artifactId gt         lt version gt 1 0-SNAPSHOT lt  version gt         lt type gt war lt  type gt       lt  dependency gt       lt dependency gt         lt groupId gt com mycompany lt  groupId gt         lt artifactId gt myEjb lt  artifactId gt         lt version gt 1 0-SNAPSHOT lt  version gt         lt type gt ejb lt  type gt       lt  dependency gt     lt  dependencies gt   lt  project gt

User · Answer

What helped me a lot was to run the Maven archetype generate goal and select from one of the archetypes  some of which seem to be updated regularly  in particular JBoss seems to be well maintained    mvn archetype generate   Hundreds of archetypes appeared in a numbered list from which to select  519 as of now     The goal  still running  prompted me to make a selection by entering a number or entering a search string e g    513  remote - gt  org xwiki commons xwiki-commons-component-archetype 514  remote - gt  org xwiki rendering xwiki-rendering-archetype-macro 515  remote - gt  org zkoss zk-archetype-component 516  remote - gt  org zkoss zk-archetype-webapp 517  remote - gt  ru circumflex circumflex-archetype  -  518  remote - gt  se vgregion javg maven archetypes javg-minimal-archetype  -  Choose a number or apply filter  format   groupId  artifactId  case sensitive contains     I entered the search string  ear   which reduced the list to only 8 items  as of today    Choose archetype  1  remote - gt  org codehaus mojo archetypes ear-j2ee14  -  2  remote - gt  org codehaus mojo archetypes ear-javaee6  -  3  remote - gt  org codehaus mojo archetypes ear-jee5  -  4  remote - gt  org hibernate hibernate-search-quickstart  -  5  remote - gt  org jboss spec archetypes jboss-javaee6-ear-webapp  6  remote - gt  org jboss spec archetypes jboss-javaee6-webapp-ear-archetype 7  remote - gt  org jboss spec archetypes jboss-javaee6-webapp-ear-archetype-blank 8  remote - gt  org ow2 weblab tools maven weblab-archetype-searcher   I selected  org jboss spec archetypes jboss-javaee6-ear-webapp   by entering the selection  5  in this example      Next  the goal asked me to enter the groupId  artifactId  package names  etc   and it then generated the following well-documented example application    pgarner localhost Foo   tree    -- Foo-ear      -- pom xml  -- Foo-ejb      -- pom xml      -- src          -- main              -- java                  -- com                      -- foo                          -- controller                              -- MemberRegistration java                          -- data                              -- MemberListProducer java                          -- model                              -- Member java                          -- util                              -- Resources java              -- resources                  -- import sql                  -- META-INF                      -- beans xml                      -- persistence xml          -- test              -- java                  -- com                      -- foo                          -- test                              -- MemberRegistrationTest java              -- resources  -- Foo-web      -- pom xml      -- src          -- main              -- java                  -- com                      -- foo                          -- rest                              -- JaxRsActivator java                              -- MemberResourceRESTService java              -- webapp                  -- index html                  -- index xhtml                  -- resources                      -- css                          -- screen css                      -- gfx                          -- banner png                          -- logo png                  -- WEB-INF                      -- beans xml                      -- faces-config xml                      -- templates                          -- default xhtml  -- pom xml  -- README md  32 directories  23 files   After reading the four POM files  which were well-commented  I had pretty much all the information I needed     pom xml   Foo-ear pom xml   Foo-ejb pom xml   Foo-web pom xml

User · Answer

I ve been searching high and low for an end-to-end example of a complete maven-based ear-packaged application and finally stumbled upon this   The instructions say to select option 2 when running through the CLI but for your purposes  use option 1

User · Answer

i have made a github repository to show what i think is a good  or best practices  startup project structure     https   github com StefanHeimberg stackoverflow-1134894  some keywords    Maven 3 BOM  DependencyManagement of own dependencies  Parent for all Projects  DependencyManagement from external dependencies and PluginManagement for global Project configuration  JUnit   Mockito   DBUnit Clean War project without WEB-INF lib because dependencies are in EAR lib folder  Clean Ear project  Minimal deployment descriptors for Java EE7 No Local EJB Interface because  LocalBean is sufficient  Minimal maven configuration through maven user properties Actual Deployment Descriptors for Servlet 3 1   EJB 3 2   JPA 2 1 usage of macker-maven-plugin to check architecture rules Integration Tests enabled  but skipped   skipITs false  useful to enable on CI Build Server   Maven Output   Reactor Summary   MyProject - BOM                                      SUCCESS    0 494 s  MyProject - Parent                                   SUCCESS    0 330 s  MyProject - Common                                   SUCCESS    3 498 s  MyProject - Persistence                              SUCCESS    1 045 s  MyProject - Business                                 SUCCESS    1 233 s  MyProject - Web                                      SUCCESS    1 330 s  MyProject - Application                              SUCCESS    0 679 s  ------------------------------------------------------------------------ BUILD SUCCESS ------------------------------------------------------------------------ Total time  8 817 s Finished at  2015-01-27T00 51 59 01 00 Final Memory  24M 207M ------------------------------------------------------------------------

User · Answer

NetBeans IDE automatically defines the structure which is almost similar to one suggested by Patrick Garner  For NetBeans users  File- New Project - In left side select Maven and In right side select Maven Enterprise Application and press Next -  Asks for project names for both war ejb and settings   The IDE will automatically create the structure for you

[jakarta-ee] Maven2: Best practice for Enterprise Project (EAR file)

Examples related to jakarta-ee

Examples related to maven-2

Examples related to ear

Examples related to maven-ear-plugin