/*
* Copyright 2002-2010 the original author or authors.
*
* Licensed 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.springframework.web.portlet.handler;
import javax.portlet.ActionRequest;
import javax.portlet.ActionResponse;
import javax.portlet.EventPortlet;
import javax.portlet.EventRequest;
import javax.portlet.EventResponse;
import javax.portlet.Portlet;
import javax.portlet.PortletContext;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;
import javax.portlet.ResourceRequest;
import javax.portlet.ResourceResponse;
import javax.portlet.ResourceServingPortlet;
import org.springframework.web.portlet.HandlerAdapter;
import org.springframework.web.portlet.ModelAndView;
import org.springframework.web.portlet.context.PortletContextAware;
import org.springframework.web.portlet.util.PortletUtils;
/**
* Adapter to use the Portlet interface with the generic DispatcherPortlet.
* Calls the Portlet's <code>render</code> and <code>processAction</code>
* methods to handle a request.
*
* <p>This adapter is not activated by default; it needs to be defined as a
* bean in the DispatcherPortlet context. It will automatically apply to
* mapped handler beans that implement the Portlet interface then.
*
* <p>Note that Portlet instances defined as bean will not receive initialization
* and destruction callbacks, unless a special post-processor such as
* SimplePortletPostProcessor is defined in the DispatcherPortlet context.
*
* <p><b>Alternatively, consider wrapping a Portlet with Spring's
* PortletWrappingController.</b> This is particularly appropriate for
* existing Portlet classes, allowing to specify Portlet initialization
* parameters, etc.
*
* @author John A. Lewis
* @since 2.0
* @see javax.portlet.Portlet
* @see SimplePortletPostProcessor
* @see org.springframework.web.portlet.mvc.PortletWrappingController
*/
public class SimplePortletHandlerAdapter implements HandlerAdapter, PortletContextAware {
private PortletContext portletContext;
public void setPortletContext(PortletContext portletContext) {
this.portletContext = portletContext;
}
public boolean supports(Object handler) {
return (handler instanceof Portlet);
}
public void handleAction(ActionRequest request, ActionResponse response, Object handler)
throws Exception {
((Portlet) handler).processAction(request, response);
}
public ModelAndView handleRender(RenderRequest request, RenderResponse response, Object handler)
throws Exception {
((Portlet) handler).render(request, response);
return null;
}
public ModelAndView handleResource(ResourceRequest request, ResourceResponse response, Object handler)
throws Exception {
if (handler instanceof ResourceServingPortlet) {
((ResourceServingPortlet) handler).serveResource(request, response);
}
else {
// roughly equivalent to Portlet 2.0 GenericPortlet
PortletUtils.serveResource(request, response, this.portletContext);
}
return null;
}
public void handleEvent(EventRequest request, EventResponse response, Object handler) throws Exception {
if (handler instanceof EventPortlet) {
((EventPortlet) handler).processEvent(request, response);
}
else {
// if no event processing method was found just keep render params
response.setRenderParameters(request);
}
}
}
|