Category Archives: Java EE

Developing Java EE 6 Applications With TomEE and NetBeans

I’ve found that one of the most productive ways of developing Java EE applications is by using NetBeans and the TomEE application server.  For those of you that haven’t used TomEE before, it’s a Java EE 6 Web Profile certified stack that sits on top of Apache Tomcat.

As TomEE is Java EE 6 web profile certified, it supports the following technologies (all via Apache products) out of the box:

  • CDI
  • EJB
  • JPA
  • JSF
  • JSP
  • JSTL
  • JTA
  • Servlet
  • Javamail
  • Bean Validation

If you want / need to use JMS or JAX-RS/WS, then there’s an additional distribution called TomEE+ that provides support for these features.

I prefer to use Maven for project management / builds / testing etc which integrates well with NetBeans.

Using NetBeans, you can easily create a TomEE compatible Maven project by creating a new Maven Project from Archetype within the NetBeans New Project wizard.

Maven

The “tomee-webapp-archetype” will create a basic Web Application that’s defined and ready to deploy against TomEE.

Within the generated pom.xml file, we can see the important TomEE specific aspects are the use of OpenEJB for the EE api’s

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

and the use of the TomEE Maven plugin

<plugin>
        <groupId>org.apache.openejb.maven</groupId>
        <artifactId>tomee-maven-plugin</artifactId>
        <version>1.0.1</version>
</plugin>

Using the TomEE Maven plugin allows the project to be built and deployed to TomEE (without having to download TomEE!). This is useful for building and compiling from the command line. To get Maven to download TomEE, deploy your project to it and then start TomEE up, use the command

mvn tomee:run

Having said that, I prefer to use NetBeans to control running my projects as this provides more advanced features such as hot deployment of JSP/JSF, controlled execution of tests etc.

To run the project from within NetBeans, simply open up the pom.xml from the File | Open Project wizard in NetBeans. NetBeans is clever enough to open Maven projects which then function just like a standard NetBeans project. Select the “Run” option and NetBeans will ask which application server to run the application on. The is no direct support for TomEE, (i.e. you don’t see an Application Server of type TomEE in the NetBeans server configuration page) but since TomEE is based on Tomcat, to define a TomEE server, you just need to create a “Apache Tomcat” server and specify the server location to that of a previously downloaded TomEE instance.

That’s pretty much all that is involved in getting up and running with TomEE and NetBeans. TomEE offers a fast Java EE 6 certified stack that provides for rapid development and deployment of applications, whereas NetBeans 7.3 provides excellent tooling to support TomEE and Java EE development.

Creating Calendar Based Timers in Java EE 6

Java EE 6 allows developers to create application timers that are initialized when either a Stateless Session Bean, a Singleton Bean or a Message Driven Bean are deployed to the application server.

To indicate that a method on any of these beans is to be invoked on a timed basis, the method must be annotated with either the @Schedule annotation (for single timer schedules), or the @Schedules annotation (for multiple timer schedules).

The code below shows a very simple Stateless Session Bean configured with 2 scheduled timers. The first timer is configured with one schedule whereas the second is configured with 2 schedules.

package com.acme.timer;

import javax.ejb.Schedule;
import javax.ejb.Schedules;
import javax.ejb.Stateless;
import javax.ejb.Timer;

@Stateless
public class CalendarTimer {

  @SuppressWarnings("unused")
  @Schedule(second = "*/10",
            minute = "*",
            hour = "8-17",
            dayOfWeek = "Mon-Fri",
            dayOfMonth = "*",
            month = "*",
            year = "*",
            info = "Scheduled Timer")
  private void scheduledTimeout(final Timer t) {
    System.out.println(t.getInfo().toString() + " called at: " + new java.util.Date()); }

  @SuppressWarnings("unused")
  @Schedules({ 
    @Schedule(second = "15",
              minute = "*",
              hour = "8-17",
              dayOfWeek = "Mon-Fri",
              dayOfMonth = "*",
              month = "*",
              year = "*",
              info = "2nd Scheduled Timer"),
    @Schedule(second = "45",
              minute = "*",
              hour = "8-17",
              dayOfWeek = "Mon-Fri",
              dayOfMonth = "*",
              month = "*",
              year = "*",
              info = "2nd Scheduled Timer")
  })
  private void scheduledTimeout2(final Timer t) {
    System.out.println(t.getInfo().toString() + " called at: " + new java.util.Date()); System.out.println(); 
  }
}

As can be seen, the first timer is annotated with the @Schedule annotation. This annotation takes several parameters that define the timer schedule:

second Number of seconds: 0 through 59
minute Number of minutes: 0 through 59
hour Number of hours: 0 through 23
dayOfWeek Day of the week.  This can take textual values (Sun, Mon, Tue, Wed, Thu, Fri, Sat) or numerical values 0 through 7 (both 0 and 7 indicate Sunday)
dayOfMonth Day of the month. This can take textual values (1st, 2nd etc), or numeric values 1 through 31. Negative values can also be used to indicate days before the end of the month. The value Last can also be used to indicate the last day of the month.
month Month of the year. This can take textual values (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec) or numerical values 1 through 12
year The year. This can take numeric years in the format yyyy.
info Additional information passed to the timer function.

The table above shows the allowable values that can be used for each expression used to build up a schedule. These values can also be expanded into expressions to make more complex schedules.

Wildcard: A wildcard character (*) is used to indicate that the schedule will fire for every valid value of the specific operand. For example, setting the value second=”0″, minute=”*” would cause a timer to be invoked every minute at 0 seconds.

Lists: Comma separated lists of values allow timers to occur at every value in the list rather than at all valid values as specified by the wildcard character.  For example second=”0″, minute=”0, 15, 30, 45″ would cause a timer to be invoked every quarter of an hour.

Ranges: Hypen separated ranges allow timers to occur within the specified range.  For example dayOfMonth=”1-5″ would cause a timer to be invoked every day for the first 5 days of each month.

Intervals: Intervals are defined in the format start/interval and are valid only for hours, minutes and seconds.  An interval is defined as the start value for a timer and then the interval at which a timer will be invoked.  For example hour=”12/1″ would cause a timer to be invoked on the hour, every hour in an afternoon. It’s possible to combine the wildcard and interval expressions to cause a timer to be invoked every x hours, minutes or seconds.  For example  minute=”*/10″ would cause a timer to be invoked every 10 minutes.

The second method in the example above shows how 2 different schedules can be applied to a timer.  In this instance, the method is annotated with the @Schedules annotation rather than the @Schedule annotation.

Using GlassFish from Eclipse

When I think of developing apps using GlassFish, I usually think of using NetBeans for the development. As you’d expect however, Oracle provides some good tooling to allow you to develop against GlassFish from within Eclipse – even to the point of installing the application server directly from within Eclipse.  So, how is this done?

Installing GlassFish Server Tools

Contrary to what you’d expect, to install GlassFish tooling, you don’t use the Eclipse Marketplace for installation.  To install, right click within the “Servers” pane and select “New | Server” to display the “Define a New Server” dialog. On this dialog, select “Download additional server adaptors” and in the resulting dialog select “Oracle GlassFish Server Tools”.GlassFish Server Tools

After accepting the licence conditions, the GlassFish Server tools will be downloaded upon which you’ll need to restart Eclipse to complete the installation.

Defining a GlassFish Instance

After a restart, opening the ”Define a New Server” dialog will show that GlassFish support has been added.

Define New Server

Choose the GlassFish server you wish to use and press the “Next” button.  On the resulting dialog, you can choose to locate an existing copy of GlassFish, or install an new instance via the “Install Server” button if you don’t already have GlassFish installed.

GlassFish Runtime

One point to note here is that, if you install a new instance of GlassFish, you may then need to browse through the install folder to locate the “glassfish” folder within.  You will see that this is necessary because the “Next>” button will be disabled as you’ve installed an instance of GlassFish, but not correctly identified its location to Eclipse.

When you’ve selected (and installed if necessary) a GlassFish instance, complete the wizard to define the admninistrator credentials of the server.

GlassFish Tools

After creating a GlassFish server instance in Eclipse, you can develop and test Java EE 6 applications against it.  The GlassFish tools provides additional support to assist in this.  For example, right clicking on the server in the “Servers” tab allows you to manage the server or get additional information or support.

GlassFish Tools

New wizards are also installed into Eclipse to assist when creating GlassFish facets such as JMS or JDBC resources as shown below.  These wizards are available on the standard “File | New | Other” dialog under the “GlassFish” folder.

GlassFish Facets

Review of EJB 3.1 Cookbook by Richard M. Reese

I’ve just posted my review of “EJB 3.1 Cookbook” over on Develop In Java.

In summary:

EJB 3.1 Cookbook is an excellent resource in an EJB developer’s library. It’s not the sort of book you pick up and read from cover to cover rather a useful resource that you pick up when you think “How do I do xxx in EJB?”. With over 100 recipes this book is recommended to developers using EJB technologies.

I very much liked this book and can imagine using it frequently. You can read the whole review here.

How to improve your JPA Performance

James Sutherland has published a blog post showing how to significantly increase JPA performance.

In the post, he provides 11 different optimizations, such as pagination and query caching that can be applied to JPA.  The EclipseLink JPA 3.2 implementation of JPA is used throughout the post.

This is a good article and well worth reading by anyone that develops database systems using JPA.