Integrate EJB Services with WebSphere Process Server

This article shows you how to use IBM WebSphere Process Server Version 6 and IBM WebSphere Integration Developer Version 6 to integrate existing J2EE applications without making changes to them.


Peter Xu (, Senior Consulting I/T Specialist, IBM Software Service for WebSphere, EMC

Peter Xu is a Senior Consultant with IBM Software Services for WebSphere group. Consultants with Software Services for WebSphere help customers deploy IBM products into their organizations. Peter provides consulting services, education, and mentoring on J2EE technologies, and specifically WebSphere and WebSphere Studio products to Fortune 500 clients. You can reach him at

02 February 2006


IBM® WebSphere® Process Server is a runtime platform for business integration solutions developed using IBM WebSphere Integration Developer. Many existing business functions for a company's IT infrastructure are written based on Java™ 2 Enterprise Edition (J2EE) stateless Enterprise Java Beans (EJB). When you design and implement new business process integration applications, it is important that you have the ability to leverage and integrate these functions easily.

Overview diagram

The scenario we use in this article is pretty straightforward. It consists of one Service Component Architecture (SCA) module that has a Java component, which uses the imported EJB service.

Figure 1. Module overview
Module overview

Software prerequisites

You need to install:

  • WebSphere Integration Developer V6
  • WebSphere Process Server V6 test environment

This article assumes that you have some knowledge of J2EE and have used WebSphere Studio Application Developer or Rational Application Developer before. To learn more about these products, visit developerWorks.


In this section, we develop a sample EJB application and an SCA module that utilizes the EJB service.

You can begin by creating the enterprise application, package, and EJB session.

  1. Create an enterprise application called Echo with one EJB module, EchoEJB

  2. Create a package called

  3. Create a stateless EJB session called Bean Echo

    Figure 2. Create an EJB
    Create an EJB
  4. Create a simple method called echoSimple, and promote it the remote interface:

    public String echoSimple(String name){
    		System.out.println("inside echoSimple");
    		return "Hello, " + name;
  5. Open the ejb deployment descriptor, and notice the default JNDI name for the EJB:

    Figure 3. EJB JNDI name
    EJB JNDI name
  6. Create an EJB client project and jar that will be used later in the SCA module.

  7. Right-click and select EchoEJB => EJB Client Jar => Create EJB Client Project and enter EchoEJBClient in the name field.

    Figure 4. EJB Client
    EJB Client
  8. Run and test the EJB application (see Figure 5).

    Figure 5. Testing the EJB
    Testing the EJB

Now, that we've created the EJB, let's integrate it.

Create an EJB component

To integrate the EJB into the WebSphere Process Server SCA component:

  1. Create a module called InvokeEcho.

  2. From the Dependencies editor, select EchoEJBClient as the dependent Java project and click Add to add EchoEJBCLient as the dependent Java project.

    Figure 6. Add dependencies
    Add dependencies

    It is important to add module dependency at this point. When we add the interface later, the wizard will be able to find the remote EJB interface.

  3. From the Assembly editor, open the module, InvokeEcho in Assembly editor, add an Import component on the canvas. Change the name to EchoEJB.

    Figure 7. Add the Import
    Add the import
  4. Add the interface for the import:

    1. Click the Add Interface icon.

    2. In the resulting window, select Show Java.

    3. Enter echo in the Filter by interface field.

    4. Select Echo from Matching interfaces . This interface is from project /EchoEJBClient/ejbModule (see Figure 8).

      Figure 8. Add Interface for Import
      Add Interface for Import
  5. Click Ok and save the module diagram.

    Figure 9. Import with the interface
    Import with the interface
  6. Generate the Session EJB Binding.

    1. Right-click the EchoEJB import and select Generate Binding => Stateless Session Bean Binding.

      Figure 10. Add Binding
      Add Binding
    2. Notice how the icon changed in the import (see Figure 11).

      Figure 11. Import with Interface Binding
      Import with Interface Binding
    3. Select the Properties view and the Binding tab. You can see that the JNDI name field is now populated (see Figure 12).

      Figure 12. Specify JNDI name for Binding
      Specify JNDI name for Binding

Create a Java Component

To create a Java Component:

  1. Drag and drop a Java Component onto the assembly canvas and change the name to InvokeEcho (see Figure 13).

    Figure 13. Add the Java Component
    Add the Java Component
  2. Create an interface called InvokeEchoInterface with a one-way operation callEcho and one input parameter:

    Figure 14. Create an Interface
    Create an Interface
  3. Select the Java component and add an interface for it, InvokeEchoInterface.

  4. Wire the InvokeEcho and EchoEJB together (see Figure 15).

    Figure 15. Wire Java and Import the Component
    Wire Java and Import the Component

    Notice that a reference EchoPartner has been generated. We will use it in the Java Component implementation (see Figure 16).

    Figure 16. Partner reference
    Partner reference
  5. Select and right-click the Java Component and generate the default Java implementation. When the implementation opens, replace the callEcho method with the following code:

            try {
                System.out.println("in callEcho");
    		    // Create an instance of the ServiceManager
    	        ServiceManager serviceManager = new ServiceManager();
    	        Echo echo= (Echo)serviceManager.locateService("EchoPartner");
    	        String result = echo.echoSimple(name);
    	        System.out.println("called imported EJB, and response is " + result);
            } catch (Exception e) {

Running and testing the scenario

To test the scenario:

  1. Right-click InvokeEcho and select Test Component.

  2. In the test configuration, remove the emulator for EchoEJB, since we want to invoke the real EJB implementation.

  3. Enter a value for the name field and click Continue.

    Figure 17. Component Test 1
    Component Test 1
  4. Notice the expected result.

    Figure 18. Component Test 2
    Component Test 2

    Notice the result from the System.out.

    Figure 19. Component Test 3
    Component Test 3

Congratulations, you've successfully imported and invoked the Echo EJB from the SCA component, InvokeEcho. In this scenario, the SCA module and the EJB service are running on the same server.


This article helped you implement a WebSphere Process Server solution that integrates EJB services. As you can see, using EJB services from an SCA component is easy to do. Reusing EJB-based services in this way creates tremendous opportunities for integration products, such as WebSphere Process Server.


The author would like to thank Sam Kaipa for reviewing this article.



developerWorks: Sign in

Required fields are indicated with an asterisk (*).

Need an IBM ID?
Forgot your IBM ID?

Forgot your password?
Change your password

By clicking Submit, you agree to the developerWorks terms of use.


The first time you sign into developerWorks, a profile is created for you. Information in your profile (your name, country/region, and company name) is displayed to the public and will accompany any content you post, unless you opt to hide your company name. You may update your IBM account at any time.

All information submitted is secure.

Choose your display name

The first time you sign in to developerWorks, a profile is created for you, so you need to choose a display name. Your display name accompanies the content you post on developerWorks.

Please choose a display name between 3-31 characters. Your display name must be unique in the developerWorks community and should not be your email address for privacy reasons.

Required fields are indicated with an asterisk (*).

(Must be between 3 – 31 characters.)

By clicking Submit, you agree to the developerWorks terms of use.


All information submitted is secure.

Dig deeper into WebSphere on developerWorks

ArticleTitle=Integrate EJB Services with WebSphere Process Server