/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.container.invoker;
import java.io.IOException;
import javax.portlet.ActionRequest;
import javax.portlet.ActionResponse;
import javax.portlet.PortletException;
import javax.portlet.PortletRequest;
import javax.portlet.PortletResponse;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;
import javax.portlet.UnavailableException;
import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletRequest;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.jetspeed.PortalReservedParameters;
import org.apache.jetspeed.container.ContainerConstants;
import org.apache.jetspeed.container.PortletRequestContext;
import org.apache.jetspeed.factory.PortletFactory;
import org.apache.jetspeed.factory.PortletInstance;
import org.apache.jetspeed.om.common.portlet.PortletApplication;
import org.apache.jetspeed.request.RequestContext;
import org.apache.pluto.om.portlet.PortletDefinition;
/**
* LocalPortletInvoker invokes local (internal) portlet applications.
* Local portlet applications are stored within the Jetspeed Portlet application.
* They are not separate web applications; but are stored under Jetspeed's
* WEB-INF/apps directory.
* <h3>Sample Configuration</h3>
* <pre>
* <code>
* factory.invoker.local = org.apache.jetspeed.container.invoker.LocalPortletInvoker
* factory.invoker.local.pool.size = 50
* </code>
* </pre>
* @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
* @version $Id: LocalPortletInvoker.java 517719 2007-03-13 15:05:48Z ate $
*/
public class LocalPortletInvoker implements JetspeedPortletInvoker
{
private final static Log log = LogFactory.getLog(LocalPortletInvoker.class);
protected PortletFactory portletFactory;
protected ServletContext jetspeedContext;
protected ServletConfig jetspeedConfig;
protected PortletDefinition portletDefinition;
protected boolean activated = false;
/* (non-Javadoc)
* @see org.apache.jetspeed.container.invoker.JetspeedPortletInvoker#activate(PortletFactory,org.apache.pluto.om.portlet.PortletDefinition, javax.servlet.ServletConfig)
*/
public void activate(PortletFactory portletFactory, PortletDefinition portletDefinition, ServletConfig servletConfig)
{
this.portletFactory = portletFactory;
this.jetspeedConfig = servletConfig;
jetspeedContext = servletConfig.getServletContext();
this.portletDefinition = portletDefinition;
activated = true;
}
/* (non-Javadoc)
* @see org.apache.jetspeed.container.invoker.JetspeedPortletInvoker#passivate()
*/
public void passivate()
{
activated = false;
}
/* (non-Javadoc)
* @see org.apache.jetspeed.container.invoker.JetspeedPortletInvoker#isActivated()
*/
public boolean isActivated()
{
return activated;
}
public LocalPortletInvoker()
{
activated = false;
}
/* (non-Javadoc)
* @see org.apache.pluto.invoker.PortletInvoker#action(javax.portlet.ActionRequest, javax.portlet.ActionResponse)
*/
public void action(ActionRequest request, ActionResponse response)
throws PortletException, IOException
{
invoke(request, response, ContainerConstants.METHOD_ACTION);
}
/* (non-Javadoc)
* @see org.apache.pluto.invoker.PortletInvoker#render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)
*/
public void render(RenderRequest request, RenderResponse response)
throws PortletException, IOException
{
invoke(request, response, ContainerConstants.METHOD_RENDER);
}
/* (non-Javadoc)
* @see org.apache.pluto.invoker.PortletInvoker#load(javax.portlet.PortletRequest, javax.portlet.RenderResponse)
*/
public void load(PortletRequest request, RenderResponse response)
throws PortletException
{
try
{
invoke(request, response, ContainerConstants.METHOD_NOOP);
}
catch (IOException e)
{
log.error("LocalPortletInvokerImpl.load() - Error while dispatching portlet.", e);
throw new PortletException(e);
}
}
/**
* Invokes the specific request denoted by the <code>method</code> parameter on a portlet.
* The portlet is invoked with a direct method call on the portlet. It is not invoked in another web application.
* This requires manipulation of the current thread's classpath.
*
* @param portletRequest
* @param portletResponse
* @param methodID
* @throws PortletException
* @throws IOException
*/
protected void invoke(PortletRequest portletRequest, PortletResponse portletResponse, Integer method)
throws PortletException, IOException
{
ClassLoader paClassLoader = portletFactory
.getPortletApplicationClassLoader((PortletApplication) portletDefinition
.getPortletApplicationDefinition());
PortletInstance portletInstance = portletFactory.getPortletInstance(jetspeedContext, portletDefinition);
if (method == ContainerConstants.METHOD_NOOP)
{
return;
}
// gather all required data from request and response
ServletRequest servletRequest = ((javax.servlet.http.HttpServletRequestWrapper) portletRequest).getRequest();
ClassLoader oldLoader = Thread.currentThread().getContextClassLoader();
try
{
PortletRequestContext.createContext(portletDefinition, portletInstance, portletRequest, portletResponse);
servletRequest.setAttribute(ContainerConstants.PORTLET_CONFIG, portletInstance.getConfig());
servletRequest.setAttribute(ContainerConstants.PORTLET_REQUEST, portletRequest);
servletRequest.setAttribute(ContainerConstants.PORTLET_RESPONSE, portletResponse);
RequestContext requestContext = (RequestContext) servletRequest
.getAttribute(PortalReservedParameters.REQUEST_CONTEXT_ATTRIBUTE);
servletRequest
.setAttribute(ContainerConstants.PORTAL_CONTEXT, requestContext.getRequest().getContextPath());
Thread.currentThread().setContextClassLoader(paClassLoader);
if (method == ContainerConstants.METHOD_ACTION)
{
ActionRequest actionRequest = (ActionRequest) portletRequest;
ActionResponse actionResponse = (ActionResponse) portletResponse;
portletInstance.processAction(actionRequest, actionResponse);
}
else if (method == ContainerConstants.METHOD_RENDER)
{
RenderRequest renderRequest = (RenderRequest) portletRequest;
RenderResponse renderResponse = (RenderResponse) portletResponse;
renderResponse.setContentType("text/html");
// TODO: ???
// renderResponse.getWriter().print(portletDefinition.getName());
portletInstance.render(renderRequest, renderResponse);
}
}
catch (Throwable t)
{
if ( t instanceof UnavailableException )
{
// take it out of service
try
{
portletInstance.destroy();
}
catch (Throwable ignore)
{
// never mind, it won't be used anymore
}
}
if ( t instanceof PortletException )
{
throw (PortletException)t;
}
if ( t instanceof IOException )
{
throw (IOException)t;
}
else
{
throw new PortletException(t);
}
}
finally
{
PortletRequestContext.clearContext();
servletRequest.removeAttribute(ContainerConstants.PORTLET_CONFIG);
servletRequest.removeAttribute(ContainerConstants.PORTLET_REQUEST);
servletRequest.removeAttribute(ContainerConstants.PORTLET_RESPONSE);
servletRequest.removeAttribute(ContainerConstants.PORTAL_CONTEXT);
Thread.currentThread().setContextClassLoader(oldLoader);
}
}
/* (non-Javadoc)
* @see org.apache.jetspeed.container.invoker.JetspeedPortletInvoker#activate(PortletFactory,org.apache.pluto.om.portlet.PortletDefinition, javax.servlet.ServletConfig, java.lang.String)
*/
public void activate(PortletFactory portletFactory, PortletDefinition portletDefinition, ServletConfig servletConfig, String servletMappingName)
{
activate(portletFactory, portletDefinition, servletConfig);
}
}