SYS-CON MEDIA Authors: Yeshim Deniz, Pat Romanski, Carmen Gonzalez, Liz McMillan, Zakia Bouachraoui

Blog Feed Post

How I Created a Standard pom.xml file for Eclipse and NetBeans

After building my environment for JavaServer Faces in the Eclipse IDE it was time to move onto NetBeans. It should be simple, I thought. I was very, very wrong.

NetBeans Step 1

Create a new project for Maven->Web Application. Fill in the usual details about the Maven project. When complete and the project appears immediately edit the pom.xml file and replace the section that starts with <dependencies> until the end with the contents from my pom.xml file from my previous blog posts.

At this point the project is ready for you to write your code. Or so I thought . . .

NetBeans revealed a flaw in my pom.xml file. In Eclipse the classpath of a Maven project includes the server’s library. This makes the TomEE lib folder’s jar files available to Eclipse. This is not the case with NetBeans. When it handles a Maven based project it expects all references to libraries to be declared in the pom.xml only. The ability to add libraries to a project through the IDE is removed.

When I began working on this project  I was looking for a Maven dependency that referred to the TomEE libraries and not the Java EE 6 Oracle libraries. So the following dependency refers to the wrong version of the libraries.

<dependency>
   <groupId>javax</groupId>
   <artifactId>javaee-web-api</artifactId>
   <version>6.0</version>
   <scope>provided</scope>
</dependency>

Here is where I made one of many mistakes. I believed that the Maven TomEE plugin provided the correct libraries. So I placed in my pom.xml file:

<dependency>
   <groupId>org.apache.openejb.maven</groupId>
   <artifactId>tomee-maven-plugin</artifactId>
   <version>1.6.0</version>
   <scope>provided</scope>
</dependency>

This plugin has nothing to do with TomEE libraries. Instead its purpose is to allow a Maven pom.xml to be written that could, as listed on the TomEE maven Plugin page, do the following:

  • easy provisioning of a TomEE server
  • server start and stop
  • application deploy and undeploy

I did not notice the problem in Eclipse because it saw the TomEE libraries but when I tried to write a Facelet template file with NetBeans it reported that there was No Faces library in the classpath. So back to Google I went.

I found a blog entitled Developing Java EE 6 Applications With TomEE and NetBeans. It created a project by using an archetype. It showed how to add an archetype to Netbeans. It used the tomee-webapp-archetype.

The issue that I have with archetypes is that I must tell my students to delete or ignore parts of the project they create. When I used Maven in the classroom with Eclipse last term I used the maven-archetype-quickstart. Most of my students were confused by the generated files and chose to leave them in place unchanged. Most of my students’ projects displayed “Hello World!” in the console when run because they would not change the App.java file. Now I plan to start projects without an archetype.

What I was really interested in was the pom.xml file it created. It contained the dependency I was looking for that referenced the library used by TomEE:

<dependency>
   <groupId>org.apache.openejb</groupId>
   <artifactId>javaee-api</artifactId>
   <version>6.0-5</version>
   <scope>provided</scope>
</dependency>

It also included a plugin for the JPA. Great, now for some testing.

The sample code ran in NetBeans although it complained about the following tag in an xhtml file:

<h:body bgcolor="white">

Now I was getting ticked off. The sample web app does work and the error is ignored. I know it works because I changed the color to green. What I don’t understand is how the authors of this archetype felt it was acceptable to leave an error in their code. A little research revealed that it should have been written as:

<h:body style="background-color:white">

I now think I’m all set. As a further test I decide to try to add a new JSF Facelets template file. I could not create the file because NetBeans declared that there was No Facelets Libraries Found. But I thought org.apache.openejb.javaee-api would take care of this. A look into the Dependencies folder of the project revealed that there were no JSF libraries. So back to Google and the following was added:

<dependency>
   <groupId>org.apache.myfaces.core</groupId>
   <artifactId>myfaces-impl-ee6</artifactId>
   <version>2.1.1</version>
   <scope>provided</scope>
</dependency>

How can we be told that JSF should be used in place of Servlets and JSPs only to discover that org.apache.openejb.javaee-api does not include MyFaces? I found my fix and so it’s time to move on.

The archetype sample code now ran flawlessly and I could add new Facelet template files.

I had successfully followed the Eclipse JSF Tools Tutorial – JSF 2.0 using may Maven based project setup. You can find this tutorial in the Eclipse help system. I uploaded it to my SVN repository and then brought it down to NetBeans. It ran successfully in NetBeans. Now I replaced most of the pom.xml file with the new components from the archetype sample and it continued to run flawlessly. I was on a roll. So I updated the repository from NetBeans and brought the project back into Eclipse. Eclipse was not happy.

Eclipse complained about a section of the JPA plugin in the pom.xml file.

<executions>
   <execution>
      <id>enhancer</id>
      <phase>process-classes</phase>
      <goals>
         <goal>enhance</goal>
      </goals>
   </execution>
</executions>

I could comment these lines out but NetBeans was okay with them. The error message in Eclipse stated that “Plugin execution not covered by lifecycle configuration”. Back to Google and a solution was found. It seems Eclipse’s m2e plugin needs information about the lifecycle and this needed to be added to the pom.xml. You can read about this here.

So more elements were added to the pom.xml. I did discover that while you normally place plugins as a child of the <plugins> tag, the fix for Eclipse required the plugins to be children of <pluginManagement><plugins>.

Once Eclipse was happy I moved the project back through SVN to NetBeans and it did not mind the Eclipse specific elements in the pom.xml. The Eclipse tutorial project worked on both platforms and I could create the project from scratch on both platforms.

The last niggling problem was a warning whenever I ran the Eclipse tutorial. TomEE wrote out to the console:

WARNING: Attribute ‘for’ of label component with id j_id_a is not defined

I popped this into Google and came up with this answer.

The author of the Eclipse tutorial wrote:

<h:outputLabel value="Welcome #{loginBean.name}"></h:outputLabel>

This was the cause of the problem and the Stack Overflow author of the answer made some pretty strong remarks about whomever writes this in tutorials. I concurred. The fix is:

<h:outputText value="Welcome #{loginBean.name}"></h:outputText>

The tutorial also failed to use CDI correctly but that was a simple fix.

Here is the final version of the pom.xml file. Final, that is, until I discover some other component of the Java EE 6 Web profile that is missing from the org.apache.openejb.javaee-api.

<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/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.kenfogel</groupId>
   <artifactId>JSFExample01</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>war</packaging>
   <name>JSF Example</name>
   <description>JSF 2.0 Tools Tutorial from Eclipse</description>
   <dependencies>
      <dependency>
         <groupId>junit</groupId>
         <artifactId>junit</artifactId>
         <version>4.11</version>
         <scope>test</scope>
      </dependency>
      <!-- Apache OpenEJB -->
      <dependency>
         <groupId>org.apache.openejb</groupId>
         <artifactId>javaee-api</artifactId>
         <version>6.0-5</version>
         <scope>provided</scope>
      </dependency>
      <!-- Apache MyFaces library that is included with TomEE 
           but not considered  part of the javaee-api -->
      <dependency>
         <groupId>org.apache.myfaces.core</groupId>
         <artifactId>myfaces-impl-ee6</artifactId>
         <version>2.1.1</version>
         <scope>provided</scope>
      </dependency>
   </dependencies>
   <build>
      <pluginManagement>
         <plugins>
            <!--This plugin's configuration is used to store 
                Eclipse m2e settings only. It has no influence 
                on the Maven build itself. Appears harmless in 
                NetBeans -->
            <plugin>
               <groupId>org.eclipse.m2e</groupId>
               <artifactId>lifecycle-mapping</artifactId>
               <version>1.0.0</version>
               <configuration>
                  <lifecycleMappingMetadata>
                     <pluginExecutions>
                        <pluginExecution>
                           <pluginExecutionFilter>
                              <groupId>some-group-id</groupId>
                              <artifactId>some-artifact-id
                              </artifactId>
                              <versionRange>[1.0.0,)</versionRange>
                              <goals>
                                 <goal>some-goal</goal>
                              </goals>
                           </pluginExecutionFilter>
                           <action>
                              <execute>
                                 <runOnIncremental>false
                                 </runOnIncremental>
                              </execute>
                           </action>
                        </pluginExecution>
                     </pluginExecutions>
                  </lifecycleMappingMetadata>
               </configuration>
            </plugin>
            <!-- Java Persistence API settings -->
            <plugin>
               <groupId>org.apache.openjpa</groupId>
               <artifactId>openjpa-maven-plugin</artifactId>
               <version>2.3.0</version>
               <configuration>
                  <includes>**/entities/*.class</includes>
                  <excludes>**/entities/XML*.class</excludes>
                  <addDefaultConstructor>true
                  </addDefaultConstructor>
                  <enforcePropertyRestrictions>true
                  </enforcePropertyRestrictions>
               </configuration>
               <!-- Maven settings not supported by Eclipse 
                    without the plugin above. NetBeans is fine with
                    with or without the plugin above -->
               <executions>
                  <execution>
                     <id>enhancer</id>
                     <phase>process-classes</phase>
                     <goals>
                        <goal>enhance</goal>
                     </goals>
                  </execution>
               </executions>
               <dependencies>
                  <dependency>
                     <groupId>org.apache.openjpa</groupId>
                     <artifactId>openjpa</artifactId>
                     <!-- set the version to be the same as the 
                          level in your runtime -->
                     <version>2.3.0</version>
                  </dependency>
               </dependencies>
            </plugin>
            <!-- used to compile the sources of your project -->
            <plugin>
               <groupId>org.apache.maven.plugins</groupId>
               <artifactId>maven-compiler-plugin</artifactId>
               <version>3.1</version>
               <!-- Java version -->
               <configuration>
                  <source>1.7</source>
                  <target>1.7</target>
               </configuration>
            </plugin>
            <!-- used during the test phase of the build 
                 lifecycle to execute the unit tests of 
                 an application -->
            <plugin>
               <groupId>org.apache.maven.plugins</groupId>
               <artifactId>maven-surefire-plugin</artifactId>
               <version>2.16</version>
            </plugin>
            <!-- responsible for collecting all artifact 
                 dependencies, classes and resources of the web 
                 application and packaging them into a 
                 war file -->
            <plugin>
               <groupId>org.apache.maven.plugins</groupId>
               <artifactId>maven-war-plugin</artifactId>
               <version>2.4</version>
               <configuration>
                  <failOnMissingWebXml>false</failOnMissingWebXml>
                  <webXml>src/main/webapp/WEB-INF/web.xml</webXml>
               </configuration>
            </plugin>
         </plugins>
      </pluginManagement>
   </build>
   <!-- Repository to use if required files are not in the local 
        repository -->
   <repositories>
     <repository>
       <id>apache-snapshot</id>
       <name>Apache Snapshot Repository</name>
       <url>https://repository.apache.org/content/groups/snapshots/
       </url>
     </repository>
   </repositories>
   <properties>
      <project.build.sourceEncoding>UTF-8
      </project.build.sourceEncoding>
   </properties>
</project>

Please let me know if you see any errors. The fix for the Eclipse lifecycle error has meaningless information in it because I could not find any meaningful values. What I saw all appeared quite arbitrary.

I think that I can now begin planning the curriculum for my courses.

Read the original blog entry...

More Stories By Ken Fogel

In 1980 I bought for myself the most wonderful toy of the day, the Apple ][+. Obsession followed quickly and by 1983 I was writing software for small and medium sized businesses in Montreal for both the Apple and the IBM PC under the company name Omnibus Systems. In the evenings I taught continuing education courses that demystified the computer to the first generation of workers who found themselves with their typewriter on the scrap heap and a PC with WordStar taking its place.

In 1990 I was invited to join the faculty at Dawson College in the Computer Science Technology program. When I joined the program the primary language was COBOL and my responsibility was to teach small systems languages such as BASIC and C/C++.

Today I am now the chairperson and program coordinator of the Computer Science Technology program at Dawson. The program's primary language is Java and the focus is on enterprise programming.

I like to write about the every day problems my students and I face in using various languages and platforms to get the job done. And from time to time I stray from the path and write about what I plan to do, what I actually get around to doing, and what I imagine I am doing.

@omniprof

Latest Stories
Concerns about security, downtime and latency, budgets, and general unfamiliarity with cloud technologies continue to create hesitation for many organizations that truly need to be developing a cloud strategy. Hybrid cloud solutions are helping to elevate those concerns by enabling the combination or orchestration of two or more platforms, including on-premise infrastructure, private clouds and/or third-party, public cloud services. This gives organizations more comfort to begin their digital tr...
In very short order, the term "Blockchain" has lost an incredible amount of meaning. With too many jumping on the bandwagon, the market is inundated with projects and use cases that miss the real potential of the technology. We have to begin removing Blockchain from the conversation and ground ourselves in the motivating principles of the technology itself; whether it is consumer privacy, data ownership, trust or even participation in the global economy, the world is faced with serious problems ...
Data center, on-premise, public-cloud, private-cloud, multi-cloud, hybrid-cloud, IoT, AI, edge, SaaS, PaaS... it's an availability, security, performance and integration nightmare even for the best of the best IT experts. Organizations realize the tremendous benefits of everything the digital transformation has to offer. Cloud adoption rates are increasing significantly, and IT budgets are morphing to follow suit. But distributing applications and infrastructure around increases risk, introdu...
Cloud Storage 2.0 has brought many innovations, including the availability of cloud storage services that are less expensive and much faster than previous generations of cloud storage. Cloud Storage 2.0 has also delivered new and faster methods for migrating your premises storage environment to the cloud and the concept of multi-cloud. This session will provide technical details on Cloud Storage 2.0 and the methods used to efficiently migrate from premises-to-cloud storage. This session will als...
For enterprises to maintain business competitiveness in the digital economy, IT modernization is required. And cloud, with its on-demand, elastic and scalable principles has resoundingly been identified as the infrastructure model capable of supporting fast-changing business requirements that enterprises are challenged with, as a result of our increasingly connected world. In fact, Gartner states that by 2022, 28% of enterprise IT spending will have shifted to cloud. But enterprises still must d...
Cloud-Native thinking and Serverless Computing are now the norm in financial services, manufacturing, telco, healthcare, transportation, energy, media, entertainment, retail and other consumer industries, as well as the public sector. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time to wait for long development cycles that pro...
Most modern computer languages embed a lot of metadata in their application. We show how this goldmine of data from a runtime environment like production or staging can be used to increase profits. Adi conceptualized the Crosscode platform after spending over 25 years working for large enterprise companies like HP, Cisco, IBM, UHG and personally experiencing the challenges that prevent companies from quickly making changes to their technology, due to the complexity of their enterprise. An accomp...
Moving to Azure is the path to digital transformation, but not every journey is effective. Organizations that start with a cohesive, well-planned migration strategy can avoid common mistakes and stay a step ahead of the competition. Learn from Atmosera CEO, Jon Thomsen about the opportunities and challenges found in three pivotal phases of the journey to the cloud: Evaluation and Architecting, Migration and Management, and Optimization & Innovation. In each phase, there are distinct insights tha...
Public clouds dominate IT conversations but the next phase of cloud evolutions are "multi" hybrid cloud environments. The winners in the cloud services industry will be those organizations that understand how to leverage these technologies as complete service solutions for specific customer verticals. In turn, both business and IT actors throughout the enterprise will need to increase their engagement with multi-cloud deployments today while planning a technology strategy that will constitute a ...
Isomorphic Software is the global leader in high-end, web-based business applications. We develop, market, and support the SmartClient & Smart GWT HTML5/Ajax platform, combining the productivity and performance of traditional desktop software with the simplicity and reach of the open web. With staff in 10 timezones, Isomorphic provides a global network of services related to our technology, with offerings ranging from turnkey application development to SLA-backed enterprise support. Leadin...
On-premise or off, you have powerful tools available to maximize the value of your infrastructure and you demand more visibility and operational control. Fortunately, data center management tools keep a vigil on memory contestation, power, thermal consumption, server health, and utilization, allowing better control no matter your cloud's shape. In this session, learn how Intel software tools enable real-time monitoring and precise management to lower operational costs and optimize infrastructure...
Every organization is facing their own Digital Transformation as they attempt to stay ahead of the competition, or worse, just keep up. Each new opportunity, whether embracing machine learning, IoT, or a cloud migration, seems to bring new development, deployment, and management models. The results are more diverse and federated computing models than any time in our history.
Andrew Keys is co-founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settlement products to hedge funds and investment banks. After, he co-founded a revenue cycle management company where he learned about Bitcoin and eventually Ethereum.
At CloudEXPO Silicon Valley, June 24-26, 2019, Digital Transformation (DX) is a major focus with expanded DevOpsSUMMIT and FinTechEXPO programs within the DXWorldEXPO agenda. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of business. Only 12% still survive. Similar percentages are found throug...
Data center, on-premise, public-cloud, private-cloud, multi-cloud, hybrid-cloud, IoT, AI, edge, SaaS, PaaS... it's an availability, security, performance and integration nightmare even for the best of the best IT experts. Organizations realize the tremendous benefits of everything the digital transformation has to offer. Cloud adoption rates are increasing significantly, and IT budgets are morphing to follow suit. But distributing applications and infrastructure around increases risk, introdu...