| org.springframework.web.portlet.GenericPortletBean
 org.springframework.web.portlet.FrameworkPortlet
org.springframework.web.portlet.DispatcherPortlet
| Method Summary | |
| protected LocaleContext | buildLocaleContext(PortletRequest request)
Build a LocaleContext for the given request, exposing the request's
primary locale as current locale. | | 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 | doRenderService(RenderRequest request, RenderResponse response)
Processes the actual dispatching to the handler for render requests. | | protected List | getDefaultStrategies(ApplicationContext context, Class strategyInterface)
Create a List of default strategy objects for the given strategy interface. | | protected Object | getDefaultStrategy(ApplicationContext context, Class strategyInterface)
Return the default strategy object for the given strategy interface. | | protected HandlerExecutionChain | getHandler(PortletRequest request, boolean cache)
Return the HandlerExecutionChain for this request. | | protected HandlerAdapter | getHandlerAdapter(Object handler)
Return the HandlerAdapter for this handler object. | | public 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. | | public void | onRefresh(ApplicationContext context)
This implementation calls
DispatcherPortlet.initStrategies . | | protected ModelAndView | processHandlerException(RenderRequest request, RenderResponse response, Object handler, Exception ex)
Determine an error ModelAndView via the registered HandlerExceptionResolvers. | | protected void | render(ModelAndView mv, RenderRequest request, RenderResponse response)
Render the given ModelAndView. | | protected View | resolveViewName(String viewName, Map model, RenderRequest request)
Resolve the given view name into a View object (to be rendered). | | public void | setDetectAllHandlerAdapters(boolean detectAllHandlerAdapters)
Set whether to detect all HandlerAdapter beans in this portlet's context.
Else, just a single bean with name "handlerAdapter" will be expected.
Default is "true". | | public void | setDetectAllHandlerExceptionResolvers(boolean detectAllHandlerExceptionResolvers)
Set whether to detect all HandlerExceptionResolver beans in this portlet's context.
Else, just a single bean with name "handlerExceptionResolver" will be expected.
Default is true. | | public void | setDetectAllHandlerMappings(boolean detectAllHandlerMappings)
Set whether to detect all HandlerMapping beans in this portlet's context.
Else, just a single bean with name "handlerMapping" will be expected.
Default is true. | | public void | setDetectAllViewResolvers(boolean detectAllViewResolvers)
Set whether to detect all ViewResolver beans in this portlet's context.
Else, just a single bean with name "viewResolver" will be expected.
Default is true. | | public void | setThreadContextInheritable(boolean threadContextInheritable)
Set whether to expose the LocaleContext and RequestAttributes as inheritable
for child threads (using an
java.lang.InheritableThreadLocal ).
Default is "false", to avoid side effects on spawned background threads.
Switch this to "true" to enable inheritance for custom child threads which
are spawned during request processing and only used for this request
(that is, ending after their initial task, without reuse of the thread).
WARNING: Do not use inheritance for child threads if you are
accessing a thread pool which is configured to potentially add new threads
on demand (e.g. | | public void | setViewRendererUrl(String viewRendererUrl)
Set the URL to the ViewRendererServlet. |
| ACTION_EXCEPTION_RENDER_PARAMETER | | final public static String ACTION_EXCEPTION_RENDER_PARAMETER(Code) | | This render parameter is used to indicate forward to the render phase
that an exception occurred during the action phase.
|
| ACTION_EXCEPTION_SESSION_ATTRIBUTE | | final public static String ACTION_EXCEPTION_SESSION_ATTRIBUTE(Code) | | Unlike the Servlet version of this class, we have to deal with the
two-phase nature of the portlet request. To do this, we need to pass
forward any exception that occurs during the action phase, so that
it can be displayed in the render phase. The only direct way to pass
things forward and preserve them for each render request is through
render parameters, but these are limited to String objects and we need
to pass the Exception itself. The only other way to do this is in the
session. The bad thing about using the session is that we have no way
of knowing when we are done re-rendering the request and so we don't
know when we can remove the objects from the session. So we will end
up polluting the session with an old exception when we finally leave
the render phase of one request and move on to something else.
|
| DEFAULT_VIEW_RENDERER_URL | | final public static String DEFAULT_VIEW_RENDERER_URL(Code) | | Default URL to ViewRendererServlet. This bridge servlet is used to convert
portlet render requests to servlet requests in order to leverage the view support
in the org.springframework.web.view package.
|
| HANDLER_EXCEPTION_RESOLVER_BEAN_NAME | | final public static String HANDLER_EXCEPTION_RESOLVER_BEAN_NAME(Code) | | Well-known name for the HandlerExceptionResolver object in the bean factory for this
namespace. Only used when "detectAllHandlerExceptionResolvers" is turned off.
See Also: DispatcherPortlet.setDetectAllViewResolvers |
| HANDLER_EXECUTION_CHAIN_ATTRIBUTE | | final public static String HANDLER_EXECUTION_CHAIN_ATTRIBUTE(Code) | | Request attribute to hold the currently chosen HandlerExecutionChain.
Only used for internal optimizations.
|
| HANDLER_MAPPING_BEAN_NAME | | final public static String HANDLER_MAPPING_BEAN_NAME(Code) | | Well-known name for the HandlerMapping object in the bean factory for this namespace.
Only used when "detectAllHandlerMappings" is turned off.
See Also: DispatcherPortlet.setDetectAllViewResolvers |
| MULTIPART_RESOLVER_BEAN_NAME | | final public static String MULTIPART_RESOLVER_BEAN_NAME(Code) | | Well-known name for the PortletMultipartResolver object in the bean factory for this namespace.
|
| PAGE_NOT_FOUND_LOG_CATEGORY | | final public static String PAGE_NOT_FOUND_LOG_CATEGORY(Code) | | Log category to use when no mapped handler is found for a request.
|
| VIEW_RESOLVER_BEAN_NAME | | final public static String VIEW_RESOLVER_BEAN_NAME(Code) | | Well-known name for the ViewResolver object in the bean factory for this namespace.
|
| pageNotFoundLogger | | final protected static Log pageNotFoundLogger(Code) | | Additional logger to use when no mapped handler is found for a request.
|
| buildLocaleContext | | protected LocaleContext buildLocaleContext(PortletRequest request)(Code) | | Build a LocaleContext for the given request, exposing the request's
primary locale as current locale.
Parameters:
request - current HTTP request the corresponding LocaleContext |
| checkMultipart | | protected ActionRequest checkMultipart(ActionRequest request) throws MultipartException(Code) | | Convert the request into a multipart request, and make multipart resolver available.
If no multipart resolver is set, simply use the existing request.
Parameters:
request - current HTTP request the processed request (multipart wrapper if necessary) |
| doActionService | | protected void doActionService(ActionRequest request, ActionResponse response) throws Exception(Code) | | Processes the actual dispatching to the handler for action requests.
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.
Parameters:
request - current portlet action request
Parameters:
response - current portlet Action response
throws:
Exception - in case of any kind of processing failure |
| doRenderService | | protected void doRenderService(RenderRequest request, RenderResponse response) throws Exception(Code) | | Processes the actual dispatching to the handler for render requests.
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.
Parameters:
request - current portlet render request
Parameters:
response - current portlet render response
throws:
Exception - in case of any kind of processing failure |
| getDefaultStrategies | | protected List getDefaultStrategies(ApplicationContext context, Class strategyInterface) throws BeansException(Code) | | Create a List of default strategy objects for the given strategy interface.
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.
Parameters:
context - the current Portlet ApplicationContext
Parameters:
strategyInterface - the strategy interface the List of corresponding strategy objects
throws:
BeansException - if initialization failed |
| getHandler | | protected HandlerExecutionChain getHandler(PortletRequest request, boolean cache) throws Exception(Code) | | Return the HandlerExecutionChain for this request.
Try all handler mappings in order.
Parameters:
request - current portlet request
Parameters:
cache - whether to cache the HandlerExecutionChain in a request attribute the HandlerExceutionChain, or null if no handler could be found |
| getHandlerAdapter | | protected HandlerAdapter getHandlerAdapter(Object handler) throws PortletException(Code) | | Return the HandlerAdapter for this handler object.
Parameters:
handler - the handler object to find an adapter for
throws:
PortletException - if no HandlerAdapter can be found for the handler.This is a fatal error. |
| getMultipartResolver | | public PortletMultipartResolver getMultipartResolver()(Code) | | Obtain this portlet's PortletMultipartResolver, if any.
the PortletMultipartResolver used by this portlet, or nullif none (indicating that no multipart support is available) |
| initStrategies | | protected void initStrategies(ApplicationContext context)(Code) | | Refresh the strategy objects that this portlet uses.
May be overridden in subclasses in order to initialize
further strategy objects.
|
| noHandlerFound | | protected void noHandlerFound(PortletRequest request, PortletResponse response) throws PortletException(Code) | | No handler found -> throw appropriate exception.
Parameters:
request - current portlet request
Parameters:
response - current portlet response |
| processHandlerException | | protected ModelAndView processHandlerException(RenderRequest request, RenderResponse response, Object handler, Exception ex) throws Exception(Code) | | Determine an error ModelAndView via the registered HandlerExceptionResolvers.
Parameters:
request - current portlet request
Parameters:
response - current portlet response
Parameters:
handler - the executed handler, or null if none chosen at the time ofthe exception (for example, if multipart resolution failed)
Parameters:
ex - the exception that got thrown during handler execution a corresponding ModelAndView to forward to
throws:
Exception - if no error ModelAndView found |
| render | | protected void render(ModelAndView mv, RenderRequest request, RenderResponse response) throws Exception(Code) | | Render the given ModelAndView. This is the last stage in handling a request.
It may involve resolving the view by name.
Parameters:
mv - the ModelAndView to render
Parameters:
request - current portlet render request
Parameters:
response - current portlet render response
throws:
Exception - if there's a problem rendering the view |
| resolveViewName | | protected View resolveViewName(String viewName, Map model, RenderRequest request) throws Exception(Code) | | Resolve the given view name into a View object (to be rendered).
Default implementations asks all ViewResolvers of this dispatcher.
Can be overridden for custom resolution strategies, potentially based
on specific model attributes or request parameters.
Parameters:
viewName - the name of the view to resolve
Parameters:
model - the model to be passed to the view
Parameters:
request - current portlet render request the View object, or null if none found
throws:
Exception - if the view cannot be resolved(typically in case of problems creating an actual View object)
See Also: ViewResolver.resolveViewName |
| setDetectAllHandlerAdapters | | public void setDetectAllHandlerAdapters(boolean detectAllHandlerAdapters)(Code) | | Set whether to detect all HandlerAdapter beans in this portlet's context.
Else, just a single bean with name "handlerAdapter" will be expected.
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.
|
| setDetectAllHandlerExceptionResolvers | | public void setDetectAllHandlerExceptionResolvers(boolean detectAllHandlerExceptionResolvers)(Code) | | Set whether to detect all HandlerExceptionResolver beans in this portlet's context.
Else, just a single bean with name "handlerExceptionResolver" will be expected.
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.
|
| setDetectAllHandlerMappings | | public void setDetectAllHandlerMappings(boolean detectAllHandlerMappings)(Code) | | Set whether to detect all HandlerMapping beans in this portlet's context.
Else, just a single bean with name "handlerMapping" will be expected.
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.
|
| setDetectAllViewResolvers | | public void setDetectAllViewResolvers(boolean detectAllViewResolvers)(Code) | | Set whether to detect all ViewResolver beans in this portlet's context.
Else, just a single bean with name "viewResolver" will be expected.
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.
|
| setThreadContextInheritable | | public void setThreadContextInheritable(boolean threadContextInheritable)(Code) | | Set whether to expose the LocaleContext and RequestAttributes as inheritable
for child threads (using an
java.lang.InheritableThreadLocal ).
Default is "false", to avoid side effects on spawned background threads.
Switch this to "true" to enable inheritance for custom child threads which
are spawned during request processing and only used for this request
(that is, ending after their initial task, without reuse of the thread).
WARNING: Do not use inheritance for child threads if you are
accessing a thread pool which is configured to potentially add new threads
on demand (e.g. a JDK
java.util.concurrent.ThreadPoolExecutor ),
since this will expose the inherited context to such a pooled thread.
|
| setViewRendererUrl | | public void setViewRendererUrl(String viewRendererUrl)(Code) | | Set the URL to the ViewRendererServlet. That servlet is used to
ultimately render all views in the portlet application.
|
| Methods inherited from org.springframework.web.portlet.FrameworkPortlet | protected ApplicationContext createPortletApplicationContext(ApplicationContext parent) throws BeansException(Code)(Java Doc)
public void destroy()(Code)(Java Doc)
abstract protected void doActionService(ActionRequest request, ActionResponse response) throws Exception(Code)(Java Doc)
final protected void doDispatch(RenderRequest request, RenderResponse response) throws PortletException, IOException(Code)(Java Doc)
abstract protected void doRenderService(RenderRequest request, RenderResponse response) throws Exception(Code)(Java Doc)
public Class getContextClass()(Code)(Java Doc)
public String getContextConfigLocation()(Code)(Java Doc)
public String getNamespace()(Code)(Java Doc)
final public ApplicationContext getPortletApplicationContext()(Code)(Java Doc)
public String getPortletContextAttributeName()(Code)(Java Doc)
public String[] getUserinfoUsernameAttributes()(Code)(Java Doc)
protected String getUsernameForRequest(PortletRequest request)(Code)(Java Doc)
protected void initFrameworkPortlet() throws PortletException, BeansException(Code)(Java Doc)
protected ApplicationContext initPortletApplicationContext() throws BeansException(Code)(Java Doc)
final protected void initPortletBean() throws PortletException, BeansException(Code)(Java Doc)
public boolean isPublishContext()(Code)(Java Doc)
public boolean isPublishEvents()(Code)(Java Doc)
public void onApplicationEvent(ApplicationEvent event)(Code)(Java Doc)
protected void onRefresh(ApplicationContext context) throws BeansException(Code)(Java Doc)
protected void postProcessPortletApplicationContext(ConfigurableApplicationContext pac)(Code)(Java Doc)
final public void processAction(ActionRequest request, ActionResponse response) throws PortletException, IOException(Code)(Java Doc)
final protected void processRequest(PortletRequest request, PortletResponse response) throws PortletException, IOException(Code)(Java Doc)
public void refresh() throws BeansException(Code)(Java Doc)
public void setContextClass(Class contextClass)(Code)(Java Doc)
public void setContextConfigLocation(String contextConfigLocation)(Code)(Java Doc)
public void setNamespace(String namespace)(Code)(Java Doc)
public void setPublishContext(boolean publishContext)(Code)(Java Doc)
public void setPublishEvents(boolean publishEvents)(Code)(Java Doc)
public void setUserinfoUsernameAttributes(String[] userinfoUsernameAttributes)(Code)(Java Doc)
|
| Fields inherited from org.springframework.web.portlet.GenericPortletBean | final protected Log logger(Code)(Java Doc)
|
|
|