RenderRequestFactory.java :  » Portal » liferay-portal-4.4.2 » com » liferay » portlet » Java Open Source

/**
 * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.liferay.portlet;

import com.liferay.portal.model.Portlet;
import com.liferay.portal.util.PropsValues;

import javax.portlet.PortletContext;
import javax.portlet.PortletMode;
import javax.portlet.PortletPreferences;
import javax.portlet.WindowState;

import javax.servlet.http.HttpServletRequest;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.commons.pool.BasePoolableObjectFactory;
import org.apache.commons.pool.ObjectPool;
import org.apache.commons.pool.impl.StackObjectPool;

/**
 * <a href="RenderRequestFactory.java.html"><b><i>View Source</i></b></a>
 *
 * @author Brian Wing Shun Chan
 *
 */
public class RenderRequestFactory {

  public static RenderRequestImpl create(
      HttpServletRequest req, Portlet portlet, CachePortlet cachePortlet,
      PortletContext portletCtx, WindowState windowState,
      PortletMode portletMode, PortletPreferences prefs)
    throws Exception {

    return create(
      req, portlet, cachePortlet, portletCtx, windowState, portletMode,
      prefs, 0);
  }

  public static RenderRequestImpl create(
      HttpServletRequest req, Portlet portlet, CachePortlet cachePortlet,
      PortletContext portletCtx, WindowState windowState,
      PortletMode portletMode, PortletPreferences prefs, long plid)
    throws Exception {

    if (PropsValues.COMMONS_POOL_ENABLED) {
      if (_log.isDebugEnabled()) {
        _log.debug(
          "Borrowing:\t" + _instance._pool.getNumIdle() + "\t" +
            _instance._pool.getNumActive());
      }
    }

    RenderRequestImpl renderRequestImpl = null;

    if (PropsValues.COMMONS_POOL_ENABLED) {
      renderRequestImpl =
        (RenderRequestImpl)_instance._pool.borrowObject();
    }
    else {
      renderRequestImpl = new RenderRequestImpl();
    }

    renderRequestImpl.init(
      req, portlet, cachePortlet, portletCtx, windowState, portletMode,
      prefs, plid);

    return renderRequestImpl;
  }

  public static void recycle(RenderRequestImpl renderRequestImpl)
    throws Exception {

    if (PropsValues.COMMONS_POOL_ENABLED) {
      if (_log.isDebugEnabled()) {
        _log.debug(
          "Recycling:\t" + _instance._pool.getNumIdle() + "\t" +
            _instance._pool.getNumActive());
      }

      _instance._pool.returnObject(renderRequestImpl);
    }
    else if (renderRequestImpl != null) {
      renderRequestImpl.recycle();
    }
  }

  private RenderRequestFactory() {
    _pool = new StackObjectPool(new Factory());
  }

  private static Log _log =
    LogFactory.getLog(RenderRequestFactory.class);

  private static RenderRequestFactory _instance = new RenderRequestFactory();

  private ObjectPool _pool;

  private class Factory extends BasePoolableObjectFactory {

    public Object makeObject() {
      return new RenderRequestImpl();
    }

    public void passivateObject(Object obj) {
      RenderRequestImpl renderRequestImpl = (RenderRequestImpl)obj;

      renderRequestImpl.recycle();
    }

  }

}