8.2. Creating Enterprise Bean Projects

Procedure 8.1. Create an EJB Project in Red Hat JBoss Developer Studio

1. Create new project

   To open the New EJB Project wizard, navigate to the File menu, select New, and then EJB Project.
   

   Figure 8.1. New EJB Project wizard

2. Specify Details

   Supply the following details:
   • Project name.
     As well as the being the name of the project that appears in Red Hat JBoss Developer Studio this is also the default filename for the deployed JAR file.
   • Project location.
     The directory where the project's files will be saved. The default is a directory in the current workspace.
   • Target Runtime.
     This is the server runtime used for the project. This will need to be set to the same JBoss EAP 6 runtime used by the server that you will be deploying to.
   • EJB module version. This is the version of the EJB specification that your enterprise beans will comply with. Red Hat recommends using 3.1.
   • Configuration. This allows you to adjust the supported features in your project. Use the default configuration for your selected runtime.
   Click Next to continue.

3. Java Build Configuration

   This screen allows you to customize the directories will contain Java source files and the directory where the built output is placed.
   Leave this configuration unchanged and click Next.

4. EJB Module settings

   Check the Generate ejb-jar.xml deployment descriptor checkbox if a deployment descriptor is required. The deployment descriptor is optional in EJB 3.1 and can be added later if required.
   Click Finish and the project is created and will be displayed in the Project Explorer.
   

   Figure 8.2. Newly created EJB Project in the Project Explorer

5. Add Build Artifact to Server for Deployment

   Open the Add and Remove dialog by right-clicking on the server you want to deploy the built artifact to in the server tab, and select "Add and Remove".
   Select the resource to deploy from the Available column and click the Add button. The resource will be moved to the Configured column. Click Finish to close the dialog.
   

   Figure 8.3. Add and Remove dialog

Procedure 8.2. Create an EJB Archive project in Maven

1. Create the Maven project

   An EJB project can be created using Maven's archetype system and the ejb-javaee6 archetype. To do this run the mvn command with parameters as shown:

    mvn archetype:generate -DarchetypeGroupId=org.codehaus.mojo.archetypes -DarchetypeArtifactId=ejb-javaee6 

   Maven will prompt you for the groupId, artifactId, version and package for your project.

   [localhost]$ mvn archetype:generate -DarchetypeGroupId=org.codehaus.mojo.archetypes -DarchetypeArtifactId=ejb-javaee6
   [INFO] Scanning for projects...
   [INFO]                                                                         
   [INFO] ------------------------------------------------------------------------
   [INFO] Building Maven Stub Project (No POM) 1
   [INFO] ------------------------------------------------------------------------
   [INFO] 
   [INFO] >>> maven-archetype-plugin:2.0:generate (default-cli) @ standalone-pom >>>
   [INFO] 
   [INFO] <<< maven-archetype-plugin:2.0:generate (default-cli) @ standalone-pom <<<
   [INFO] 
   [INFO] --- maven-archetype-plugin:2.0:generate (default-cli) @ standalone-pom ---
   [INFO] Generating project in Interactive mode
   [INFO] Archetype [org.codehaus.mojo.archetypes:ejb-javaee6:1.5] found in catalog remote
   Define value for property 'groupId': : com.shinysparkly
   Define value for property 'artifactId': : payment-arrangments
   Define value for property 'version':  1.0-SNAPSHOT: : 
   Define value for property 'package':  com.shinysparkly: : 
   Confirm properties configuration:
   groupId: com.company
   artifactId: payment-arrangments
   version: 1.0-SNAPSHOT
   package: com.company.collections
   Y: : 
   [INFO] ------------------------------------------------------------------------
   [INFO] BUILD SUCCESS
   [INFO] ------------------------------------------------------------------------
   [INFO] Total time: 32.440s
   [INFO] Finished at: Mon Oct 31 10:11:12 EST 2011
   [INFO] Final Memory: 7M/81M
   [INFO] ------------------------------------------------------------------------
   [localhost]$

2. Add your enterprise beans

   Write your enterprise beans and add them to the project under the src/main/java directory in the appropriate sub-directory for the bean's package.

3. Build the project

   To build the project, run the mvn package command in the same directory as the pom.xml file. This will compile the Java classes and package the JAR file. The built JAR file is named artifactId-version.jar and is placed in the target/ directory.

Procedure 8.3. Create an EAR Project containing an EJB Project

1. Open the New EAR Application Project Wizard

   Navigate to the File menu, select New, then Project and the New Project wizard appears. Select Java EE/Enterprise Application Project and click Next.
   

   Figure 8.4. New EAR Application Project Wizard

2. Supply details

   Supply the following details:
   • Project name.
     As well as the being the name of the project that appears in Red Hat JBoss Developer Studio this is also the default filename for the deployed EAR file.
   • Project location.
     The directory where the project's files will be saved. The default is a directory in the current workspace.
   • Target Runtime.
     This is the server runtime used for the project. This will need to be set to the same JBoss EAP 6 runtime used by the server that you will be deploying to.
   • EAR version.
     This is the version of the Java Enterprise Edition specification that your project will comply with. Red Hat recommends using 6.
   • Configuration. This allows you to adjust the supported features in your project. Use the default configuration for your selected runtime.
   Click Next to continue.

3. Add a new EJB Module

   New Modules can be added from the Enterprise Application page of the wizard. To add a new EJB Project as a module follow the steps below:

   1. Add new EJB Module

      Click New Module, uncheck Create Default Modules checkbox, select the Enterprise Java Bean and click Next. The New EJB Project wizard appears.

   2. Create EJB Project

      New EJB Project wizard is the same as the wizard used to create new standalone EJB Projects and is described in Section 8.2.1, “Create an EJB Archive Project Using Red Hat JBoss Developer Studio”.
      The minimal details required to create the project are:
      • Project name
      • Target Runtime
      • EJB Module version
      • Configuration
      All the other steps of the wizard are optional. Click Finish to complete creating the EJB Project.
   The newly created EJB project is listed in the Java EE module dependencies and the checkbox is checked.

4. Optional: add an application.xml deployment descriptor

   Check the Generate application.xml deployment descriptor checkbox if one is required.

5. Click Finish

   Two new project will appear, the EJB project and the EAR project

6. Add Build Artifact to Server for Deployment

   Open the Add and Remove dialog by right-clicking in the Servers tab on the server you want to deploy the built artifact to in the server tab, and select Add and Remove.
   Select the EAR resource to deploy from the Available column and click the Add button. The resource will be moved to the Configured column. Click Finish to close the dialog.
   

   Figure 8.5. Add and Remove dialog

Procedure 8.4. Add an Deployment Descriptor to an EJB Project

1. Open the Project

   Open the project in Red Hat JBoss Developer Studio.

2. Add Deployment Descriptor

   Right-click on the Deployment Descriptor folder in the project view and select Generate Deployment Descriptor Stub.
   

   Figure 8.6. Adding a Deployment Descriptor