org.springframework.ejb.support
Class AbstractSessionBean

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

All Implemented Interfaces:

EnterpriseBean, Serializable, SessionBean

Direct Known Subclasses:

AbstractStatefulSessionBean, AbstractStatelessSessionBean

abstract class AbstractSessionBean

extends AbstractEnterpriseBean

implements SessionBean

Superclass for all session beans, not intended for direct client subclassing.

This class saves the session context provided by the EJB container in an instance variable and provides a NOP implementation of the ejbRemove() lifecycle method.

Author:

Rod Johnson

Field Summary

static String

BEAN_FACTORY_PATH_ENVIRONMENT_KEY

Constructor Summary

(package private)

AbstractSessionBean()

Method Summary

void	ejbRemove() EJB lifecycle method, implemented to invoke onEjbRemote and unload the BeanFactory afterwards.
protected BeanFactory	getBeanFactory() May be called after ejbCreate().
protected SessionContext	getSessionContext() Convenience method for subclasses.
(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.
void	setSessionContext(SessionContext sessionContext) Sets the session context.
(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

Methods inherited from interface javax.ejb.SessionBean

ejbActivate, ejbPassivate, ejbRemove

Field Detail

BEAN_FACTORY_PATH_ENVIRONMENT_KEY

public static final String BEAN_FACTORY_PATH_ENVIRONMENT_KEY

See Also:

Constant Field Values

Constructor Detail

AbstractSessionBean

AbstractSessionBean()

Method Detail

setSessionContext

public void setSessionContext(SessionContext sessionContext)

Sets the session context.

If overriding this method, be sure to invoke this form of it first.

Specified by:

setSessionContext in interface SessionBean

Parameters:

sessionContext - SessionContext context for session

getSessionContext

protected final SessionContext getSessionContext()

Convenience method for subclasses. Return the EJB context saved on initialization.

Returns:

the SessionContext saved on initialization by this class's implementation of the setSessionContext() method.

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:

AbstractEnterpriseBean.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:

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