* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

*

* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.

*

* The contents of this file are subject to the terms of either the GNU

* General Public License Version 2 only ("GPL") or the Common Development

* and Distribution License("CDDL") (collectively, the "License").  You

* may not use this file except in compliance with the License. You can obtain

* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html

* or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific

* language governing permissions and limitations under the License.

*

* When distributing the software, include this License Header Notice in each

* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.

* Sun designates this particular file as subject to the "Classpath" exception

* as provided by Sun in the GPL Version 2 section of the License file that

* accompanied this code.  If applicable, add the following below the License

* Header, with the fields enclosed by brackets [] replaced by your own

* identifying information: "Portions Copyrighted [year]

* [name of copyright owner]"

*

* Contributor(s):

*

* If you wish your version of this file to be governed by only the CDDL or

* only the GPL Version 2, indicate your decision by adding "[Contributor]

* elects to include this software in this distribution under the [CDDL or GPL

* Version 2] license."  If you don't indicate a single choice of license, a

* recipient has the option to distribute your version of this file under

* either the CDDL, the GPL Version 2 or to extend the choice of license to

* its licensees as provided above.  However, if you add GPL Version 2 code

* and therefore, elected the GPL Version 2 license, then the option applies

* only if the new code is made subject to such option by the copyright

* holder.

*/

*  SessionBeans.

*  At deployment time, one instance of the StatefulSessionContainer is created

*  for each stateful SessionBean type (i.e. deployment descriptor) in a JAR.

* <P>

* 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

*/

    extends BaseContainer

    implements CacheListener, SFSBContainerCallback,

  StatefulSessionBeanStatsProvider, SFSBContainerInitialization

   

    private static final Logger _logger =

        LogDomains.getLogger(LogDomains.EJB_LOGGER);

   

    static final int PASSIVE=1, READY=2, INVOKING=3;

    static final int INCOMPLETE_TX=4, DESTROYED=5;

   

    // We do not want too many ORB task for passivation

    public static final int  MIN_PASSIVATION_BATCH_COUNT = 8;

   

    private long    instanceCount = 1;

   

    protected ArrayList    passivationCandidates = new ArrayList();

    private Object    asyncTaskSemaphore = new Object();

   

   

    private int      asyncTaskCount = 0;

    private int      asyncCummTaskCount = 0;

   

    private int      passivationBatchCount

            = MIN_PASSIVATION_BATCH_COUNT;

   

    private int      containerTrimCount=0;

       

    private LruSessionCache  sessionBeanCache;

    private SFSBStoreManager  sfsbStoreManager;

    private SFSBUUIDUtil  uuidGenerator;

    private ArrayList    scheduledTimerTasks = new ArrayList();

    protected int    statMethodReadyCount = 0;

    private Level    TRACE_LEVEL = Level.FINE;

    private String    ejbName;

    private CheckpointPolicy  checkpointPolicy;

    private int      removalGracePeriodInSeconds;

    private StatefulSessionStoreMonitor  sfsbStoreMonitor;

    private final String  traceInfoPrefix;

    /*

     * Cache for keeping ref count for shared extended entity manager.

     * The key in this map is the physical entity manager

     */

    private static Map<EntityManager, EEMRefInfo> extendedEMReferenceCountMap

        = new HashMap<EntityManager, EEMRefInfo>();

    private static Map<EEMRefInfoKey, EntityManager> eemKey2EEMMap

        = new HashMap<EEMRefInfoKey, EntityManager>();

   

    /**

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

     * @exception Exception on error

     */

    public StatefulSessionContainer(EjbDescriptor desc,

            ClassLoader loader)

        throws Exception

    {

        super(desc, loader);

        super.createCallFlowAgent(ComponentType.SFSB);

  this.ejbName = desc.getName();

  this.traceInfoPrefix = "sfsb-" + ejbName + ": ";

    }

   

    protected void initializeHome()

        throws Exception

    {

        super.initializeHome();

  loadCheckpointInfo();

  registerMonitorableComponents();

    }

    protected void loadCheckpointInfo() {

  try {

      if (checkpointPolicy.isHAEnabled()) {

    Iterator iter = invocationInfoMap.values().iterator();

    while (iter.hasNext()) {

        InvocationInfo info = (InvocationInfo) iter.next();

        info.checkpointEnabled = false;

        MethodDescriptor md = new MethodDescriptor(

          info.method, info.methodIntf);

        IASEjbExtraDescriptors extraDesc =

      ejbDescriptor.getIASEjbExtraDescriptors();

        if (extraDesc != null) {

      CheckpointAtEndOfMethodDescriptor cpDesc =

          extraDesc.getCheckpointAtEndOfMethodDescriptor();

      if (cpDesc != null) {

          info.checkpointEnabled =

        cpDesc.isCheckpointEnabledFor(md);

      }

        }

        if (info.checkpointEnabled) {

      if (_logger.isLoggable(Level.FINE)) {

          _logger.log(Level.FINE, "[SFSBContainer] "

        + info.method + " MARKED for "

        + "end-of-method-checkpoint");

      }

        }

    }

      }

  } catch (Exception ex) {

      _logger.log(Level.WARNING, "[SFSBContainer] Exception while "

        + " loading checkpoint info", ex);

  }

    }

    protected void registerMonitorableComponents() {

  registryMediator.registerProvider(this);

  registryMediator.registerProvider(sessionBeanCache);

        super.registerMonitorableComponents();

  super.populateMethodMonitorMap();

  sfsbStoreMonitor = registryMediator.registerProvider(

      sfsbStoreManager.getMonitorableSFSBStoreManager(),

      checkpointPolicy.isHAEnabled());

  sessionBeanCache.setStatefulSessionStoreMonitor(sfsbStoreMonitor);

  _logger.log(Level.FINE, "[SFSBContainer] registered monitorable");

    }

    public String getMonitorAttributeValues() {

        StringBuffer sbuf = new StringBuffer();

  //sbuf.append(storeHelper.getMonitorAttributeValues());

        sbuf.append(" { asyncTaskCount=").append(asyncTaskCount)

        .append("; asyncCummTaskCount=").append(asyncCummTaskCount)

        .append("; passivationBatchCount=").append(passivationBatchCount)

        .append("; passivationQSz=").append(passivationCandidates.size())

        .append("; trimEventCount=").append(containerTrimCount)

        .append(" }");

        return sbuf.toString();

    }

   

    public void appendStats(StringBuffer sbuf) {

  sbuf.append("\nStatefulContainer: ")

      .append("CreateCount=").append(statCreateCount).append("; ")

      .append("RemoveCount=").append(statRemoveCount).append("; ")

      .append("Size=")

      .append(sessionBeanCache.getNumBeansInCache()).append("; ")

      .append("ReadyCount=")

      .append(statMethodReadyCount).append("; ");

  sbuf.append("]");

    }

    private static final String convertCtxStateToString(

  SessionContextImpl sc)

    {

  switch (sc.getState()) {

      case PASSIVE: return "PASSIVE";

      case READY: return "READY";

      case INVOKING: return "INVOKING";

      case INCOMPLETE_TX: return "INCOMPLETE_TX";

      case DESTROYED: return "DESTROYED";

  }

  return "UNKNOWN-STATE";

    }

    boolean isIdentical(EJBObjectImpl ejbo, EJBObject other)

        throws RemoteException

    {

        if ( other == ejbo.getStub() )

            return true;

        else {

            try {

                // other may be a stub for a remote object.

                if ( protocolMgr.isIdentical(ejbo.getStub(), other) )

                    return true;

                else

                    return false;

            } catch ( Exception ex ) {

                _logger.log(Level.FINE,

                "Exception while getting stub for ejb",ex);

                throw new RemoteException("Error during isIdentical.", ex);

            }

        }

    }

   

    /**

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

     */

    EJBObjectImpl createEJBObjectImpl()

        throws CreateException, RemoteException

    {

        try {

            SessionContextImpl context = createBeanInstance();

            EJBObjectImpl ejbObjImpl = createEJBObjectImpl(context);

            afterInstanceCreation(context);

            return ejbObjImpl;

        }

        catch (Exception ex) {

           

            _logger.log(Level.WARNING, "ejb.create_ejbobject_exception",

                        ejbDescriptor.getName());

            _logger.log(Level.WARNING, "create object exception", ex);

                       

            if ( ex instanceof EJBException )

                throw (EJBException)ex;

            else {

                CreateException ce =

                    new CreateException("ERROR creating stateful SessionBean");

                ce.initCause(ex);

                throw ce;

            }

        }

    }

    EJBObjectImpl createRemoteBusinessObjectImpl()

        throws CreateException, RemoteException

    {

        try {

            SessionContextImpl context = createBeanInstance();

            EJBObjectImpl ejbBusinessObjImpl =

                createRemoteBusinessObjectImpl(context);

            afterInstanceCreation(context);

            return ejbBusinessObjImpl;

        }

        catch (Exception ex) {

           

            _logger.log(Level.WARNING, "ejb.create_ejbobject_exception",

                        ejbDescriptor.getName());

            _logger.log(Level.WARNING, "create object exception", ex);

                       

            if ( ex instanceof EJBException )

                throw (EJBException)ex;

            else {

                CreateException ce =

                    new CreateException("ERROR creating stateful SessionBean");

                ce.initCause(ex);

                throw ce;

            }

        }

    }

   

   

    /**

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

     */

    EJBLocalObjectImpl createEJBLocalObjectImpl()

        throws CreateException

    {

        try {

            SessionContextImpl context = createBeanInstance();

           

            EJBLocalObjectImpl localObjImpl =

                createEJBLocalObjectImpl(context);

            afterInstanceCreation(context);

           

            return localObjImpl;

        }

        catch (Exception ex) {

            _logger.log(Level.WARNING, "ejb.create_ejblocalobject_exception",

                        ejbDescriptor.getName());

            _logger.log(Level.WARNING, "create ejblocal object exception", ex);

            if ( ex instanceof EJBException )

                throw (EJBException)ex;

            else {

                CreateException ce =

                new CreateException("ERROR creating stateful SessionBean");

                ce.initCause(ex);

                throw ce;

            }

        }

    }

    /**

     * Internal creation event for Local Business view of SFSB

     */

    EJBLocalObjectImpl createEJBLocalBusinessObjectImpl()

        throws CreateException

    {

        try {

            SessionContextImpl context = createBeanInstance();

           

            EJBLocalObjectImpl localBusinessObjImpl =

                createEJBLocalBusinessObjectImpl(context);

            afterInstanceCreation(context);

           

            return localBusinessObjImpl;

        }

        catch (Exception ex) {

            _logger.log(Level.WARNING, "ejb.create_ejblocalobject_exception",

                        ejbDescriptor.getName());

            _logger.log(Level.WARNING, "create ejblocal object exception", ex);

            if ( ex instanceof EJBException )

                throw (EJBException)ex;

            else {

                CreateException ce =

                new CreateException("ERROR creating stateful SessionBean");

                ce.initCause(ex);

                throw ce;

            }

        }

    }

   

    /**

     * Create a new Session Bean and set Session Context.

     */

    private SessionContextImpl createBeanInstance()

        throws Exception

    {

        Invocation i=null;

        try {

            // create new (stateful) EJB

            Object ejb = ejbClass.newInstance();

           

            // create SessionContext and set it in the EJB

            SessionContextImpl context = new SessionContextImpl(ejb, this);

            context.setInterceptorInstances(

                    interceptorManager.createInterceptorInstances());

           

            Object sessionKey = uuidGenerator.createSessionKey();

            createExtendedEMs(context, sessionKey);

           

            // Need to do preInvoke because setSessionContext can access JNDI

            i = new Invocation(ejb, this);

            i.context = context;

            invocationManager.preInvoke(i);

           

            // setSessionContext will be called without a Tx as required

            // by the spec, because the EJBHome.create would have been called

            // after the container suspended any client Tx.

            // setSessionContext is also called before createEJBObject because

            // the bean is not allowed to do EJBContext.getEJBObject here

            if( ejb instanceof SessionBean ) {

                ((SessionBean)ejb).setSessionContext(context);

            }

            // Perform injection right after where setSessionContext

            // would be called.  This is important since injection methods

            // have the same "operations allowed" permissions as

            // setSessionContext.

            injectionManager.injectInstance(ejb, ejbDescriptor, false);

            for (Object interceptorInstance : context.getInterceptorInstances()) {

                injectionManager.injectInstance(interceptorInstance,

                        ejbDescriptor, false);

            }

            // Set the timestamp before inserting into bean store, else

            // Recycler might go crazy and remove this bean!

            context.touch();

           

            // Add the EJB into the session store

            // and get the instanceKey for this EJB instance.

            // XXX The store operation could be avoided for local-only beans.

            sessionBeanCache.put(sessionKey, context);

            context.setInstanceKey(sessionKey);

      if (_logger.isLoggable(TRACE_LEVEL)) {

    _logger.log(TRACE_LEVEL, "[SFSBContainer] Created "

        + "session: " + sessionKey);

      }

           

            return context;

        } catch (Exception ex) {

            throw ex;

        } catch (Throwable t) {

            EJBException ejbEx = new EJBException();

            ejbEx.initCause(t);

            throw ejbEx;

        } finally {

            if ( i != null ) {

                invocationManager.postInvoke(i);

            }

        }

    }

    private void createExtendedEMs(SessionContextImpl ctx, Object sessionKey) {

        Set<EntityManagerReferenceDescriptor> emRefs

            = ejbDescriptor.getEntityManagerReferenceDescriptors();

        Iterator<EntityManagerReferenceDescriptor> iter = emRefs.iterator();

        Set<EEMRefInfo> eemRefInfos = new HashSet<EEMRefInfo>();

        while (iter.hasNext()) {

            EntityManagerReferenceDescriptor refDesc = iter.next();

            if (refDesc.getPersistenceContextType() ==

                PersistenceContextType.EXTENDED) {

                String unitName = refDesc.getUnitName();

                EntityManagerFactory emf =

                    EntityManagerFactoryWrapper.lookupEntityManagerFactory(

                        ComponentInvocation.EJB_INVOCATION,

                        unitName, ejbDescriptor);

                if (emf != null) {

                    EntityManager em = findExtendedEMFromInvList(emf);

                    if (em == null) {

                        try {

                            Map properties = refDesc.getProperties();

                            em = emf.createEntityManager(properties);

                            if (em == null) {

                                throw new EJBException

                                    ("EM is null. Couldn't create EntityManager for"

                                        + " refName: " + refDesc.getName()

                                        + "; unitname: " + unitName);

                            }

                        } catch (Throwable th) {

                          EJBException ejbEx = new EJBException

                                ("Couldn't create EntityManager for"

                                    + " refName: " + refDesc.getName()

                                    + "; unitname: " + unitName);

                          ejbEx.initCause(th);

                          throw ejbEx;

                        }

                    }

               

                    String emRefName = refDesc.getName();

                    long containerID = this.getContainerId();

                    EEMRefInfo refInfo = null;

                    synchronized (extendedEMReferenceCountMap) {

                        refInfo = extendedEMReferenceCountMap.get(em);

                        if (refInfo != null) {

                            refInfo.refCount++;

                        } else  {

                            refInfo = new EEMRefInfo(emRefName, refDesc.getUnitName(), containerID,

                                    sessionKey, em, emf);

                            refInfo.refCount = 1;

                            extendedEMReferenceCountMap.put(em, refInfo);

                            eemKey2EEMMap.put(refInfo.getKey(), refInfo.getEntityManager());

                        }

                    }

                    ctx.addExtendedEntityManagerMapping(emf, refInfo);

                    eemRefInfos.add(refInfo);

                } else {

                    throw new EJBException("EMF is null. Couldn't get extended EntityManager for"

                            + " refName: " + refDesc.getName()

                            + "; unitname: " + unitName);

                }

            }       

  }

  if (eemRefInfos.size() > 0) {

      ctx.setEEMRefInfos(eemRefInfos);

  }

    }

   

    private EntityManager findExtendedEMFromInvList(EntityManagerFactory emf) {

        EntityManager em = null;

        ComponentInvocation compInv = (ComponentInvocation)

            invocationManager.getCurrentInvocation();

        if (compInv != null) {

            if (compInv.getInvocationType() == ComponentInvocation.EJB_INVOCATION) {

                if (compInv.context instanceof SessionContextImpl) {

                    SessionContextImpl ctxImpl = (SessionContextImpl) compInv.context;

                    if (ctxImpl.container instanceof StatefulSessionContainer) {

                        em = ctxImpl.getExtendedEntityManager(emf);

                    }

                }

            }

        }

        return em;

    }

  

    private void afterInstanceCreation(SessionContextImpl context)

        throws Exception {

        context.setState(READY);

        Invocation i = null;

        try {

            // Need to do preInvoke because setSessionContext can access JNDI

            i = new Invocation(context.getEJB(), this);

            i.context = context;

            invocationManager.preInvoke(i);

            // PostConstruct must be called after state set to something

            // other than NOT_INITIALIZED

            interceptorManager.intercept(CallbackType.POST_CONSTRUCT, context);

        } catch(Throwable t) {

            EJBException ejbEx = new EJBException();

            ejbEx.initCause(t);

            throw ejbEx;

        } finally {

            if ( i != null ) {

                invocationManager.postInvoke(i);

            }

        }

        statCreateCount++;

        incrementMethodReadyStat();

    }

   

       

    // called from createEJBObject and activateEJB and createEJBLocalObjectImpl

    private EJBLocalObjectImpl createEJBLocalObjectImpl

        (SessionContextImpl context) throws Exception

    {

        if ( context.getEJBLocalObjectImpl() != null )

            return context.getEJBLocalObjectImpl();

       

        // create EJBLocalObject

        EJBLocalObjectImpl localObjImpl = instantiateEJBLocalObjectImpl();

       

        // introduce context and EJBLocalObject to each other

        context.setEJBLocalObjectImpl(localObjImpl);

        localObjImpl.setContext(context);

        localObjImpl.setKey(context.getInstanceKey());

       

        if ( hasLocalBusinessView ) {

            createEJBLocalBusinessObjectImpl(context);

        }

        if ( hasRemoteHomeView ) {

            createEJBObjectImpl(context);  // enable remote invocations too

        }

        if( hasRemoteBusinessView ) {

            createRemoteBusinessObjectImpl(context);

        }

       

        return localObjImpl;

    }

    private EJBLocalObjectImpl createEJBLocalBusinessObjectImpl

        (SessionContextImpl context) throws Exception

    {

        if ( context.getEJBLocalBusinessObjectImpl() != null )

            return context.getEJBLocalBusinessObjectImpl();

       

        EJBLocalObjectImpl localBusinessObjImpl =

            instantiateEJBLocalBusinessObjectImpl();

       

        context.setEJBLocalBusinessObjectImpl(localBusinessObjImpl);

        localBusinessObjImpl.setContext(context);

        localBusinessObjImpl.setKey(context.getInstanceKey());

       

        if( hasLocalHomeView ) {

            createEJBLocalObjectImpl(context);

        }

        if ( hasRemoteHomeView ) {

            createEJBObjectImpl(context);  // enable remote invocations too

        }

        if( hasRemoteBusinessView ) {

            createRemoteBusinessObjectImpl(context);

        }

       

        return localBusinessObjImpl;

    }

    // called from createEJBObject and activateEJB and createEJBLocalObjectImpl

    private EJBObjectImpl createEJBObjectImpl(SessionContextImpl context)

        throws Exception