|
spring-webmvc-portlet | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.springframework.context.support.ApplicationObjectSupport
org.springframework.web.portlet.context.PortletApplicationObjectSupport
org.springframework.web.portlet.handler.PortletContentGenerator
org.springframework.web.portlet.mvc.AbstractController
org.springframework.web.portlet.mvc.PortletWrappingController
public class PortletWrappingController
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
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>
| Field Summary |
|---|
| Fields inherited from class org.springframework.context.support.ApplicationObjectSupport |
|---|
logger |
| Constructor Summary | |
|---|---|
PortletWrappingController()
|
|
| Method Summary | |
|---|---|
void |
afterPropertiesSet()
|
void |
destroy()
|
protected void |
handleActionRequestInternal(javax.portlet.ActionRequest request,
javax.portlet.ActionResponse response)
Subclasses are meant to override this method if the controller is expected to handle action requests. |
void |
handleEventRequest(javax.portlet.EventRequest request,
javax.portlet.EventResponse response)
Process the event request. |
protected ModelAndView |
handleRenderRequestInternal(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
Subclasses are meant to override this method if the controller is expected to handle render requests. |
ModelAndView |
handleResourceRequest(javax.portlet.ResourceRequest request,
javax.portlet.ResourceResponse response)
Process the resource request and return a ModelAndView object which the DispatcherPortlet will render. |
void |
setBeanName(java.lang.String name)
|
void |
setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters)
Specify init parameters for the portlet to wrap, as name-value pairs. |
void |
setPortletClass(java.lang.Class portletClass)
Set the class of the Portlet to wrap. |
void |
setPortletConfig(javax.portlet.PortletConfig portletConfig)
Set the PortletConfigthat this object runs in. |
void |
setPortletContext(javax.portlet.PortletContext portletContext)
Set the PortletContext that this object runs in. |
void |
setPortletName(java.lang.String portletName)
Set the name of the Portlet to wrap. |
void |
setUseSharedPortletConfig(boolean useSharedPortletConfig)
Set whether to use the shared PortletConfig object passed in through setPortletConfig, if available. |
| Methods inherited from class org.springframework.web.portlet.mvc.AbstractController |
|---|
handleActionRequest, handleRenderRequest, isRenderWhenMinimized, isSynchronizeOnSession, setRenderWhenMinimized, setSynchronizeOnSession |
| Methods inherited from class org.springframework.web.portlet.handler.PortletContentGenerator |
|---|
applyCacheSeconds, cacheForSeconds, check, checkAndPrepare, checkAndPrepare, getCacheSeconds, isRequireSession, preventCaching, setCacheSeconds, setRequireSession |
| Methods inherited from class org.springframework.web.portlet.context.PortletApplicationObjectSupport |
|---|
getPortletContext, getTempDir, isContextRequired |
| Methods inherited from class org.springframework.context.support.ApplicationObjectSupport |
|---|
getApplicationContext, getMessageSourceAccessor, initApplicationContext, initApplicationContext, requiredContextClass, setApplicationContext |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public PortletWrappingController()
| Method Detail |
|---|
public void setUseSharedPortletConfig(boolean useSharedPortletConfig)
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.
setPortletConfig(javax.portlet.PortletConfig)public void setPortletContext(javax.portlet.PortletContext portletContext)
PortletContextAwareInvoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked after ApplicationContextAware's setApplicationContext.
setPortletContext in interface PortletContextAwaresetPortletContext in class PortletApplicationObjectSupportportletContext - PortletContext object to be used by this objectpublic void setPortletConfig(javax.portlet.PortletConfig portletConfig)
PortletConfigAwareInvoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked after ApplicationContextAware's setApplicationContext.
setPortletConfig in interface PortletConfigAwareportletConfig - PortletConfig object to be used by this objectpublic void setPortletClass(java.lang.Class portletClass)
javax.portlet.Portlet.
Portletpublic void setPortletName(java.lang.String portletName)
public void setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters)
public void setBeanName(java.lang.String name)
setBeanName in interface org.springframework.beans.factory.BeanNameAware
public void afterPropertiesSet()
throws java.lang.Exception
afterPropertiesSet in interface org.springframework.beans.factory.InitializingBeanjava.lang.Exception
protected void handleActionRequestInternal(javax.portlet.ActionRequest request,
javax.portlet.ActionResponse response)
throws java.lang.Exception
AbstractControllerhandleActionRequest.
The default implementation throws a PortletException.
handleActionRequestInternal in class AbstractControllerjava.lang.ExceptionAbstractController.handleActionRequest(javax.portlet.ActionRequest, javax.portlet.ActionResponse),
AbstractController.handleRenderRequestInternal(javax.portlet.RenderRequest, javax.portlet.RenderResponse)
protected ModelAndView handleRenderRequestInternal(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
throws java.lang.Exception
AbstractControllerhandleRenderRequest.
The default implementation throws a PortletException.
handleRenderRequestInternal in class AbstractControllerjava.lang.ExceptionAbstractController.handleRenderRequest(javax.portlet.RenderRequest, javax.portlet.RenderResponse),
AbstractController.handleActionRequestInternal(javax.portlet.ActionRequest, javax.portlet.ActionResponse)
public ModelAndView handleResourceRequest(javax.portlet.ResourceRequest request,
javax.portlet.ResourceResponse response)
throws java.lang.Exception
ResourceAwareControllernull return value is not an error: It indicates that this
object completed request processing itself, thus there is no ModelAndView to render.
handleResourceRequest in interface ResourceAwareControllerrequest - current portlet resource requestresponse - current portlet resource response
java.lang.Exception - in case of errors
public void handleEventRequest(javax.portlet.EventRequest request,
javax.portlet.EventResponse response)
throws java.lang.Exception
EventAwareController
handleEventRequest in interface EventAwareControllerrequest - current portlet event requestresponse - current portlet event response
java.lang.Exception - in case of errorspublic void destroy()
destroy in interface org.springframework.beans.factory.DisposableBean
|
spring-webmvc-portlet | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||