All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.springframework.ejb.access.SimpleRemoteStatelessSessionProxyFactoryBean Maven / Gradle / Ivy

The newest version!
/*
 * Copyright 2002-2012 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.ejb.access;

import javax.naming.NamingException;

import org.springframework.aop.framework.ProxyFactory;
import org.springframework.beans.factory.BeanClassLoaderAware;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.util.ClassUtils;

/**
 * Convenient {@link FactoryBean} for remote SLSB proxies.
 * Designed for EJB 2.x, but works for EJB 3 Session Beans as well.
 *
 * 

See {@link 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 org.springframework.remoting.RemoteAccessException * @see AbstractSlsbInvokerInterceptor#setLookupHomeOnStartup * @see AbstractSlsbInvokerInterceptor#setCacheHome * @see AbstractRemoteSlsbInvokerInterceptor#setRefreshHomeOnConnectFailure */ public class SimpleRemoteStatelessSessionProxyFactoryBean extends SimpleRemoteSlsbInvokerInterceptor implements FactoryBean, BeanClassLoaderAware { /** The business interface of the EJB we're proxying */ private Class businessInterface; private ClassLoader beanClassLoader = ClassUtils.getDefaultClassLoader(); /** EJBObject */ private Object proxy; /** * 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. * @param businessInterface the business interface of the EJB */ public void setBusinessInterface(Class businessInterface) { this.businessInterface = businessInterface; } /** * Return the business interface of the EJB we're proxying. */ public Class getBusinessInterface() { return this.businessInterface; } @Override public void setBeanClassLoader(ClassLoader classLoader) { this.beanClassLoader = classLoader; } @Override public void afterPropertiesSet() throws NamingException { super.afterPropertiesSet(); if (this.businessInterface == null) { throw new IllegalArgumentException("businessInterface is required"); } this.proxy = new ProxyFactory(this.businessInterface, this).getProxy(this.beanClassLoader); } @Override public Object getObject() { return this.proxy; } @Override public Class getObjectType() { return this.businessInterface; } @Override public boolean isSingleton() { return true; } }