org.springframework.web.portlet.mvc.PortletWrappingController Maven / Gradle / Ivy
/*
* Copyright 2002-2006 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.mvc;
import java.util.Enumeration;
import java.util.Locale;
import java.util.Properties;
import java.util.ResourceBundle;
import javax.portlet.ActionRequest;
import javax.portlet.ActionResponse;
import javax.portlet.Portlet;
import javax.portlet.PortletConfig;
import javax.portlet.PortletContext;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;
import org.springframework.beans.factory.BeanNameAware;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.web.portlet.ModelAndView;
import org.springframework.web.portlet.context.PortletConfigAware;
import org.springframework.web.portlet.context.PortletContextAware;
/**
* {@link Controller} implementation that wraps a portlet instance which it manages
* internally. Such a wrapped portlet is not known outside of this controller;
* its entire lifecycle is covered here.
*
* Useful to invoke an existing portlet via Spring's dispatching infrastructure,
* for example to apply Spring
* {@link org.springframework.web.portlet.HandlerInterceptor HandlerInterceptors}
* to its requests.
*
*
Example:
*
*
<bean id="wrappingController" class="org.springframework.web.portlet.mvc.PortletWrappingController">
* <property name="portletClass">
* <value>org.springframework.web.portlet.sample.HelloWorldPortlet</value>
* </property>
* <property name="portletName">
* <value>hello-world</value>
* </property>
* <property name="initParameters">
* <props>
* <prop key="config">/WEB-INF/hello-world-portlet-config.xml</prop>
* </props>
* </property>
* </bean>
*
* @author Juergen Hoeller
* @author John A. Lewis
* @since 2.0
*/
public class PortletWrappingController extends AbstractController
implements BeanNameAware, InitializingBean, DisposableBean, PortletContextAware, PortletConfigAware {
private boolean useSharedPortletConfig = true;
private PortletContext portletContext;
private PortletConfig portletConfig;
private Class portletClass;
private String portletName;
private Properties initParameters = new Properties();
private String beanName;
private Portlet portletInstance;
/**
* Set whether to use the shared PortletConfig object passed in
* through setPortletConfig, if available.
* Default is "true". Turn this setting to "false" to pass in
* a mock PortletConfig object with the bean name as portlet name,
* holding the current PortletContext.
* @see #setPortletConfig
*/
public void setUseSharedPortletConfig(boolean useSharedPortletConfig) {
this.useSharedPortletConfig = useSharedPortletConfig;
}
public void setPortletContext(PortletContext portletContext) {
this.portletContext = portletContext;
}
public void setPortletConfig(PortletConfig portletConfig) {
this.portletConfig = portletConfig;
}
/**
* Set the class of the Portlet to wrap.
* Needs to implement javax.portlet.Portlet.
* @see javax.portlet.Portlet
*/
public void setPortletClass(Class portletClass) {
this.portletClass = portletClass;
}
/**
* Set the name of the Portlet to wrap.
* Default is the bean name of this controller.
*/
public void setPortletName(String portletName) {
this.portletName = portletName;
}
/**
* Specify init parameters for the portlet to wrap,
* as name-value pairs.
*/
public void setInitParameters(Properties initParameters) {
this.initParameters = initParameters;
}
public void setBeanName(String name) {
this.beanName = name;
}
public void afterPropertiesSet() throws Exception {
if (this.portletClass == null) {
throw new IllegalArgumentException("portletClass is required");
}
if (!Portlet.class.isAssignableFrom(this.portletClass)) {
throw new IllegalArgumentException("portletClass [" + this.portletClass.getName() +
"] needs to implement interface [javax.portlet.Portlet]");
}
if (this.portletName == null) {
this.portletName = this.beanName;
}
PortletConfig config = this.portletConfig;
if (config == null || !this.useSharedPortletConfig) {
config = new DelegatingPortletConfig();
}
this.portletInstance = (Portlet) this.portletClass.newInstance();
this.portletInstance.init(config);
}
protected void handleActionRequestInternal(
ActionRequest request, ActionResponse response) throws Exception {
this.portletInstance.processAction(request, response);
}
protected ModelAndView handleRenderRequestInternal(
RenderRequest request, RenderResponse response) throws Exception {
this.portletInstance.render(request, response);
return null;
}
public void destroy() {
this.portletInstance.destroy();
}
/**
* Internal implementation of the PortletConfig interface, to be passed
* to the wrapped portlet.
*
Delegates to {@link PortletWrappingController} fields
* and methods to provide init parameters and other environment info.
*/
private class DelegatingPortletConfig implements PortletConfig {
public String getPortletName() {
return portletName;
}
public PortletContext getPortletContext() {
return portletContext;
}
public String getInitParameter(String paramName) {
return initParameters.getProperty(paramName);
}
public Enumeration getInitParameterNames() {
return initParameters.keys();
}
public ResourceBundle getResourceBundle(Locale locale) {
return (portletConfig != null ? portletConfig.getResourceBundle(locale) : null);
}
}
}