spring-framework / org.springframework.ejb.access / SimpleRemoteStatelessSessionProxyFactoryBean

SimpleRemoteStatelessSessionProxyFactoryBean

open class SimpleRemoteStatelessSessionProxyFactoryBean : SimpleRemoteSlsbInvokerInterceptor, FactoryBean<Any>, BeanClassLoaderAware

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

See org.springframework.jndi.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.

Author
Rod Johnson

Author
Colin Sampaleanu

Author
Juergen Hoeller

Since
09.05.2003

See Also
org.springframework.remoting.RemoteAccessExceptionAbstractSlsbInvokerInterceptor#setLookupHomeOnStartupAbstractSlsbInvokerInterceptor#setCacheHomeAbstractRemoteSlsbInvokerInterceptor#setRefreshHomeOnConnectFailure

Constructors

<init>

SimpleRemoteStatelessSessionProxyFactoryBean()

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

See org.springframework.jndi.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.

Functions

afterPropertiesSet

open fun afterPropertiesSet(): Unit

getBusinessInterface

open fun getBusinessInterface(): Class<*>

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

getObject

open fun getObject(): Any

getObjectType

open fun getObjectType(): Class<*>

isSingleton

open fun isSingleton(): Boolean

setBeanClassLoader

open fun setBeanClassLoader(classLoader: ClassLoader): Unit

setBusinessInterface

open fun setBusinessInterface(businessInterface: Class<*>): Unit

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.

Inherited Functions

destroy

open fun destroy(): Unit

Remove the cached session bean instance, if necessary.

setCacheSessionBean

open fun setCacheSessionBean(cacheSessionBean: Boolean): Unit

Set whether to cache the actual session bean object.

Off by default for standard EJB compliance. Turn this flag on to optimize session bean access for servers that are known to allow for caching the actual session bean object.