org.springframework.ejb.access
public class: SimpleRemoteSlsbInvokerInterceptor [javadoc |
source]
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
All Implemented Interfaces:
DisposableBean, org.aopalliance.intercept.MethodInterceptor, InitializingBean
Direct Known Subclasses:
SimpleRemoteStatelessSessionProxyFactoryBean
Basic invoker for a remote Stateless Session Bean.
Designed for EJB 2.x, but works for EJB 3 Session Beans as well.
"Creates" a new EJB instance for each invocation, or caches the session
bean instance for all invocations (see #setCacheSessionBean ).
See org.springframework.jndi.JndiObjectLocator 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 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 invoker is typically used with an RMI business interface, which serves
as super-interface of the EJB component interface. Alternatively, this invoker
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.
Also see:
- org.springframework.remoting.RemoteAccessException
- AbstractSlsbInvokerInterceptor#setLookupHomeOnStartup
- AbstractSlsbInvokerInterceptor#setCacheHome
- AbstractRemoteSlsbInvokerInterceptor#setRefreshHomeOnConnectFailure
- author:
Rod - Johnson
- author:
Juergen - Hoeller
- since:
09.05.2003 -
| Methods from org.springframework.ejb.access.AbstractRemoteSlsbInvokerInterceptor: |
|---|
|
doInvoke, getCreateMethod, invokeInContext, isConnectFailure, isHomeRefreshable, lookup, newSessionBeanInstance, refreshAndRetry, removeSessionBeanInstance, setHomeInterface, setRefreshHomeOnConnectFailure |
| Methods from org.springframework.ejb.access.AbstractSlsbInvokerInterceptor: |
|---|
|
afterPropertiesSet, create, getCreateMethod, getHome, invoke, invokeInContext, isHomeRefreshable, refreshHome, setCacheHome, setExposeAccessContext, setLookupHomeOnStartup |
| Method from org.springframework.ejb.access.SimpleRemoteSlsbInvokerInterceptor Detail: |
public void destroy() {
if (this.cacheSessionBean) {
synchronized (this.beanInstanceMonitor) {
if (this.beanInstance instanceof EJBObject) {
removeSessionBeanInstance((EJBObject) this.beanInstance);
}
}
}
}
Remove the cached session bean instance, if necessary. |
protected Object doInvoke(MethodInvocation invocation) throws Throwable {
Object ejb = null;
try {
ejb = getSessionBeanInstance();
return RmiClientInterceptorUtils.invokeRemoteMethod(invocation, ejb);
}
catch (NamingException ex) {
throw new RemoteLookupFailureException("Failed to locate remote EJB [" + getJndiName() + "]", ex);
}
catch (InvocationTargetException ex) {
Throwable targetEx = ex.getTargetException();
if (targetEx instanceof RemoteException) {
RemoteException rex = (RemoteException) targetEx;
throw RmiClientInterceptorUtils.convertRmiAccessException(
invocation.getMethod(), rex, isConnectFailure(rex), getJndiName());
}
else if (targetEx instanceof CreateException) {
throw RmiClientInterceptorUtils.convertRmiAccessException(
invocation.getMethod(), targetEx, "Could not create remote EJB [" + getJndiName() + "]");
}
throw targetEx;
}
finally {
if (ejb instanceof EJBObject) {
releaseSessionBeanInstance((EJBObject) ejb);
}
}
}
This implementation "creates" a new EJB instance for each invocation.
Can be overridden for custom invocation strategies.
Alternatively, override #getSessionBeanInstance and
#releaseSessionBeanInstance to change EJB instance creation,
for example to hold a single shared EJB component instance. |
protected Object getSessionBeanInstance() throws NamingException, InvocationTargetException {
if (this.cacheSessionBean) {
synchronized (this.beanInstanceMonitor) {
if (this.beanInstance == null) {
this.beanInstance = newSessionBeanInstance();
}
return this.beanInstance;
}
}
else {
return newSessionBeanInstance();
}
}
|
protected void refreshHome() throws NamingException {
super.refreshHome();
if (this.cacheSessionBean) {
synchronized (this.beanInstanceMonitor) {
this.beanInstance = null;
}
}
}
Reset the cached session bean instance, if necessary. |
protected void releaseSessionBeanInstance(EJBObject ejb) {
if (!this.cacheSessionBean) {
removeSessionBeanInstance(ejb);
}
}
|
public void setCacheSessionBean(boolean cacheSessionBean) {
this.cacheSessionBean = cacheSessionBean;
}
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. |