Package com.sun.ejb.containers

Class StatefulSessionContainer

java.lang.Object

com.sun.ejb.containers.BaseContainer

com.sun.ejb.containers.StatefulSessionContainer

All Implemented Interfaces:

com.sun.appserv.util.cache.CacheListener, Container, SFSBContainerCallback, com.sun.enterprise.container.common.spi.JavaEEContainer, org.glassfish.enterprise.iiop.spi.EjbContainerFacade

public final class StatefulSessionContainer
extends BaseContainer
implements com.sun.appserv.util.cache.CacheListener, SFSBContainerCallback

This class provides container functionality specific to stateful SessionBeans. At deployment time, one instance of the StatefulSessionContainer is created for each stateful SessionBean type (i.e. deployment descriptor) in a JAR.

The 5 states of a Stateful EJB (an EJB can be in only 1 state at a time): 1. PASSIVE : has been passivated 2. READY : ready for invocations, no transaction in progress 3. INVOKING : processing an invocation 4. INCOMPLETE_TX : ready for invocations, transaction in progress 5. DESTROYED : does not exist

Author:

Mahesh Kannan

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.ejb.containers.BaseContainer

BaseContainer.ContainerInfo, BaseContainer.ContainerType, BaseContainer.PreInvokeException

Field Summary

Fields

Modifier and Type	Field	Description
static int	MIN_PASSIVATION_BATCH_COUNT

Fields inherited from class com.sun.ejb.containers.BaseContainer

cacheProbeListener, cacheProbeNotifier, callFlowInfo, componentId, CONTAINER_INITIALIZING, CONTAINER_ON_HOLD, CONTAINER_STARTED, CONTAINER_STOPPED, CONTAINER_UNDEPLOYED, containerInfo, containerState, containerStateManager, containerTransactionManager, containerType, debugMonitorFlag, ejbActivateMethod, ejbClass, ejbContainerUtilImpl, ejbDescriptor, ejbGeneratedOptionalLocalBusinessIntfClass, ejbHome, ejbHomeImpl, ejbHomeStub, ejbIntfMethodInfo, ejbIntfMethods, ejbLocalBusinessHome, ejbLocalBusinessHomeImpl, ejbLocalHome, ejbLocalHomeImpl, EJBLocalObject_getPrimaryKey, EJBObject_getPrimaryKey, ejbOptionalLocalBusinessHome, ejbOptionalLocalBusinessHomeImpl, ejbOptionalLocalBusinessHomeIntf, ejbPassivateMethod, ejbProbeListener, ejbProbeNotifier, ejbRemoteBusinessHome, ejbRemoteBusinessHomeImpl, ejbRemoteBusinessHomeStub, ejbRemoveMethod, envProps, hasLocalBusinessView, hasLocalHomeView, hasOptionalLocalBusinessView, hasRemoteBusinessView, hasRemoteHomeView, homeIntf, injectionManager, interceptorManager, invocationInfoMap, invocationManager, isBeanManagedTran, isLocal, isMessageDriven, isRemote, isSession, isSingleton, isStatefulSession, isStatelessSession, isWebServiceEndpoint, loader, localBusinessHomeIntf, localBusinessIntfs, localHomeIntf, logParams, metadata, methodMonitorMap, monitorOn, namingManager, NO_PARAMS, optIntfClassLoader, poolProbeListener, remoteBusinessHomeIntf, remoteBusinessIntfInfo, remoteHomeRefFactory, remoteIntf, scheduleIds, securityManager, sfsbSerializedClass, SINGLETON_BEAN_POOL_PROP, timerProbeListener, timerProbeNotifier, transactionManager, webServiceEndpointIntf, webServiceInvocationInfoMap

Fields inherited from interface com.sun.ejb.Container

SEC_CHECKED, SEC_EXCLUDED, SEC_NOT_INITIALIZED, SEC_UNCHECKED, secAttrStrings, TX_BEAN_MANAGED, TX_MANDATORY, TX_NEVER, TX_NOT_INITIALIZED, TX_NOT_SUPPORTED, TX_REQUIRED, TX_REQUIRES_NEW, TX_SUPPORTS, txAttrStrings

Constructor Summary

Constructors

Constructor	Description
StatefulSessionContainer(BaseContainer.ContainerType conType, EjbDescriptor desc, ClassLoader loader, com.sun.enterprise.security.SecurityManager sm)
StatefulSessionContainer(EjbDescriptor desc, ClassLoader loader, com.sun.enterprise.security.SecurityManager sm)	This constructor is called from the JarManager when a Jar is deployed.

Method Summary

Modifier and Type	Method	Description
protected EJBContextImpl	_constructEJBContextImpl(Object instance)
protected Object	_constructEJBInstance()
ComponentContext	_getContext(EjbInvocation inv)	Called from preInvoke which is called from the EJBObject for local and remote invocations.
void	activateEJB(Object sessionKey, StatefulEJBContext sfsbCtx, Object cookie)
protected void	afterBegin(EJBContextImpl context)
protected void	afterCompletion(EJBContextImpl context, int status)
protected void	beforeCompletion(EJBContextImpl context)
boolean	canPassivateEJB(ComponentContext context)
protected void	checkExists(EJBLocalRemoteObject ejbObj)	Check if the given EJBObject/LocalObject has been removed.
protected void	checkUnfinishedTx(jakarta.transaction.Transaction prevTx, EjbInvocation inv)
protected EJBLocalObjectImpl	createEJBLocalObjectImpl()	This is called from the generated "HelloEJBLocalHomeImpl" create method via EJBLocalHomeImpl.createEJBObject.
protected EJBObjectImpl	createEJBObjectImpl()	This is called from the generated "HelloEJBHomeImpl" create method via EJBHomeImpl.createEJBObject.
protected EJBObjectImpl	createRemoteBusinessObjectImpl()
void	decrementMethodReadyStat()
protected void	delistExtendedEntityManagers(ComponentContext ctx)
Object	deserializeData(byte[] data)
protected void	doConcreteContainerShutdown(boolean appBeingUndeployed)
protected void	enlistExtendedEntityManagers(ComponentContext ctx)
protected void	forceDestroyBean(EJBContextImpl ctx)	Force destroy the EJB and rollback any Tx it was associated with Called from removeBean, timeoutBean and BaseContainer.postInvokeTx.
org.glassfish.ha.store.api.BackingStore<Serializable,org.glassfish.ha.store.util.SimpleMetadata>	getBackingStore()
protected EJBLocalObjectImpl	getEJBLocalObjectImpl(Object sessionKey)	Called from EJBLocalObjectImpl.getLocalObject() while deserializing a local object reference.
protected EJBObjectImpl	getEJBObjectImpl(byte[] instanceKey)	Called when a remote invocation arrives for an EJB.
int	getMaxCacheSize()
long	getMethodReadyCount()
String	getMonitorAttributeValues()
protected EjbMonitoringStatsProvider	getMonitoringStatsProvider(String appName, String modName, String ejbName)
int	getPassivationBatchCount()
long	getPassiveCount()
protected String[]	getPre30LifecycleMethodNames()
void	incrementMethodReadyStat()
protected void	initializeHome()	Called from the ContainerFactory during initialization.
void	invokePeriodically(long delay, long periodicity, Runnable target)
boolean	isHAEnabled()
protected boolean	isIdentical(EJBObjectImpl ejbo, jakarta.ejb.EJBObject other)
boolean	isPassivationCapable()
protected void	loadCheckpointInfo()
jakarta.persistence.EntityManager	lookupExtendedEntityManager(jakarta.persistence.EntityManagerFactory emf)	Containers that allow extended EntityManager will override this method.
void	onUndeploy(StatefulEJBContext sfsbCtx)
boolean	passivateEJB(ComponentContext context)
boolean	passivateEJB(StatefulEJBContext sfsbCtx)
protected void	postInvokeTx(EjbInvocation inv)	postInvokeTx is called after every invocation on the EJB instance, including ejbCreate/ejbFind---/ejbRemove.
protected void	registerMonitorableComponents()
void	releaseContext(EjbInvocation inv)	Called from preInvoke which is called from the EJBObject for local and remote invocations.
protected void	removeBean(EJBLocalRemoteObject ejbo, Method removeMethod, boolean local)
void	removeExpiredSessions()
void	removeTimedoutBean(EJBContextImpl ctx)
protected boolean	resumeTransaction(EjbInvocation inv)
byte[]	serializeContext(StatefulEJBContext ctx)
void	setBackingStore(org.glassfish.ha.store.api.BackingStore<Serializable,org.glassfish.ha.store.util.SimpleMetadata> store)
void	setHAEnabled(boolean isHAEnabled)
void	setPassivationBatchCount(int count)
void	setRemovalGracePeriodInSeconds(int val)
void	setSessionCache(LruSessionCache cache)
void	setSFSBUUIDUtil(SFSBUUIDUtil util)
void	setSFSBVersionManager(SFSBVersionManager sfsbVersionManager)
protected boolean	suspendTransaction(EjbInvocation inv)
void	trimEvent(Object primaryKey, Object context)
void	undeploy(SessionContextImpl ctx)
boolean	userTransactionMethodsAllowed(org.glassfish.api.invocation.ComponentInvocation inv)	EJB spec makes a distinction between access to the UserTransaction object itself and access to its methods.
protected void	validateEMForClientTx(EjbInvocation inv, com.sun.enterprise.transaction.api.JavaEETransaction clientJ2EETx)

Methods inherited from class com.sun.ejb.containers.BaseContainer

addInvocationInfo, addLocalRemoteInvocationInfo, addProxyInterfacesSetClass, adjustHomeTargetMethodInfo, adjustInvocationInfo, assertValidLocalObject, assertValidRemoteObject, authorize, authorizeLocalGetPrimaryKey, authorizeLocalMethod, authorizeRemoteGetPrimaryKey, authorizeRemoteMethod, callEJBTimeout, cancelTimers, checkExceptionClientTx, checkUserTransactionLookup, cleanupInstance, containerStateToString, createCallFlowAgent, createEjbInstanceAndContext, createEjbInstanceForInterceptors, createEjbInvocation, createEjbInvocation, createMonitoringRegistry, createRemoteReferenceWithId, doAfterBegin, doEJBHomeRemove, doFlush, doTimerInvocationInit, externalPostInvoke, externalPreInvoke, findFlushEnabledAttr, getApplicationId, getClassLoader, getComponentId, getContainerClassLoader, getContainerId, getContainerType, getContext, getDebugMonitorFlag, getDescriptor, getEJBClass, getEjbDescriptor, getEJBHome, getEJBHomeInvocationHandler, getEJBHomeStub, getEJBLocalBusinessHome, getEJBLocalHome, getEJBLocalHomeInvocationHandler, getEJBLocalObjectForPrimaryKey, getEJBLocalObjectForPrimaryKey, getEJBMetaData, getEJBObjectForPrimaryKey, getInvocationKey, getJaccEjb, getJavaGlobalJndiNamePrefix, getMonitoringMethodsArray, getMonitoringMethodsArray, getPassByReference, getProtocolManager, getSecurityManager, getTargetObject, getTimeoutMethod, getTxAttr, getTxAttr, getTxAttrForLifecycleCallback, getUserTransaction, getUseThreadPoolId, incrementCreatedTimedObject, incrementDeliveredTimedObject, incrementRemovedTimedObject, initializeProtocolManager, injectEjbInstance, instantiateEJBLocalBusinessObjectImpl, instantiateEJBLocalObjectImpl, instantiateEJBLocalObjectImpl, instantiateEJBObjectImpl, instantiateEJBObjectImpl, instantiateOptionalEJBLocalBusinessObjectImpl, instantiateRemoteBusinessObjectImpl, intercept, intercept, invokeBeanMethod, invokeFindByPrimaryKey, invokeTargetBeanMethod, isApplicationException, isCreateHomeFinder, isEjbTimeoutMethod, isLocalInterfaceSupported, isLocalObject, isRemoteInterfaceSupported, isRemoteObject, isStopped, isSystemUncheckedException, isTimedObject, isUndeployed, onEnteringContainer, onLeavingContainer, onReady, onShutdown, onTermination, postCreate, postEjbTimeout, postFind, postInvoke, postInvoke, postInvokeNoTx, postProcessInvocationInfo, preInitialize, preInvoke, preInvokeNoTx, preInvokeTx, prepareEjbTimeoutParams, preSelect, registerTimerMonitorableComponent, releaseTargetObject, removeBeanUnchecked, removeBeanUnchecked, scanForEjbCreateMethod, setDebugMonitorFlag, setEJBMetaData, setStartedState, setStoppedState, setUndeployedState, startApplication, toString, undeploy, useClientTx, validateTxAttr, webServicePostInvoke

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.ejb.spi.container.SFSBContainerCallback

getClassLoader

Field Detail

MIN_PASSIVATION_BATCH_COUNT

public static final int MIN_PASSIVATION_BATCH_COUNT

See Also:

Constant Field Values

Constructor Detail

StatefulSessionContainer

public StatefulSessionContainer(EjbDescriptor desc,
                                ClassLoader loader,
                                com.sun.enterprise.security.SecurityManager sm)
                         throws Exception

This constructor is called from the JarManager when a Jar is deployed.

Throws:

Exception - on error

StatefulSessionContainer

public StatefulSessionContainer(BaseContainer.ContainerType conType,
                                EjbDescriptor desc,
                                ClassLoader loader,
                                com.sun.enterprise.security.SecurityManager sm)
                         throws Exception

Throws:

Exception

Method Detail

isPassivationCapable

public boolean isPassivationCapable()

Specified by:

isPassivationCapable in interface SFSBContainerCallback

initializeHome

protected void initializeHome()
                       throws Exception

Description copied from class: BaseContainer

Called from the ContainerFactory during initialization.

Overrides:

initializeHome in class BaseContainer

Throws:

Exception

checkUnfinishedTx

protected void checkUnfinishedTx(jakarta.transaction.Transaction prevTx,
                                 EjbInvocation inv)

Overrides:

checkUnfinishedTx in class BaseContainer

loadCheckpointInfo

protected void loadCheckpointInfo()

registerMonitorableComponents

protected void registerMonitorableComponents()

Overrides:

registerMonitorableComponents in class BaseContainer

getMonitorAttributeValues

public String getMonitorAttributeValues()

getMonitoringStatsProvider

protected EjbMonitoringStatsProvider getMonitoringStatsProvider(String appName,
                                                                String modName,
                                                                String ejbName)

Specified by:

getMonitoringStatsProvider in class BaseContainer

isIdentical

protected boolean isIdentical(EJBObjectImpl ejbo,
                              jakarta.ejb.EJBObject other)
                       throws RemoteException

Overrides:

isIdentical in class BaseContainer

Throws:

RemoteException

createEJBObjectImpl

protected EJBObjectImpl createEJBObjectImpl()
                                     throws jakarta.ejb.CreateException,
                                            RemoteException

This is called from the generated "HelloEJBHomeImpl" create method via EJBHomeImpl.createEJBObject. Note: for stateful beans, the HelloEJBHomeImpl.create calls ejbCreate on the new bean after createEJBObject() returns. Return the EJBObject for the bean.

Specified by:

createEJBObjectImpl in class BaseContainer

Throws:

jakarta.ejb.CreateException

RemoteException

createRemoteBusinessObjectImpl

protected EJBObjectImpl createRemoteBusinessObjectImpl()
                                                throws jakarta.ejb.CreateException,
                                                       RemoteException

Throws:

jakarta.ejb.CreateException

RemoteException

createEJBLocalObjectImpl

protected EJBLocalObjectImpl createEJBLocalObjectImpl()
                                               throws jakarta.ejb.CreateException

This is called from the generated "HelloEJBLocalHomeImpl" create method via EJBLocalHomeImpl.createEJBObject. Note: for stateful beans, the HelloEJBLocalHomeImpl.create calls ejbCreate on the new bean after createEJBLocalObjectImpl() returns. Return the EJBLocalObject for the bean.

Overrides:

createEJBLocalObjectImpl in class BaseContainer

Throws:

jakarta.ejb.CreateException

_constructEJBContextImpl

protected EJBContextImpl _constructEJBContextImpl(Object instance)

Overrides:

_constructEJBContextImpl in class BaseContainer

_constructEJBInstance

protected Object _constructEJBInstance()
                                throws Exception

Overrides:

_constructEJBInstance in class BaseContainer

Throws:

Exception

suspendTransaction

protected boolean suspendTransaction(EjbInvocation inv)
                              throws Exception

Overrides:

suspendTransaction in class BaseContainer

Throws:

Exception

resumeTransaction

protected boolean resumeTransaction(EjbInvocation inv)
                             throws Exception

Overrides:

resumeTransaction in class BaseContainer

Throws:

Exception

lookupExtendedEntityManager

public jakarta.persistence.EntityManager lookupExtendedEntityManager(jakarta.persistence.EntityManagerFactory emf)

Description copied from class: BaseContainer

Containers that allow extended EntityManager will override this method.

Specified by:

lookupExtendedEntityManager in interface com.sun.enterprise.container.common.spi.JavaEEContainer

Overrides:

lookupExtendedEntityManager in class BaseContainer

removeBean

protected void removeBean(EJBLocalRemoteObject ejbo,
                          Method removeMethod,
                          boolean local)
                   throws jakarta.ejb.RemoveException,
                          jakarta.ejb.EJBException

Specified by:

removeBean in class BaseContainer

Throws:

jakarta.ejb.RemoveException

jakarta.ejb.EJBException

forceDestroyBean

protected void forceDestroyBean(EJBContextImpl ctx)

Force destroy the EJB and rollback any Tx it was associated with Called from removeBean, timeoutBean and BaseContainer.postInvokeTx. Note: EJB2.0 section 18.3.1 says that discarding an EJB means that no methods other than finalize() should be invoked on it.

Specified by:

forceDestroyBean in class BaseContainer

userTransactionMethodsAllowed

public boolean userTransactionMethodsAllowed(org.glassfish.api.invocation.ComponentInvocation inv)

Description copied from class: BaseContainer

EJB spec makes a distinction between access to the UserTransaction object itself and access to its methods. getUserTransaction covers the first check and this method covers the second. It is called by the UserTransaction implementation to verify access.

Specified by:

userTransactionMethodsAllowed in interface Container

Overrides:

userTransactionMethodsAllowed in class BaseContainer

removeTimedoutBean

public void removeTimedoutBean(EJBContextImpl ctx)

getEJBObjectImpl

protected EJBObjectImpl getEJBObjectImpl(byte[] instanceKey)

Description copied from class: BaseContainer

Called when a remote invocation arrives for an EJB. Implemented in subclasses.

Specified by:

getEJBObjectImpl in class BaseContainer

getEJBLocalObjectImpl

protected EJBLocalObjectImpl getEJBLocalObjectImpl(Object sessionKey)

Called from EJBLocalObjectImpl.getLocalObject() while deserializing a local object reference.

Overrides:

getEJBLocalObjectImpl in class BaseContainer

checkExists

protected void checkExists(EJBLocalRemoteObject ejbObj)

Check if the given EJBObject/LocalObject has been removed.

Overrides:

checkExists in class BaseContainer

Throws:

jakarta.ejb.NoSuchObjectLocalException - if the object has been removed.

_getContext

public ComponentContext _getContext(EjbInvocation inv)

Called from preInvoke which is called from the EJBObject for local and remote invocations.

Specified by:

_getContext in class BaseContainer

isHAEnabled

public boolean isHAEnabled()

Overrides:

isHAEnabled in class BaseContainer

postInvokeTx

protected void postInvokeTx(EjbInvocation inv)
                     throws Exception

Description copied from class: BaseContainer

postInvokeTx is called after every invocation on the EJB instance, including ejbCreate/ejbFind---/ejbRemove. NOTE: postInvokeTx is called even if the EJB was not invoked because of an exception thrown from preInvokeTx.

Overrides:

postInvokeTx in class BaseContainer

Throws:

Exception

releaseContext

public void releaseContext(EjbInvocation inv)

Called from preInvoke which is called from the EJBObject for local and remote invocations.

Specified by:

releaseContext in class BaseContainer

afterBegin

protected void afterBegin(EJBContextImpl context)

Specified by:

afterBegin in class BaseContainer

beforeCompletion

protected void beforeCompletion(EJBContextImpl context)

Specified by:

beforeCompletion in class BaseContainer

afterCompletion

protected void afterCompletion(EJBContextImpl context,
                               int status)

Specified by:

afterCompletion in class BaseContainer

canPassivateEJB

public final boolean canPassivateEJB(ComponentContext context)

passivateEJB

public final boolean passivateEJB(ComponentContext context)

Specified by:

passivateEJB in class BaseContainer

getPassivationBatchCount

public final int getPassivationBatchCount()

Specified by:

getPassivationBatchCount in interface SFSBContainerCallback

setPassivationBatchCount

public final void setPassivationBatchCount(int count)

passivateEJB

public final boolean passivateEJB(StatefulEJBContext sfsbCtx)

Specified by:

passivateEJB in interface SFSBContainerCallback

getMethodReadyCount

public long getMethodReadyCount()

getPassiveCount

public long getPassiveCount()

activateEJB

public void activateEJB(Object sessionKey,
                        StatefulEJBContext sfsbCtx,
                        Object cookie)

Specified by:

activateEJB in interface SFSBContainerCallback

serializeContext

public byte[] serializeContext(StatefulEJBContext ctx)
                        throws IOException

Specified by:

serializeContext in interface SFSBContainerCallback

Throws:

IOException

deserializeData

public Object deserializeData(byte[] data)
                       throws Exception

Specified by:

deserializeData in interface SFSBContainerCallback

Throws:

Exception

validateEMForClientTx

protected void validateEMForClientTx(EjbInvocation inv,
                                     com.sun.enterprise.transaction.api.JavaEETransaction clientJ2EETx)
                              throws jakarta.ejb.EJBException

Overrides:

validateEMForClientTx in class BaseContainer

Throws:

jakarta.ejb.EJBException

enlistExtendedEntityManagers

protected void enlistExtendedEntityManagers(ComponentContext ctx)

Overrides:

enlistExtendedEntityManagers in class BaseContainer

delistExtendedEntityManagers

protected void delistExtendedEntityManagers(ComponentContext ctx)

Overrides:

delistExtendedEntityManagers in class BaseContainer

invokePeriodically

public void invokePeriodically(long delay,
                               long periodicity,
                               Runnable target)

Specified by:

invokePeriodically in interface SFSBContainerCallback

onUndeploy

public void onUndeploy(StatefulEJBContext sfsbCtx)

getPre30LifecycleMethodNames

protected String[] getPre30LifecycleMethodNames()

Overrides:

getPre30LifecycleMethodNames in class BaseContainer

doConcreteContainerShutdown

protected void doConcreteContainerShutdown(boolean appBeingUndeployed)

Specified by:

doConcreteContainerShutdown in class BaseContainer

undeploy

public void undeploy(SessionContextImpl ctx)

trimEvent

public void trimEvent(Object primaryKey,
                      Object context)

Specified by:

trimEvent in interface com.sun.appserv.util.cache.CacheListener

setSFSBUUIDUtil

public void setSFSBUUIDUtil(SFSBUUIDUtil util)

setHAEnabled

public void setHAEnabled(boolean isHAEnabled)

setSessionCache

public void setSessionCache(LruSessionCache cache)

setRemovalGracePeriodInSeconds

public void setRemovalGracePeriodInSeconds(int val)

removeExpiredSessions

public void removeExpiredSessions()

setSFSBVersionManager

public void setSFSBVersionManager(SFSBVersionManager sfsbVersionManager)

getMaxCacheSize

public int getMaxCacheSize()

getBackingStore

public org.glassfish.ha.store.api.BackingStore<Serializable,org.glassfish.ha.store.util.SimpleMetadata> getBackingStore()

setBackingStore

public void setBackingStore(org.glassfish.ha.store.api.BackingStore<Serializable,org.glassfish.ha.store.util.SimpleMetadata> store)

incrementMethodReadyStat

public void incrementMethodReadyStat()

decrementMethodReadyStat

public void decrementMethodReadyStat()