org.springframework.ejb.access
Class SimpleRemoteStatelessSessionProxyFactoryBean

java.lang.Object
  org.springframework.jndi.AbstractJndiLocator
      org.springframework.ejb.access.AbstractSlsbInvokerInterceptor
          org.springframework.ejb.access.AbstractRemoteSlsbInvokerInterceptor
              org.springframework.ejb.access.SimpleRemoteSlsbInvokerInterceptor
                  org.springframework.ejb.access.SimpleRemoteStatelessSessionProxyFactoryBean

All Implemented Interfaces:

org.aopalliance.aop.Advice, FactoryBean, InitializingBean, org.aopalliance.intercept.Interceptor, org.aopalliance.intercept.MethodInterceptor

public class SimpleRemoteStatelessSessionProxyFactoryBean

extends SimpleRemoteSlsbInvokerInterceptor

implements FactoryBean

Convenient factory for remote SLSB proxies. If you want control over interceptor chaining, use an AOP ProxyFactoryBean with SimpleRemoteSlsbInvokerInterceptor rather than rely on this class.

See AbstractJndiLocator for info on how to specify the JNDI location of the target EJB.

In a bean container, this class is normally best used as a singleton. However, if that bean container pre-instantiates singletons (as do the XML ApplicationContext variants) you may have a problem if the bean container is loaded before the EJB container loads the target EJB. That is because the JNDI lookup will be performed in the init method of this class and cached, but the EJB will not have been bound at the target location yet. The solution is to not pre-instantiate this factory object, but allow it to be created on first use. In the XML containers, this is controlled via the "lazy-init" attribute.

This proxy factory is typically used with an RMI business interface, which serves as super-interface of the EJB component interface. Alternatively, this factory can also proxy a remote SLSB with a matching non-RMI business interface, i.e. an interface that mirrors the EJB business methods but does not declare RemoteExceptions. In the latter case, RemoteExceptions thrown by the EJB stub will automatically get converted to Spring's unchecked RemoteAccessException.

Since:

09-May-2003

Version:

$Id: SimpleRemoteStatelessSessionProxyFactoryBean.java,v 1.9 2004/03/18 02:46:14 trisberg Exp $

Author:

Rod Johnson, Colin Sampaleanu, Juergen Hoeller

See Also:

RemoteAccessException

Field Summary

Fields inherited from class org.springframework.jndi.AbstractJndiLocator

CONTAINER_PREFIX, logger

Constructor Summary

SimpleRemoteStatelessSessionProxyFactoryBean()

Method Summary

void	afterLocated() Initialization hook after the AbstractJndiLocator's located callback.
java.lang.Class	getBusinessInterface() Return the business interface of the EJB we're proxying.
java.lang.Object	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
java.lang.Class	getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean	isSingleton() Is the bean managed by this factory a singleton or a prototype?
void	setBusinessInterface(java.lang.Class businessInterface) Set the business interface of the EJB we're proxying.

Methods inherited from class org.springframework.ejb.access.SimpleRemoteSlsbInvokerInterceptor

invoke

Methods inherited from class org.springframework.ejb.access.AbstractRemoteSlsbInvokerInterceptor

newSessionBeanInstance

Methods inherited from class org.springframework.ejb.access.AbstractSlsbInvokerInterceptor

create, getCachedEjbHome, located, setCacheHome

Methods inherited from class org.springframework.jndi.AbstractJndiLocator

afterPropertiesSet, getJndiEnvironment, getJndiName, getJndiTemplate, isResourceRef, lookup, setJndiEnvironment, setJndiName, setJndiTemplate, setResourceRef

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleRemoteStatelessSessionProxyFactoryBean

public SimpleRemoteStatelessSessionProxyFactoryBean()

Method Detail

setBusinessInterface

public void setBusinessInterface(java.lang.Class businessInterface)

Set the business interface of the EJB we're proxying. This will normally be a super-interface of the EJB remote component interface. Using a business methods interface is a best practice when implementing EJBs.

You can also specify a matching non-RMI business interface, i.e. an interface that mirrors the EJB business methods but does not declare RemoteExceptions. In this case, RemoteExceptions thrown by the EJB stub will automatically get converted to Spring's generic RemoteAccessException.

Parameters:

businessInterface - the business interface of the EJB

getBusinessInterface

public java.lang.Class getBusinessInterface()

Return the business interface of the EJB we're proxying.

afterLocated

public void afterLocated()

Description copied from class: AbstractSlsbInvokerInterceptor

Initialization hook after the AbstractJndiLocator's located callback. This implementation does nothing.

Overrides:

afterLocated in class AbstractSlsbInvokerInterceptor

See Also:

AbstractSlsbInvokerInterceptor.located(java.lang.Object)

getObject

public java.lang.Object getObject()

Description copied from interface: FactoryBean

Return an instance (possibly shared or independent) of the object managed by this factory. As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

Specified by:

getObject in interface FactoryBean

Returns:

an instance of the bean (should never be null)

getObjectType

public java.lang.Class getObjectType()

Description copied from interface: FactoryBean

Return the type of object that this FactoryBean creates, or null if not known in advance. This allows to check for specific types of beans without instantiating objects, e.g. on autowiring.

For a singleton, this can simply return getObject().getClass(), or even null, as autowiring will always check the actual objects for singletons. For prototypes, returning a meaningful type here is highly advisable, as autowiring will simply ignore them else.

Specified by:

getObjectType in interface FactoryBean

Returns:

the type of object that this FactoryBean creates, or null

See Also:

ListableBeanFactory.getBeansOfType(java.lang.Class, boolean, boolean)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the bean managed by this factory a singleton or a prototype? That is, will getObject() always return the same object?

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory.

Specified by:

isSingleton in interface FactoryBean

Returns:

if this bean is a singleton