org.springframework.ejb.access

Class SimpleRemoteStatelessSessionProxyFactoryBean

java.lang.Object

org.springframework.jndi.JndiAccessor

org.springframework.jndi.JndiLocatorSupport

org.springframework.jndi.JndiObjectLocator

org.springframework.ejb.access.AbstractSlsbInvokerInterceptor

org.springframework.ejb.access.AbstractRemoteSlsbInvokerInterceptor

org.springframework.ejb.access.SimpleRemoteSlsbInvokerInterceptor

org.springframework.ejb.access.SimpleRemoteStatelessSessionProxyFactoryBean

All Implemented Interfaces:

Advice, Interceptor, MethodInterceptor, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<Object>, org.springframework.beans.factory.InitializingBean

public class SimpleRemoteStatelessSessionProxyFactoryBean
extends SimpleRemoteSlsbInvokerInterceptor
implements org.springframework.beans.factory.FactoryBean<Object>, org.springframework.beans.factory.BeanClassLoaderAware

Convenient FactoryBean for remote SLSB proxies. Designed for EJB 2.x, but works for EJB 3 Session Beans as well.

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

If you want control over interceptor chaining, use an AOP ProxyFactoryBean with SimpleRemoteSlsbInvokerInterceptor rather than rely on this class.

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 by default 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 best solution is to set the lookupHomeOnStartup property to false, in which case the home will be fetched on first access to the EJB. (This flag is only true by default for backwards compatibility reasons).

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.05.2003

Author:

Rod Johnson, Colin Sampaleanu, Juergen Hoeller

See Also:

RemoteAccessException, AbstractSlsbInvokerInterceptor.setLookupHomeOnStartup(boolean), AbstractSlsbInvokerInterceptor.setCacheHome(boolean), AbstractRemoteSlsbInvokerInterceptor.setRefreshHomeOnConnectFailure(boolean)

Field Summary

Fields inherited from class org.springframework.jndi.JndiLocatorSupport

CONTAINER_PREFIX

Fields inherited from class org.springframework.jndi.JndiAccessor

logger

Constructor Summary

Constructors

Constructor and Description
SimpleRemoteStatelessSessionProxyFactoryBean()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet() Fetches EJB home on startup, if necessary.
Class	getBusinessInterface() Return the business interface of the EJB we're proxying.
Object	getObject()
Class<?>	getObjectType()
boolean	isSingleton()
void	setBeanClassLoader(ClassLoader classLoader)
void	setBusinessInterface(Class businessInterface) Set the business interface of the EJB we're proxying.

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

destroy, doInvoke, getSessionBeanInstance, refreshHome, releaseSessionBeanInstance, setCacheSessionBean

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

getCreateMethod, invokeInContext, isConnectFailure, isHomeRefreshable, lookup, newSessionBeanInstance, refreshAndRetry, removeSessionBeanInstance, setHomeInterface, setRefreshHomeOnConnectFailure

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

create, getHome, invoke, setCacheHome, setExposeAccessContext, setLookupHomeOnStartup

Methods inherited from class org.springframework.jndi.JndiObjectLocator

getExpectedType, getJndiName, setExpectedType, setJndiName

Methods inherited from class org.springframework.jndi.JndiLocatorSupport

convertJndiName, isResourceRef, lookup, lookup, setResourceRef

Methods inherited from class org.springframework.jndi.JndiAccessor

getJndiEnvironment, getJndiTemplate, setJndiEnvironment, setJndiTemplate

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(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 Class getBusinessInterface()

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

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware

afterPropertiesSet

public void afterPropertiesSet()
                        throws NamingException

Description copied from class: AbstractSlsbInvokerInterceptor

Fetches EJB home on startup, if necessary.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Overrides:

afterPropertiesSet in class AbstractSlsbInvokerInterceptor

Throws:

NamingException

See Also:

AbstractSlsbInvokerInterceptor.setLookupHomeOnStartup(boolean), AbstractSlsbInvokerInterceptor.refreshHome()

getObject

public Object getObject()

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<Object>

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<Object>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<Object>