Stripes EJB3 Interceptor

Skip to end of metadata
Go to start of metadata

Stripes EJB3 Interceptor

http://code.google.com/p/stripes-ejb3/

Stripes EJB3 Interceptor is superseded by Stripes Injection Enricher
Stripes Injection Enricher satisfies injection points specified declaratively using standard Java EE annotations (@EJB, @Inject and @Resource).

Stripes already integrates with Spring to provide your ActionBean classes access to Spring resources in the form of configured Spring beans.

This extension is very similar to the Spring Interceptor, in fact it was inspired by it.

Installation and Configuration

Add Stripes EJB3 Interceptor JAR file to your classpath.

Maven Configuration
<dependency>
    <groupId>com.samaxes.stripes.ejb3</groupId>
    <artifactId>stripejb3</artifactId>
    <version>1.0.3</version>
</dependency>

Configuring Stripes for EJB3 Interceptor

Like with the Spring Interceptor you need to configure your StripesFilter. In your web.xml file locate the initialization parameters for the Stripes Filter. If you do not already have the Interceptor.Classes parameter defined, add the following:

Using the EJB Interceptor with Stripes >= 1.5
<init-param>
    <param-name>Interceptor.Classes</param-name>
    <param-value>com.samaxes.stripes.ejb3.EJBInterceptor</param-value>
</init-param>
<!-- or -->
<init-param>
    <param-name>Extension.Packages</param-name>
    <param-value>com.samaxes.stripes.ejb3</param-value>
</init-param>
Using the EJB Interceptor with Stripes <= 1.4
<init-param>
    <param-name>Interceptor.Classes</param-name>
    <param-value>
        com.samaxes.stripes.ejb3.EJBInterceptor,
        net.sourceforge.stripes.controller.BeforeAfterMethodInterceptor
    </param-value>
</init-param>

The parameter tells Stripes to use the EJB interceptor, and also not to stop using the Before/After method interceptor (which is configured by default). That's all, we're done with configurations.

Accessing EJB Beans in your ActionBean

Stripes uses the EJBInterceptor to inject EJB beans into ActionBeans when instantiated. To do this, it must be told how to inject beans and what to inject. As opposed to pushing the linkage out to an XML file, a simple annotation is used. The standard case would look something like this:

Injecting a EJB bean into an ActionBean
// Inject any properties that are annotated
@EJBBean("bugManager")
private BugManager bugManager;

// Inject any methods that are annotated
@EJBBean("bugManager")
public void setBugManager(BugManager bugManager) {
    this.bugManager = bugManager;
}

This extension also supports auto-wire by name. If you omit the value of the @EJBBean annotation thusly:

Auto-wiring of EJB beans in an ActionBean
// Inject any properties that are annotated
@EJBBean
private BugManager bugManager;

// Inject any methods that are annotated
@EJBBean
public void setBugManager(BugManager bugManager) {
    this.bugManager = bugManager;
}

Stripes will attempt to auto-wire by name. The name of the desired bean is derived from the property name or the method name - if the method name starts with 'set' then it is removed and the next character down-cased (following standard JavaBean rules), otherwise the entire method name is taken verbatim. In the example above this yields bugManager. The initial context is then queried to see if it contains a bean called bugManager.

Private and Protected Access

Stripes can inject EJB beans through both method access and field access.
If the JVM's security manager will permit it, Stripes will even inject EJB beans, when requested, into protected, package access and private fields and methods. If the JVM's security manager does not permit this, an exception will be raised explaining the problem.

Local Interface binding

If you are having trouble with JNDI binding and local interfaces use the following:

JBoss

Changing the bean JNDI binding
// your interface
public interface BugManager {
}

// your implementation
@Stateless
@Local(BugManager.class)
@LocalBinding(jndiBinding = "bugManager")
public class BugManagerBean implements BugManager {
}

Glassfish

Injecting a local interface into an ActionBean
// your bean implementation
@Stateless(name = "bugManager", mappedName = "bugManager")
public class BugManager implements com.Manager {
}

// your action bean
@EJB(name = "bugManager", beanInterface = "com.Manager")
public class BugActionBean {
    @EJBBean("java:comp/env/bugManager")
    private BugManager bugManager;
}

Apache Geronimo 2.x

It requires additional configuration of a context in the EJBInterceptor.findEJB() method.

EJBInterceptor.findEJB()
protected static Object findEJB(String name) {
    // Try to lookup using the name provided
    try {
        if (ctx == null) {
            Properties p = new Properties();
            p.setProperty(Context.INITIAL_CONTEXT_FACTORY, "org.openejb.client.LocalInitialContextFactory");
            ctx = new InitialContext(p);
        }
        Object ejb = ctx.lookup(name);
        log.debug("Found EJB bean with name [", name, "]");
        return ejb;
    } catch (NamingException e) {
        throw new StripesRuntimeException("Unable to find EJBBean with name [" + name +
            "] in the initial context.");
    }
}
Injecting a local interface into an ActionBean
@EJBBean("BugManagerLocal")
private BugManagerLocal bugManager;
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.