/*
 * JBoss, Home of Professional Open Source
 * Copyright 2005, JBoss Inc., and individual contributors as indicated
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.jboss.ejb.plugins;

import EDU.oswego.cs.dl.util.concurrent.FIFOSemaphore;
import org.jboss.deployment.DeploymentException;
import org.jboss.ejb.Container;
import org.jboss.ejb.EnterpriseContext;
import org.jboss.ejb.InstancePool;
import org.jboss.metadata.MetaData;
import org.jboss.metadata.XmlLoadable;
import org.jboss.system.ServiceMBeanSupport;
import org.w3c.dom.Element;

import javax.ejb.EJBException;
import java.rmi.RemoteException;

/**
 *  Abstract Instance Pool class containing the basic logic to create
 *  an EJB Instance Pool.
 *
 *  @author <a href="mailto:rickard.oberg@telkel.com">Rickard �berg</a>
 *  @author <a href="mailto:marc.fleury@jboss.org">Marc Fleury</a>
 *  @author <a href="mailto:andreas.schaefer@madplanet.com">Andreas Schaefer</a>
 *  @author <a href="mailto:sacha.labourey@cogito-info.ch">Sacha Labourey</a>
 *  @author <a href="mailto:scott.stark@jboss.org">Scott Stark/a>
 *  @version $Revision: 1.28.2.16 $
 *
 * @jmx:mbean extends="org.jboss.system.ServiceMBean"
 */
public abstract class AbstractInstancePool
        extends ServiceMBeanSupport
        implements AbstractInstancePoolMBean, InstancePool, XmlLoadable
{
   // Constants -----------------------------------------------------

   // Attributes ----------------------------------------------------
   /** A FIFO semaphore that is set when the strict max size behavior is in effect.
    When set, only maxSize instances may be active and any attempt to get an
    instance will block until an instance is freed.
    */
   private FIFOSemaphore strictMaxSize;
   /** The time in milliseconds to wait for the strictMaxSize semaphore.
    */
   private long strictTimeout = Long.MAX_VALUE;
   /** The Container the instance pool is associated with */
   protected Container container;
   /** The pool data structure */
   protected EnterpriseContext[] pool;
   protected int currentIndex = -1;
   /** The maximum number of instances allowed in the pool */
   protected int maxSize = 30;
   /** The minimum size of the pool */
   protected int minSize = 0;
   /** determine if we reuse EnterpriseContext objects i.e. if we actually do pooling */
   protected boolean reclaim = false;

   protected volatile int overMin = 0;
   protected volatile int overMax = 0;


   protected boolean minSizeInitialized = false;

   // Static --------------------------------------------------------

   // Constructors --------------------------------------------------

   // Public --------------------------------------------------------

   /**
    *   Set the callback to the container. This is for initialization.
    *   The IM may extract the configuration from the container.
    *
    * @param   c
    */
   public void setContainer(Container c)
   {
      this.container = c;
   }

   /**
    * @return Callback to the container which can be null if not set proviously
    */
   public Container getContainer()
   {
      return container;
   }

   /**
    * @jmx:managed-attribute
    * @return the current pool size
    */
   public int getCurrentSize()
   {
      return currentIndex + 1;
   }

   /**
    * @jmx:managed-attribute
    * @return the current pool size
    */
   public int getMaxSize()
   {
      return this.maxSize;
   }

   /**
    *   Get an instance without identity.
    *   Can be used by finders,create-methods, and activation
    *
    * @return     Context /w instance
    * @exception   RemoteException
    */
   public EnterpriseContext get()
           throws Exception
   {
      boolean trace = log.isTraceEnabled();
      if (trace)
         log.trace("Get instance " + this + "#" + (currentIndex + 1) + "#" + getContainer().getBeanClass());

      if (strictMaxSize != null)
      {
         // Block until an instance is available
         boolean acquired = strictMaxSize.attempt(strictTimeout);
         if (trace)
            log.trace("Acquired(" + acquired + ") strictMaxSize semaphore, remaining=" + strictMaxSize.permits());
         if (acquired == false)
            throw new EJBException("Failed to acquire the pool semaphore, strictTimeout=" + strictTimeout);
      }

      synchronized (pool)
      {
         if (currentIndex > -1)
         {
            EnterpriseContext ctx = pool[currentIndex];
            pool[currentIndex--] = null;
            overMin = 0;
            return ctx;
         }
      }

      if (!minSizeInitialized)
      {
         minSizeInitialized = true;
         synchronized (pool)
         {
            for (int i = 0; i < minSize; i++)
            {
               pool[++currentIndex] = create(container.createBeanClassInstance());
            }
         }
      }
      /*
      else if (minSize > 0 && ++overMin > overMax)
      {
         overMax = overMin;

         log.warn("Went beyond min size for" + container.getBeanMetaData().getEjbName() + ": " + overMax);
      }
      */
      // Pool is empty, create an instance
      try
      {
         return create(container.createBeanClassInstance());
      }
      catch (InstantiationException e)
      {
         throw new EJBException("Could not instantiate bean", e);
      }
      catch (IllegalAccessException e)
      {
         throw new EJBException("Could not instantiate bean", e);
      }
   }

   /**
    *   Return an instance after invocation.
    *
    *   Called in 2 cases:
    *   a) Done with finder method
    *   b) Just removed
    *
    * @param   ctx
    */
   public void free(EnterpriseContext ctx)
   {
      if (log.isTraceEnabled())
      {
         String msg = (currentIndex + 1) + "/" + maxSize + " Free instance:" + this
                 + "#" + ctx.getId()
                 + "#" + ctx.getTransaction()
                 + "#" + reclaim
                 + "#" + getContainer().getBeanClass();
         log.trace(msg);
      }

      ctx.clear();

      try
      {
         // Add the unused context back into the pool
         synchronized (pool)
         {
            if (currentIndex + 1 < maxSize)
            {
               pool[++currentIndex] = ctx;
            } // end of if ()
         }
         // If we block when maxSize instances are in use, invoke release on strictMaxSize
         if (strictMaxSize != null)
            strictMaxSize.release();
      }
      catch (Exception ignored)
      {
      }
   }

   public void discard(EnterpriseContext ctx)
   {
      if (log.isTraceEnabled())
      {
         String msg = "Discard instance:" + this + "#" + ctx
                 + "#" + ctx.getTransaction()
                 + "#" + reclaim
                 + "#" + getContainer().getBeanClass();
         log.trace(msg);
      }

      // If we block when maxSize instances are in use, invoke release on strictMaxSize
      if (strictMaxSize != null)
         strictMaxSize.release();

      // Throw away, unsetContext()
      try
      {
         ctx.discard();
      }
      catch (RemoteException e)
      {
         if (log.isTraceEnabled())
            log.trace("Ctx.discard error", e);
      }
   }

   /**
    * @jmx:managed-attribute
    * @return the maximum size.
    */
   public int getMaximumSize()
   {
      return maxSize;
   }

   /**
    * @jmx:managed-attribute
    * @return the minimum size.
    */
   public int getMinimumSize()
   {
      return minSize;
   }

   /**
    * @jmx:managed-attribute
    * @return whether string pooling.
    */
   public boolean getStrictMaximumSize()
   {
      return strictMaxSize != null;
   }

   /**
    * @jmx:managed-attribute
    * @return the strict timeout.
    */
   public long getStrictTimeout()
   {
      return strictTimeout;
   }
   
   /**
    * XmlLoadable implementation
    */
   public void importXml(Element element) throws DeploymentException
   {
      String maximumSize = MetaData.getElementContent(MetaData.getUniqueChild(element, "MaximumSize"));
      try
      {
         this.maxSize = Integer.parseInt(maximumSize);
         this.pool = new EnterpriseContext[maxSize];
      }
      catch (NumberFormatException e)
      {
         throw new DeploymentException("Invalid MaximumSize value for instance pool configuration");
      }

      String minimumSize = MetaData.getElementContent(MetaData.getOptionalChild(element, "MinimumSize"));
      if (minimumSize != null)
      {
         try
         {
            this.minSize = Integer.parseInt(minimumSize);
            if (minSize < 1) minSizeInitialized = true; // don't pre-initialize
         }
         catch (NumberFormatException e)
         {
            throw new DeploymentException("Invalid MinimumSize value for instance pool configuration");
         }
      }

      // Get whether the pool will block when MaximumSize instances are active
      String strictValue = MetaData.getElementContent(MetaData.getOptionalChild(element, "strictMaximumSize"));
      Boolean strictFlag = Boolean.valueOf(strictValue);
      if (strictFlag == Boolean.TRUE)
         this.strictMaxSize = new FIFOSemaphore(this.maxSize);
      String delay = MetaData.getElementContent(MetaData.getOptionalChild(element, "strictTimeout"));
      try
      {
         if (delay != null)
            this.strictTimeout = Long.parseLong(delay);
      }
      catch (NumberFormatException e)
      {
         throw new DeploymentException("Invalid strictTimeout value for instance pool configuration");
      }
   }

   // Package protected ---------------------------------------------

   // Protected -----------------------------------------------------
   protected abstract EnterpriseContext create(Object instance)
           throws Exception;

   protected void destroyService() throws Exception
   {
      freeAll();
      this.container = null;
   }
   
   // Private -------------------------------------------------------

   /**
    * At undeployment we want to free completely the pool.
    */
   private void freeAll()
   {
      synchronized (pool)
      {
         for (int i = 0; i < currentIndex + 1; ++i)
         {
            pool[i].clear();
            discard(pool[i]);
            pool[i] = null;
         }
      }
   }

   // Inner classes -------------------------------------------------

}
