Session EJB and Servlet on Different JBoss Instances

Internal

• EJB Concepts - Invoking into EJBs

Overview

This example describes how a client component (servlet) deployed on a different JBoss instance looks up an EJB and makes a remote invocation.

GitHub Examples

A servlet that calls into an EJB https://github.com/NovaOrdis/playground/tree/master/jee/ejb/stateless-and-servlet-different-jboss-instances

An EJB that calls into another EJB https://github.com/NovaOrdis/playground/tree/master/jee/ejb/ejb-over-rest/ejb-native-remoting-to-ejb

The Business Interface Must be Market as @Remote

The business interface must be marked with the @Remote annotation, otherwise the EJB won't be accessible remotely. If the business interface is not annotated with @Remote, the JNDI lookup on the client side, even if using the correct EJB client context, will fail to locate the EJB.

Business Interface Type Access

The calling servlet needs the business interface type to make the call, so the classes related to the business interface will have to be packaged within the WAR. Since those classes are also needed in the EJB deployment unit, the best strategy is to develop those as part of shared "common-types" Maven module, and pull its artifact both in the WAR and the EJB JAR. The example linked above showcases this approach. A Maven "recipe" to include some dependencies in a simple JAR artifact is described here: Include Dependencies in JAR Artifact.

EJB Lookup

Configure EJB Client Context by deploying jboss-ejb-client.xml

The consuming component, the servlet in this case, needs a way to look up the EJB reference that has been deployed on a remote JBoss instance. This is done internally by JBoss instance using a JBoss-specific mechanism named EJB client context. In order to use the EJB client context that knows how to invoke into the remote JBoss instance, and not the default EJB client context, the WAR must contain a JBoss-specific deployment descriptor named jboss-ejb-client.xml in its /WEB-INF directory.

<jboss-ejb-client xmlns:xsi="urn:jboss:ejb-client:1.2" 
                  xsi:noNamespaceSchemaLocation="jboss-ejb-client_1_2.xsd">
    <client-context>
        <ejb-receivers>
            <remoting-ejb-receiver outbound-connection-ref="remote-ejb-container-1"/>
        </ejb-receivers>
    </client-context>
</jboss-ejb-client>

Upon deployment, the presence of the jboss-ejb-client.xml deployment descriptor triggers a specific runtime configuration that allows the servlet to invoke into the remote EJB. The JBoss instance the servlet is deployed into must be configured in a specific way to support jboss-ejb-client.xml content. The configuration is described here:

JBoss Instance Configuration to Support Deployed EJB Client Contexts

More details about jboss-ejb-client.xml are available here:

jboss-ejb-client.xml

More details about the EJB client context are available here:

EJB Client Context

Use a Specific JNDI Name

Use a JNDI name that complies with the following pattern:

ejb:[/<application-name>/]<module-name>/<bean-name>!<view-class>

Example:

ejb:/stateless-ejb-example/SimpleStatelessBean!io.novaordis.playground.jee.ejb.stateless.SimpleStateless

The "ejb:" name space is essential, it is what seems to be engaging the correct EJB client context, if "java:global" is used, the look up will fail.

The !<view-class> part is also essential, if not used, the JNDI lookup will return an org.jboss.ejb.client.naming.ejb.EjbNamingContext instance, instead of a business interface type.

JNDI Lookup Code

The code that does the JNDI lookup is similar to:

SimpleStateless bean = null;

...

try {

   InitialContext  ic = new InitialContext();
   SimpleStateless bean = (SimpleStateless)ic.lookup(
       "ejb:/stateless-ejb-example/SimpleStatelessBean!io.novaordis.playground.jee.ejb.stateless.SimpleStateless");
}
catch(Exception e) {
    ...
}

@EJB

The equivalent @EJB injection would be:

@EJB(mappedName = "ejb:/stateless-ejb-example/SimpleStatelessBean!io.novaordis.playground.jee.ejb.stateless.SimpleStateless")
private SimpleStateless bean;

"mappedName" and "lookup" can be used interchangeably:

@EJB(lookup = "ejb:/stateless-ejb-example/SimpleStatelessBean!io.novaordis.playground.jee.ejb.stateless.SimpleStateless")
private SimpleStateless bean;

For more details, see

@EJB

EJB Invocation

Once the EJB reference is obtained from JNDI, business interface methods can be called on its reference:

...
bean.methodOne("something from servlet");