SpringMvcTinyProcessor (tiny-码云(gitee.com))

java.lang.Object
- org.tinygroup.weblayer.AbstractTinyProcessor
- - org.tinygroup.springmvc.tinyprocessor.SpringMvcTinyProcessor

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, Ordered, TinyProcessor
```
public class SpringMvcTinyProcessor
extends AbstractTinyProcessor
implements org.springframework.context.ApplicationContextAware
```
tiny框架方式的springmvc

Author:

renhui

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`LOCALE_RESOLVER_ATTRIBUTE` Request attribute to hold the current LocaleResolver, retrievable by views.
`static String`	`REQUEST_URI`
`static String`	`THEME_RESOLVER_ATTRIBUTE` Request attribute to hold the current ThemeResolver, retrievable by views.
`static String`	`THEME_SOURCE_ATTRIBUTE` Request attribute to hold the current ThemeSource, retrievable by views.
`static String`	`WEB_APPLICATION_CONTEXT_ATTRIBUTE` Request attribute to hold the current web application context.

Fields inherited from class org.tinygroup.weblayer.AbstractTinyProcessor
logger, processorName, tinyProcessorConfig

Fields inherited from interface org.tinygroup.weblayer.TinyProcessor
TINY_PROCESSOR

Fields inherited from interface org.tinygroup.commons.order.Ordered
DEFAULT_PRECEDENCE, HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors
Constructor and Description

SpringMvcTinyProcessor()

Constructors
Constructor and Description
`SpringMvcTinyProcessor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected org.springframework.context.i18n.LocaleContext`	`buildLocaleContext(javax.servlet.http.HttpServletRequest request)` Build a LocaleContext
`protected javax.servlet.http.HttpServletRequest`	`checkMultipart(javax.servlet.http.HttpServletRequest request)` Return the HandlerExecutionChain for this request.
`protected void`	`cleanupMultipart(javax.servlet.http.HttpServletRequest request)` Clean up any resources used by the given multipart request (if any).
`protected org.springframework.web.context.WebApplicationContext`	`createWebApplicationContext(org.springframework.context.ApplicationContext parent)`
`protected void`	`customInit()`
`void`	`destroy()` 处理器的销毁方法
`String`	`getContextAttribute()`
`String`	`getContextConfigLocation()`
`protected String`	`getDefaultViewName(javax.servlet.http.HttpServletRequest request)` Translate the supplied request into a default view name.
`protected org.springframework.web.servlet.HandlerExecutionChain`	`getHandler(javax.servlet.http.HttpServletRequest request)`
`protected org.springframework.web.servlet.HandlerAdapter`	`getHandlerAdapter(Object handler)` Return the HandlerAdapter for this handler object.
`int`	`getOrder()` Return the order value of this object, with a higher value meaning greater in terms of sorting.
`protected javax.servlet.ServletContext`	`getServletContext()`
`org.springframework.ui.context.ThemeSource`	`getThemeSource()`
`protected String`	`getUsernameForRequest(javax.servlet.http.HttpServletRequest request)` Determine the username for the given request.
`protected org.springframework.web.context.WebApplicationContext`	`initWebApplicationContext()` Initialize and publish the WebApplicationContext for this servlet.
`protected void`	`noHandlerFound(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` No handler found -> set appropriate HTTP response status.
`void`	`onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)` Callback that receives refresh events from this servlet's WebApplicationContext.
`protected void`	`onRefresh(org.springframework.context.ApplicationContext context)`
`protected void`	`postProcessWebApplicationContext(org.springframework.web.context.ConfigurableWebApplicationContext wac)`
`protected org.springframework.web.servlet.ModelAndView`	`processHandlerException(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler, Exception ex)` Determine an error ModelAndView via the registered HandlerExceptionResolvers.
`void`	`reallyProcess(String urlString, WebContext context)` tinyprocessor的逻辑处理方法，由子类来完成
`protected void`	`render(org.springframework.web.servlet.ModelAndView mv, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Render the given ModelAndView.
`protected org.springframework.web.servlet.View`	`resolveViewName(String viewName, Map<String,Object> model, Locale locale, javax.servlet.http.HttpServletRequest request)` Resolve the given view name into a View object (to be rendered).
`void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)`
`void`	`setCleanupAfterInclude(boolean cleanupAfterInclude)`
`void`	`setContextAttribute(String contextAttribute)`
`void`	`setContextConfigLocation(String contextConfigLocation)`
`void`	`setExtensionMappingInstanceResolver(ExtensionMappingInstanceResolver extensionMappingInstanceResolver)`
`void`	`setPublishContext(boolean publishContext)`
`void`	`setPublishEvents(boolean publishEvents)`
`void`	`setSpringMVCAdapter(SpringMVCAdapter springMVCAdapter)`

Methods inherited from class org.tinygroup.weblayer.AbstractTinyProcessor
get, getInitParamMap, getProcessorName, init, isMatch, process, setProcessorName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - WEB_APPLICATION_CONTEXT_ATTRIBUTE
```
public static final String WEB_APPLICATION_CONTEXT_ATTRIBUTE
```
    Request attribute to hold the current web application context. Otherwise only the global web app context is obtainable by tags etc.
    
    See Also:
    
    RequestContextUtils.getWebApplicationContext(javax.servlet.ServletRequest)
  - LOCALE_RESOLVER_ATTRIBUTE
```
public static final String LOCALE_RESOLVER_ATTRIBUTE
```
    Request attribute to hold the current LocaleResolver, retrievable by views.
    
    See Also:
    
    RequestContextUtils.getLocaleResolver(javax.servlet.http.HttpServletRequest)
  - THEME_RESOLVER_ATTRIBUTE
```
public static final String THEME_RESOLVER_ATTRIBUTE
```
    Request attribute to hold the current ThemeResolver, retrievable by views.
    
    See Also:
    
    RequestContextUtils.getThemeResolver(javax.servlet.http.HttpServletRequest)
  - THEME_SOURCE_ATTRIBUTE
```
public static final String THEME_SOURCE_ATTRIBUTE
```
    Request attribute to hold the current ThemeSource, retrievable by views.
    
    See Also:
    
    RequestContextUtils.getThemeSource(javax.servlet.http.HttpServletRequest)
  - REQUEST_URI
```
public static final String REQUEST_URI
```
- Constructor Detail
  - SpringMvcTinyProcessor
```
public SpringMvcTinyProcessor()
```
- Method Detail
  - setExtensionMappingInstanceResolver
```
public void setExtensionMappingInstanceResolver(ExtensionMappingInstanceResolver extensionMappingInstanceResolver)
```
  - setCleanupAfterInclude
```
public void setCleanupAfterInclude(boolean cleanupAfterInclude)
```
  - setSpringMVCAdapter
```
public void setSpringMVCAdapter(SpringMVCAdapter springMVCAdapter)
```
  - getContextAttribute
```
public String getContextAttribute()
```
  - setContextAttribute
```
public void setContextAttribute(String contextAttribute)
```
  - getContextConfigLocation
```
public String getContextConfigLocation()
```
  - setContextConfigLocation
```
public void setContextConfigLocation(String contextConfigLocation)
```
  - setPublishEvents
```
public void setPublishEvents(boolean publishEvents)
```
  - setPublishContext
```
public void setPublishContext(boolean publishContext)
```
  - reallyProcess
```
public void reallyProcess(String urlString,
                          WebContext context)
                   throws javax.servlet.ServletException,
                          IOException
```
    Description copied from class: AbstractTinyProcessor
    
    tinyprocessor的逻辑处理方法，由子类来完成
    
    Specified by:
    
    reallyProcess in class AbstractTinyProcessor
    
    Throws:
    
    javax.servlet.ServletException
    
    IOException
  - getThemeSource
```
public final org.springframework.ui.context.ThemeSource getThemeSource()
```
  - checkMultipart
```
protected javax.servlet.http.HttpServletRequest checkMultipart(javax.servlet.http.HttpServletRequest request)
                                                        throws Exception
```
    Return the HandlerExecutionChain for this request.
    Tries all handler mappings in order.
    
    Parameters:
    
    request - current HTTP request
    
    Returns:
    
    the HandlerExecutionChain, or null if no handler could be found
    
    Throws:
    
    Exception
  - cleanupMultipart
```
protected void cleanupMultipart(javax.servlet.http.HttpServletRequest request)
```
    Clean up any resources used by the given multipart request (if any).
    
    Parameters:
    
    request - current HTTP request
    
    See Also:
    
    MultipartResolver.cleanupMultipart(org.springframework.web.multipart.MultipartHttpServletRequest)
  - noHandlerFound
```
protected void noHandlerFound(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws Exception
```
    No handler found -> set appropriate HTTP response status.
    
    Parameters:
    
    request - current HTTP request
    
    response - current HTTP response
    
    Throws:
    
    Exception - if preparing the response failed
  - getHandlerAdapter
```
protected org.springframework.web.servlet.HandlerAdapter getHandlerAdapter(Object handler)
                                                                    throws javax.servlet.ServletException
```
    Return the HandlerAdapter for this handler object.
    
    Parameters:
    
    handler - the handler object to find an adapter for
    
    Throws:
    
    javax.servlet.ServletException - if no HandlerAdapter can be found for the handler. This is a fatal error.
  - getHandler
```
protected org.springframework.web.servlet.HandlerExecutionChain getHandler(javax.servlet.http.HttpServletRequest request)
                                                                    throws Exception
```
    Throws:
    
    Exception
  - getDefaultViewName
```
protected String getDefaultViewName(javax.servlet.http.HttpServletRequest request)
                             throws Exception
```
    Translate the supplied request into a default view name.
    
    Parameters:
    
    request - current HTTP servlet request
    
    Returns:
    
    the view name (or null if no default found)
    
    Throws:
    
    Exception - if view name translation failed
  - processHandlerException
```
protected org.springframework.web.servlet.ModelAndView processHandlerException(javax.servlet.http.HttpServletRequest request,
                                                                               javax.servlet.http.HttpServletResponse response,
                                                                               Object handler,
                                                                               Exception ex)
                                                                        throws Exception
```
    Determine an error ModelAndView via the registered HandlerExceptionResolvers.
    
    Parameters:
    
    request - current HTTP request
    
    response - current HTTP response
    
    handler - 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 execution
    
    Returns:
    
    a corresponding ModelAndView to forward to
    
    Throws:
    
    Exception - if no error ModelAndView found
  - render
```
protected void render(org.springframework.web.servlet.ModelAndView mv,
                      javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws Exception
```
    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
    
    request - current HTTP servlet request
    
    response - current HTTP servlet response
    
    Throws:
    
    javax.servlet.ServletException - if view is missing or cannot be resolved
    
    Exception - if there's a problem rendering the view
  - resolveViewName
```
protected org.springframework.web.servlet.View resolveViewName(String viewName,
                                                               Map<String,Object> model,
                                                               Locale locale,
                                                               javax.servlet.http.HttpServletRequest request)
                                                        throws Exception
```
    Resolve the given view name into a View object (to be rendered).
    The 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
    
    model - the model to be passed to the view
    
    locale - the current locale
    
    request - current HTTP servlet request
    
    Returns:
    
    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(java.lang.String, java.util.Locale)
  - buildLocaleContext
```
protected org.springframework.context.i18n.LocaleContext buildLocaleContext(javax.servlet.http.HttpServletRequest request)
```
    Build a LocaleContext
    
    Parameters:
    
    request - current HTTP request
    
    Returns:
    
    the corresponding LocaleContext
  - getUsernameForRequest
```
protected String getUsernameForRequest(javax.servlet.http.HttpServletRequest request)
```
    Determine the username for the given request.
    The default implementation takes the name of the UserPrincipal, if any. Can be overridden in subclasses.
    
    Parameters:
    
    request - current HTTP request
    
    Returns:
    
    the username, or null if none found
    
    See Also:
    
    HttpServletRequest.getUserPrincipal()
  - customInit
```
protected void customInit()
                   throws javax.servlet.ServletException
```
    Specified by:
    
    customInit in class AbstractTinyProcessor
    
    Throws:
    
    javax.servlet.ServletException
  - initWebApplicationContext
```
protected org.springframework.web.context.WebApplicationContext initWebApplicationContext()
```
    Initialize and publish the WebApplicationContext for this servlet.
    Delegates to createWebApplicationContext(org.springframework.context.ApplicationContext) for actual creation of the context. Can be overridden in subclasses.
    
    Returns:
    
    the WebApplicationContext instance
    
    See Also:
    
    #setContextClass, setContextConfigLocation(java.lang.String)
  - getServletContext
```
protected javax.servlet.ServletContext getServletContext()
```
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException
```
    Specified by:
    
    setApplicationContext in interface org.springframework.context.ApplicationContextAware
    
    Throws:
    
    org.springframework.beans.BeansException
  - createWebApplicationContext
```
protected org.springframework.web.context.WebApplicationContext createWebApplicationContext(org.springframework.context.ApplicationContext parent)
```
  - postProcessWebApplicationContext
```
protected void postProcessWebApplicationContext(org.springframework.web.context.ConfigurableWebApplicationContext wac)
```
  - onApplicationEvent
```
public void onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)
```
    Callback that receives refresh events from this servlet's WebApplicationContext.
    The default implementation calls onRefresh(org.springframework.context.ApplicationContext), triggering a refresh of this servlet's context-dependent state.
    
    Parameters:
    
    event - the incoming ApplicationContext event
  - onRefresh
```
protected void onRefresh(org.springframework.context.ApplicationContext context)
```
  - destroy
```
public void destroy()
```
    Description copied from interface: TinyProcessor
    
    处理器的销毁方法
    
    Specified by:
    
    destroy in interface TinyProcessor
    
    Overrides:
    
    destroy in class AbstractTinyProcessor
  - getOrder
```
public int getOrder()
```
    Description copied from interface: Ordered
    
    Return the order value of this object, with a higher value meaning greater in terms of sorting.
    Normally starting with 0 or 1, with Ordered.LOWEST_PRECEDENCE indicating greatest. Same order values will result in arbitrary positions for the affected objects.
    Higher value can be interpreted as lower priority, consequently the first object has highest priority (somewhat analogous to Servlet "load-on-startup" values).
    Note that order values below 0 are reserved for framework purposes. Application-specified values should always be 0 or greater, with only framework components (internal or third-party) supposed to use lower values.
    
    Specified by:
    
    getOrder in interface Ordered
    
    Overrides:
    
    getOrder in class AbstractTinyProcessor
    
    Returns:
    
    the order value
    
    See Also:
    
    Ordered.LOWEST_PRECEDENCE

Class SpringMvcTinyProcessor

Field Summary

Fields inherited from class org.tinygroup.weblayer.AbstractTinyProcessor

Fields inherited from interface org.tinygroup.weblayer.TinyProcessor

Fields inherited from interface org.tinygroup.commons.order.Ordered

Constructor Summary

Method Summary

Methods inherited from class org.tinygroup.weblayer.AbstractTinyProcessor

Methods inherited from class java.lang.Object

Field Detail

WEB_APPLICATION_CONTEXT_ATTRIBUTE

LOCALE_RESOLVER_ATTRIBUTE

THEME_RESOLVER_ATTRIBUTE

THEME_SOURCE_ATTRIBUTE

REQUEST_URI

Constructor Detail

SpringMvcTinyProcessor

Method Detail

setExtensionMappingInstanceResolver

setCleanupAfterInclude

setSpringMVCAdapter

getContextAttribute

setContextAttribute

getContextConfigLocation

setContextConfigLocation

setPublishEvents

setPublishContext

reallyProcess

getThemeSource

checkMultipart

cleanupMultipart

noHandlerFound

getHandlerAdapter

getHandler

getDefaultViewName

processHandlerException

render

resolveViewName

buildLocaleContext

getUsernameForRequest

customInit

initWebApplicationContext

getServletContext

setApplicationContext

createWebApplicationContext

postProcessWebApplicationContext

onApplicationEvent

onRefresh

destroy

getOrder