org.springframework.ejb.support
Class AbstractEnterpriseBean

java.lang.Object
  org.springframework.ejb.support.AbstractEnterpriseBean

All Implemented Interfaces:

EnterpriseBean, Serializable

Direct Known Subclasses:

AbstractMessageDrivenBean, AbstractSessionBean

abstract class AbstractEnterpriseBean

extends Object

implements EnterpriseBean

Superclass for all EJBs. Package-visible: not intended for direct subclassing. Provides a standard way of loading a BeanFactory. Subclasses act as a facade, with the business logic deferred to beans in the BeanFactory.

Default is to use a ContextJndiBeanFactoryLocator, which will initialize an XML ApplicationContext from the classpath (based on a JNDI name specified). For a lighter weight implementation when ApplicationContext usage is not required, setBeanFactoryLocator may be called (before your EJB's ejbCreate method is invoked, for example, in setSessionContext) with a JndiBeanFactoryLocator, which will load an XML BeanFactory from the classpath. Alternately, setBeanFactoryLocator may be called with a completely custom implementation of BeanFactoryLocator.

Note that we cannot use final for our implementation of EJB lifecycle methods, as this violates the EJB specification.

Author:

Rod Johnson, Colin Sampaleanu

See Also:

setBeanFactoryLocator(org.springframework.beans.factory.access.BeanFactoryLocator), ContextJndiBeanFactoryLocator, JndiBeanFactoryLocator

Field Summary

static String

BEAN_FACTORY_PATH_ENVIRONMENT_KEY

Constructor Summary

(package private)

AbstractEnterpriseBean()

Method Summary

void	ejbRemove() EJB lifecycle method, implemented to invoke onEjbRemote and unload the BeanFactory afterwards.
protected BeanFactory	getBeanFactory() May be called after ejbCreate().
(package private) void	loadBeanFactory() Load a Spring BeanFactory namespace.
protected void	onEjbRemove() Subclasses must implement this method to do any initialization they would otherwise have done in an ejbRemove() method.
void	setBeanFactoryLocator(BeanFactoryLocator beanFactoryLocator) Set the BeanFactoryLocator to use for this EJB.
void	setBeanFactoryLocatorKey(String factoryKey) Set the bean factory locator key.
(package private) void	unloadBeanFactory() Unload the Spring BeanFactory instance.

Methods inherited from class java.lang.Object

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

Field Detail

BEAN_FACTORY_PATH_ENVIRONMENT_KEY

public static final String BEAN_FACTORY_PATH_ENVIRONMENT_KEY

See Also:

Constant Field Values

Constructor Detail

AbstractEnterpriseBean

AbstractEnterpriseBean()

Method Detail

setBeanFactoryLocator

public void setBeanFactoryLocator(BeanFactoryLocator beanFactoryLocator)

Set the BeanFactoryLocator to use for this EJB. Default is a ContextJndiBeanFactoryLocator.

Can be invoked before loadBeanFactory, for example in constructor or setSessionContext if you want to override the default locator.

Note that the BeanFactory is automatically loaded by the ejbCreate implementations of AbstractStatelessSessionBean and AbstractMessageDriverBean but needs to be explicitly loaded in custom AbstractStatefulSessionBean ejbCreate methods.

See Also:

AbstractStatelessSessionBean.ejbCreate(), AbstractMessageDrivenBean.ejbCreate(), AbstractStatefulSessionBean.loadBeanFactory(), ContextJndiBeanFactoryLocator, JndiBeanFactoryLocator

setBeanFactoryLocatorKey

public void setBeanFactoryLocatorKey(String factoryKey)

Set the bean factory locator key.

In case of the default BeanFactoryLocator implementation, ContextJndiBeanFactoryLocator, this is the JNDI path. The default value of this property is "java:comp/env/ejb/BeanFactoryPath".

Can be invoked before loadBeanFactory, for example in constructor or setSessionContext if you want to override the default locator key.

See Also:

BEAN_FACTORY_PATH_ENVIRONMENT_KEY

loadBeanFactory

void loadBeanFactory()
               throws BeansException

Load a Spring BeanFactory namespace. Subclasses must invoke this method.

Package-visible as it shouldn't be called directly by user-created subclasses.

Throws:

BeansException

See Also:

AbstractStatelessSessionBean.ejbCreate()

unloadBeanFactory

void unloadBeanFactory()
                 throws FatalBeanException

Unload the Spring BeanFactory instance. The default ejbRemove method invokes this method, but subclasses which override ejbRemove must invoke this method themselves.

Package-visible as it shouldn't be called directly by user-created subclasses.

Throws:

FatalBeanException

getBeanFactory

protected BeanFactory getBeanFactory()

May be called after ejbCreate().

Returns:

the bean factory

ejbRemove

public void ejbRemove()

EJB lifecycle method, implemented to invoke onEjbRemote and unload the BeanFactory afterwards.

Don't override it (although it can't be made final): code your shutdown in onEjbRemove.

See Also:

onEjbRemove()

onEjbRemove

protected void onEjbRemove()

Subclasses must implement this method to do any initialization they would otherwise have done in an ejbRemove() method. The BeanFactory will be unloaded afterwards.

This implementation is empty, to be overridden in subclasses. The same restrictions apply to the work of this method as to an ejbRemove() method.