public class DispatcherPortlet extends FrameworkPortlet
This portlet is very flexible: It can be used with just about any workflow, with the installation of the appropriate adapter classes. It offers the following functionality that distinguishes it from other request-driven Portlet MVC frameworks:
HandlerMapping
implementation - pre-built or provided
as part of an application - to control the routing of requests to handler objects.
Default is a DefaultAnnotationHandlerMapping
.
HandlerMapping objects can be defined as beans in the portlet's application context,
implementing the HandlerMapping interface, overriding the default HandlerMapping
if present. HandlerMappings can be given any bean name (they are tested by type).
HandlerAdapter
; this allows for using any handler interface.
The default adapter is SimpleControllerHandlerAdapter
for Spring's Controller
interface.
A default AnnotationMethodHandlerAdapter
will be registered as well. HandlerAdapter objects can be added as beans in the
application context, overriding the default HandlerAdapter. Like HandlerMappings,
HandlerAdapters can be given any bean name (they are tested by type).
HandlerExceptionResolver
, for example mapping certain exceptions to
error pages. Default is none. Additional HandlerExceptionResolvers can be added
through the application context. HandlerExceptionResolver can be given any
bean name (they are tested by type).
ViewResolver
implementation, resolving symbolic view names into View objects. Default is
InternalResourceViewResolver
.
ViewResolver objects can be added as beans in the application context,
overriding the default ViewResolver. ViewResolvers can be given any bean name
(they are tested by type).
PortletMultipartResolver
implementation. An implementations for Apache Commons FileUpload is included:
CommonsPortletMultipartResolver
.
The MultipartResolver bean name is "portletMultipartResolver"; default is none.
NOTE: The @RequestMapping
annotation will only be processed if a
corresponding HandlerMapping
(for type-level annotations) and/or
HandlerAdapter
(for method-level annotations) is present in the dispatcher.
This is the case by default. However, if you are defining custom HandlerMappings
or HandlerAdapters
, then you need to make sure that a corresponding custom
DefaultAnnotationHandlerMapping
and/or AnnotationMethodHandlerAdapter
is defined as well - provided that you intend to use @RequestMapping
.
A web application can define any number of DispatcherPortlets.
Each portlet will operate in its own namespace, loading its own application context
with mappings, handlers, etc. Only the root application context as loaded by
ContextLoaderListener
, if any, will be shared.
Thanks to Rainer Schmitz, Nick Lothian and Eric Dalquist for their suggestions!
Controller
,
ViewRendererServlet
,
ContextLoaderListener
Modifier and Type | Field and Description |
---|---|
static String |
ACTION_EXCEPTION_RENDER_PARAMETER
This render parameter is used to indicate forward to the render phase
that an exception occurred during the action phase.
|
static String |
ACTION_EXCEPTION_SESSION_ATTRIBUTE
Unlike the Servlet version of this class, we have to deal with the
two-phase nature of the portlet request.
|
static String |
DEFAULT_VIEW_RENDERER_URL
Default URL to ViewRendererServlet.
|
static String |
HANDLER_ADAPTER_BEAN_NAME
Well-known name for the HandlerAdapter object in the bean factory for this namespace.
|
static String |
HANDLER_EXCEPTION_RESOLVER_BEAN_NAME
Well-known name for the HandlerExceptionResolver object in the bean factory for this
namespace.
|
static String |
HANDLER_MAPPING_BEAN_NAME
Well-known name for the HandlerMapping object in the bean factory for this namespace.
|
static String |
MULTIPART_RESOLVER_BEAN_NAME
Well-known name for the PortletMultipartResolver object in the bean factory for this namespace.
|
static String |
PAGE_NOT_FOUND_LOG_CATEGORY
Log category to use when no mapped handler is found for a request.
|
protected static Log |
pageNotFoundLogger
Additional logger to use when no mapped handler is found for a request.
|
static String |
VIEW_RESOLVER_BEAN_NAME
Well-known name for the ViewResolver object in the bean factory for this namespace.
|
DEFAULT_CONTEXT_CLASS, DEFAULT_NAMESPACE_SUFFIX, DEFAULT_USERINFO_ATTRIBUTE_NAMES, PORTLET_CONTEXT_PREFIX
logger
Constructor and Description |
---|
DispatcherPortlet() |
Modifier and Type | Method and Description |
---|---|
protected ActionRequest |
checkMultipart(ActionRequest request)
Convert the request into a multipart request, and make multipart resolver available.
|
protected Object |
createDefaultStrategy(ApplicationContext context,
Class<?> clazz)
Create a default strategy.
|
protected void |
doActionService(ActionRequest request,
ActionResponse response)
Processes the actual dispatching to the handler for action requests.
|
protected void |
doDispatch(PortletRequestDispatcher dispatcher,
PortletRequest request,
MimeResponse response)
Perform a dispatch on the given PortletRequestDispatcher.
|
protected void |
doEventService(EventRequest request,
EventResponse response)
Processes the actual dispatching to the handler for event requests.
|
protected void |
doRender(View view,
Map<String,?> model,
PortletRequest request,
MimeResponse response)
Actually render the given view.
|
protected void |
doRenderService(RenderRequest request,
RenderResponse response)
Processes the actual dispatching to the handler for render requests.
|
protected void |
doResourceService(ResourceRequest request,
ResourceResponse response)
Processes the actual dispatching to the handler for resource requests.
|
protected void |
exposeActionException(PortletRequest request,
StateAwareResponse response,
Exception ex)
Expose the given action exception to the given response.
|
protected <T> List<T> |
getDefaultStrategies(ApplicationContext context,
Class<T> strategyInterface)
Create a List of default strategy objects for the given strategy interface.
|
protected <T> T |
getDefaultStrategy(ApplicationContext context,
Class<T> strategyInterface)
Return the default strategy object for the given strategy interface.
|
protected HandlerExecutionChain |
getHandler(PortletRequest request)
Return the HandlerExecutionChain for this request.
|
protected HandlerAdapter |
getHandlerAdapter(Object handler)
Return the HandlerAdapter for this handler object.
|
PortletMultipartResolver |
getMultipartResolver()
Obtain this portlet's PortletMultipartResolver, if any.
|
protected void |
initStrategies(ApplicationContext context)
Refresh the strategy objects that this portlet uses.
|
protected void |
noHandlerFound(PortletRequest request,
PortletResponse response)
No handler found -> throw appropriate exception.
|
void |
onRefresh(ApplicationContext context)
This implementation calls
initStrategies(org.springframework.context.ApplicationContext) . |
protected ModelAndView |
processHandlerException(RenderRequest request,
RenderResponse response,
Object handler,
Exception ex)
Determine an error ModelAndView via the registered HandlerExceptionResolvers.
|
protected ModelAndView |
processHandlerException(ResourceRequest request,
ResourceResponse response,
Object handler,
Exception ex)
Determine an error ModelAndView via the registered HandlerExceptionResolvers.
|
protected void |
render(ModelAndView mv,
PortletRequest request,
MimeResponse response)
Render the given ModelAndView.
|
protected View |
resolveViewName(String viewName,
Map<String,?> model,
PortletRequest request)
Resolve the given view name into a View object (to be rendered).
|
void |
setDetectAllHandlerAdapters(boolean detectAllHandlerAdapters)
Set whether to detect all HandlerAdapter beans in this portlet's context.
|
void |
setDetectAllHandlerExceptionResolvers(boolean detectAllHandlerExceptionResolvers)
Set whether to detect all HandlerExceptionResolver beans in this portlet's context.
|
void |
setDetectAllHandlerMappings(boolean detectAllHandlerMappings)
Set whether to detect all HandlerMapping beans in this portlet's context.
|
void |
setDetectAllViewResolvers(boolean detectAllViewResolvers)
Set whether to detect all ViewResolver beans in this portlet's context.
|
void |
setForwardActionException(boolean forwardActionException)
Set whether to forward exceptions thrown during the action phase
to the render phase via a session attribute.
|
void |
setForwardEventException(boolean forwardEventException)
Set whether to forward exceptions thrown during the event phase
to the render phase via a session attribute.
|
void |
setViewRendererUrl(String viewRendererUrl)
Set the URL to the ViewRendererServlet.
|
buildLocaleContext, createPortletApplicationContext, destroy, doDispatch, getContextClass, getContextConfigLocation, getNamespace, getPortletApplicationContext, getPortletContextAttributeName, getTitle, getUsernameForRequest, initFrameworkPortlet, initPortletApplicationContext, initPortletBean, onApplicationEvent, postProcessPortletApplicationContext, processAction, processEvent, processRequest, refresh, serveResource, setContextClass, setContextConfigLocation, setNamespace, setPublishContext, setPublishEvents, setThreadContextInheritable, setUserinfoUsernameAttributes
addRequiredProperty, createEnvironment, getEnvironment, getPortletContext, getPortletName, init, initBeanWrapper, setEnvironment
doEdit, doHeaders, doHelp, doView, getContainerRuntimeOptions, getDefaultNamespace, getInitParameter, getInitParameterNames, getNextPossiblePortletModes, getPortletConfig, getProcessingEventQNames, getPublicRenderParameterNames, getPublishingEventQNames, getResourceBundle, getSupportedLocales, init, render
public static final String MULTIPART_RESOLVER_BEAN_NAME
public static final String HANDLER_MAPPING_BEAN_NAME
public static final String HANDLER_ADAPTER_BEAN_NAME
public static final String HANDLER_EXCEPTION_RESOLVER_BEAN_NAME
public static final String VIEW_RESOLVER_BEAN_NAME
public static final String DEFAULT_VIEW_RENDERER_URL
org.springframework.web.view
package.public static final String ACTION_EXCEPTION_SESSION_ATTRIBUTE
public static final String ACTION_EXCEPTION_RENDER_PARAMETER
public static final String PAGE_NOT_FOUND_LOG_CATEGORY
protected static final Log pageNotFoundLogger
public void setDetectAllHandlerMappings(boolean detectAllHandlerMappings)
Default is true. Turn this off if you want this portlet to use a single HandlerMapping, despite multiple HandlerMapping beans being defined in the context.
public void setDetectAllHandlerAdapters(boolean detectAllHandlerAdapters)
Default is "true". Turn this off if you want this portlet to use a single HandlerAdapter, despite multiple HandlerAdapter beans being defined in the context.
public void setDetectAllHandlerExceptionResolvers(boolean detectAllHandlerExceptionResolvers)
Default is true. Turn this off if you want this portlet to use a single HandlerExceptionResolver, despite multiple HandlerExceptionResolver beans being defined in the context.
public void setDetectAllViewResolvers(boolean detectAllViewResolvers)
Default is true. Turn this off if you want this portlet to use a single ViewResolver, despite multiple ViewResolver beans being defined in the context.
public void setForwardActionException(boolean forwardActionException)
Default is true. Turn this off if you want the portlet container to provide immediate exception handling for action requests.
public void setForwardEventException(boolean forwardEventException)
Default is false. Turn this on if you want the DispatcherPortlet
to forward the exception to the render phase, similar to what it does
for action exceptions
by default.
public void setViewRendererUrl(String viewRendererUrl)
public void onRefresh(ApplicationContext context)
initStrategies(org.springframework.context.ApplicationContext)
.onRefresh
in class FrameworkPortlet
context
- the current Portlet ApplicationContextFrameworkPortlet.refresh()
protected void initStrategies(ApplicationContext context)
May be overridden in subclasses in order to initialize further strategy objects.
protected <T> T getDefaultStrategy(ApplicationContext context, Class<T> strategyInterface)
The default implementation delegates to getDefaultStrategies(org.springframework.context.ApplicationContext, java.lang.Class<T>)
,
expecting a single object in the list.
context
- the current Portlet ApplicationContextstrategyInterface
- the strategy interfacegetDefaultStrategies(org.springframework.context.ApplicationContext, java.lang.Class<T>)
protected <T> List<T> getDefaultStrategies(ApplicationContext context, Class<T> strategyInterface)
The default implementation uses the "DispatcherPortlet.properties" file (in the same package as the DispatcherPortlet class) to determine the class names. It instantiates the strategy objects and satisifies ApplicationContextAware if necessary.
context
- the current Portlet ApplicationContextstrategyInterface
- the strategy interfaceprotected Object createDefaultStrategy(ApplicationContext context, Class<?> clazz)
The default implementation uses
AutowireCapableBeanFactory.createBean(java.lang.Class<T>)
.
context
- the current Portlet ApplicationContextclazz
- the strategy implementation class to instantiateApplicationContext.getAutowireCapableBeanFactory()
public PortletMultipartResolver getMultipartResolver()
null
if none (indicating that no multipart support is available)protected void doActionService(ActionRequest request, ActionResponse response) throws Exception
The handler will be obtained by applying the portlet's HandlerMappings in order. The HandlerAdapter will be obtained by querying the portlet's installed HandlerAdapters to find the first that supports the handler class.
doActionService
in class FrameworkPortlet
request
- current portlet action requestresponse
- current portlet Action responseException
- in case of any kind of processing failureGenericPortlet.processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)
protected void doRenderService(RenderRequest request, RenderResponse response) throws Exception
The handler will be obtained by applying the portlet's HandlerMappings in order. The HandlerAdapter will be obtained by querying the portlet's installed HandlerAdapters to find the first that supports the handler class.
doRenderService
in class FrameworkPortlet
request
- current portlet render requestresponse
- current portlet render responseException
- in case of any kind of processing failureGenericPortlet.doDispatch(javax.portlet.RenderRequest, javax.portlet.RenderResponse)
protected void doResourceService(ResourceRequest request, ResourceResponse response) throws Exception
The handler will be obtained by applying the portlet's HandlerMappings in order. The HandlerAdapter will be obtained by querying the portlet's installed HandlerAdapters to find the first that supports the handler class.
doResourceService
in class FrameworkPortlet
request
- current portlet render requestresponse
- current portlet render responseException
- in case of any kind of processing failureGenericPortlet.serveResource(javax.portlet.ResourceRequest, javax.portlet.ResourceResponse)
protected void doEventService(EventRequest request, EventResponse response) throws Exception
The handler will be obtained by applying the portlet's HandlerMappings in order. The HandlerAdapter will be obtained by querying the portlet's installed HandlerAdapters to find the first that supports the handler class.
doEventService
in class FrameworkPortlet
request
- current portlet action requestresponse
- current portlet Action responseException
- in case of any kind of processing failureGenericPortlet.processEvent(javax.portlet.EventRequest, javax.portlet.EventResponse)
protected ActionRequest checkMultipart(ActionRequest request) throws MultipartException
request
- current HTTP requestMultipartException
protected HandlerExecutionChain getHandler(PortletRequest request) throws Exception
request
- current portlet requestException
protected void noHandlerFound(PortletRequest request, PortletResponse response) throws Exception
request
- current portlet requestresponse
- current portlet responseException
- if preparing the response failedprotected HandlerAdapter getHandlerAdapter(Object handler) throws PortletException
handler
- the handler object to find an adapter forPortletException
- if no HandlerAdapter can be found for the handler.
This is a fatal error.protected void exposeActionException(PortletRequest request, StateAwareResponse response, Exception ex)
request
- current portlet requestresponse
- current portlet responseex
- the action exception (may also come from an event phase)protected void render(ModelAndView mv, PortletRequest request, MimeResponse response) throws Exception
mv
- the ModelAndView to renderrequest
- current portlet render requestresponse
- current portlet render responseException
- if there's a problem rendering the viewprotected View resolveViewName(String viewName, Map<String,?> model, PortletRequest request) throws Exception
Default implementations asks all ViewResolvers of this dispatcher. Can be overridden for custom resolution strategies, potentially based on specific model attributes or request parameters.
viewName
- the name of the view to resolvemodel
- the model to be passed to the viewrequest
- current portlet render requestException
- if the view cannot be resolved
(typically in case of problems creating an actual View object)ViewResolver.resolveViewName(java.lang.String, java.util.Locale)
protected void doRender(View view, Map<String,?> model, PortletRequest request, MimeResponse response) throws Exception
The default implementation delegates to
ViewRendererServlet
.
view
- the View to rendermodel
- the associated modelrequest
- current portlet render/resource requestresponse
- current portlet render/resource responseException
- if there's a problem rendering the viewprotected void doDispatch(PortletRequestDispatcher dispatcher, PortletRequest request, MimeResponse response) throws Exception
The default implementation uses a forward for resource requests and an include for render requests.
dispatcher
- the PortletRequestDispatcher to userequest
- current portlet render/resource requestresponse
- current portlet render/resource responseException
- if there's a problem performing the dispatchprotected ModelAndView processHandlerException(RenderRequest request, RenderResponse response, Object handler, Exception ex) throws Exception
request
- current portlet requestresponse
- current portlet responsehandler
- the executed handler, or null if none chosen at the time of
the exception (for example, if multipart resolution failed)ex
- the exception that got thrown during handler executionException
- if no error ModelAndView foundprotected ModelAndView processHandlerException(ResourceRequest request, ResourceResponse response, Object handler, Exception ex) throws Exception
request
- current portlet requestresponse
- current portlet responsehandler
- the executed handler, or null if none chosen at the time of
the exception (for example, if multipart resolution failed)ex
- the exception that got thrown during handler executionException
- if no error ModelAndView found