org.parancoe.web.annotation
Class ParancoeAnnotationMethodHandlerAdapter

java.lang.Object
  org.springframework.context.support.ApplicationObjectSupport
      org.springframework.web.context.support.WebApplicationObjectSupport
          org.springframework.web.servlet.support.WebContentGenerator
              org.parancoe.web.annotation.ParancoeAnnotationMethodHandlerAdapter

All Implemented Interfaces:

org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.HandlerAdapter

public class ParancoeAnnotationMethodHandlerAdapter
extends org.springframework.web.servlet.support.WebContentGenerator
implements org.springframework.web.servlet.HandlerAdapter

Implementation of the HandlerAdapter interface that maps handler methods based on HTTP paths, HTTP methods and request parameters expressed through the RequestMapping annotation.

Supports request parameter binding through the RequestParam annotation. Also supports the ModelAttribute annotation for exposing model attribute values to the view, as well as InitBinder for binder initialization methods and SessionAttributes for automatic session management of specific attributes.

This adapter can be customized through various bean properties. A common use case is to apply shared binder initialization logic through a custom WebBindingInitializer.

Author:

Juergen Hoeller, Arjen Poutsma, Lucio Benfante

See Also:

setPathMatcher(org.springframework.util.PathMatcher), setMethodNameResolver(org.springframework.web.servlet.mvc.multiaction.MethodNameResolver), setWebBindingInitializer(org.springframework.web.bind.support.WebBindingInitializer), setSessionAttributeStore(org.springframework.web.bind.support.SessionAttributeStore)

Field Summary

static java.lang.String	PAGE_NOT_FOUND_LOG_CATEGORY Log category to use when no mapped handler is found for a request.
protected static org.apache.commons.logging.Log	pageNotFoundLogger Additional logger to use when no mapped handler is found for a request.

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

ParancoeAnnotationMethodHandlerAdapter()

Method Summary

protected org.springframework.web.bind.ServletRequestDataBinder	createBinder(javax.servlet.http.HttpServletRequest request, java.lang.Object target, java.lang.String objectName) Template method for creating a new ServletRequestDataBinder instance.
long	getLastModified(javax.servlet.http.HttpServletRequest request, java.lang.Object handler)
org.springframework.web.servlet.ModelAndView	handle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object handler)
protected org.springframework.web.servlet.ModelAndView	handleNoSuchRequestHandlingMethod(org.springframework.web.servlet.mvc.multiaction.NoSuchRequestHandlingMethodException ex, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handle the case where no request handler method was found.
void	setAlwaysUseFullPath(boolean alwaysUseFullPath) Set if URL lookup should always use the full path within the current servlet context.
void	setCustomArgumentResolver(org.springframework.web.bind.support.WebArgumentResolver argumentResolver) Set a custom ArgumentResolvers to use for special method parameter types.
void	setCustomArgumentResolvers(org.springframework.web.bind.support.WebArgumentResolver[] argumentResolvers) Set one or more custom ArgumentResolvers to use for special method parameter types.
void	setMethodNameResolver(org.springframework.web.servlet.mvc.multiaction.MethodNameResolver methodNameResolver) Set the MethodNameResolver to use for resolving default handler methods (carrying an empty @RequestMapping annotation).
void	setParameterNameDiscoverer(org.springframework.core.ParameterNameDiscoverer parameterNameDiscoverer) Set the ParameterNameDiscoverer to use for resolving method parameter names if needed (e.g. for default attribute names).
void	setPathMatcher(org.springframework.util.PathMatcher pathMatcher) Set the PathMatcher implementation to use for matching URL paths against registered URL patterns.
void	setSessionAttributeStore(org.springframework.web.bind.support.SessionAttributeStore sessionAttributeStore) Specify the strategy to store session attributes with.
void	setSynchronizeOnSession(boolean synchronizeOnSession) Set if controller execution should be synchronized on the session, to serialize parallel invocations from the same client.
void	setUrlDecode(boolean urlDecode) Set if context path and request URI should be URL-decoded.
void	setUrlPathHelper(org.springframework.web.util.UrlPathHelper urlPathHelper) Set the UrlPathHelper to use for resolution of lookup paths.
void	setValidator(org.springframework.validation.Validator validator) Set the validator to use on @ModelAttribute parameter of methods annotated with @Validation.
void	setWebBindingInitializer(org.springframework.web.bind.support.WebBindingInitializer webBindingInitializer) Specify a WebBindingInitializer which will apply pre-configured configuration to every DataBinder that this controller uses.
boolean	supports(java.lang.Object handler)

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PAGE_NOT_FOUND_LOG_CATEGORY

public static final java.lang.String PAGE_NOT_FOUND_LOG_CATEGORY

Log category to use when no mapped handler is found for a request.

See Also:

pageNotFoundLogger, Constant Field Values

pageNotFoundLogger

protected static final org.apache.commons.logging.Log pageNotFoundLogger

Additional logger to use when no mapped handler is found for a request.

See Also:

PAGE_NOT_FOUND_LOG_CATEGORY

Constructor Detail

ParancoeAnnotationMethodHandlerAdapter

public ParancoeAnnotationMethodHandlerAdapter()

Method Detail

setAlwaysUseFullPath

public void setAlwaysUseFullPath(boolean alwaysUseFullPath)

Set if URL lookup should always use the full path within the current servlet context. Else, the path within the current servlet mapping is used if applicable (that is, in the case of a ".../*" servlet mapping in web.xml).

Default is "false".

See Also:

UrlPathHelper.setAlwaysUseFullPath(boolean)

setUrlDecode

public void setUrlDecode(boolean urlDecode)

Set if context path and request URI should be URL-decoded. Both are returned undecoded by the Servlet API, in contrast to the servlet path.

Uses either the request encoding or the default encoding according to the Servlet spec (ISO-8859-1).

See Also:

UrlPathHelper.setUrlDecode(boolean)

setUrlPathHelper

public void setUrlPathHelper(org.springframework.web.util.UrlPathHelper urlPathHelper)

Set the UrlPathHelper to use for resolution of lookup paths.

Use this to override the default UrlPathHelper with a custom subclass, or to share common UrlPathHelper settings across multiple HandlerMappings and HandlerAdapters.

setPathMatcher

public void setPathMatcher(org.springframework.util.PathMatcher pathMatcher)

Set the PathMatcher implementation to use for matching URL paths against registered URL patterns. Default is AntPathMatcher.

See Also:

AntPathMatcher

setMethodNameResolver

public void setMethodNameResolver(org.springframework.web.servlet.mvc.multiaction.MethodNameResolver methodNameResolver)

Set the MethodNameResolver to use for resolving default handler methods (carrying an empty @RequestMapping annotation).

Will only kick in when the handler method cannot be resolved uniquely through the annotation metadata already.

setWebBindingInitializer

public void setWebBindingInitializer(org.springframework.web.bind.support.WebBindingInitializer webBindingInitializer)

Specify a WebBindingInitializer which will apply pre-configured configuration to every DataBinder that this controller uses.

setSessionAttributeStore

public void setSessionAttributeStore(org.springframework.web.bind.support.SessionAttributeStore sessionAttributeStore)

Specify the strategy to store session attributes with.

Default is DefaultSessionAttributeStore, storing session attributes in the HttpSession, using the same attribute name as in the model.

setSynchronizeOnSession

public void setSynchronizeOnSession(boolean synchronizeOnSession)

Set if controller execution should be synchronized on the session, to serialize parallel invocations from the same client.

More specifically, the execution of each handler method will get synchronized if this flag is "true". The best available session mutex will be used for the synchronization; ideally, this will be a mutex exposed by HttpSessionMutexListener.

The session mutex is guaranteed to be the same object during the entire lifetime of the session, available under the key defined by the SESSION_MUTEX_ATTRIBUTE constant. It serves as a safe reference to synchronize on for locking on the current session.

In many cases, the HttpSession reference itself is a safe mutex as well, since it will always be the same object reference for the same active logical session. However, this is not guaranteed across different servlet containers; the only 100% safe way is a session mutex.

See Also:

HttpSessionMutexListener, WebUtils.getSessionMutex(javax.servlet.http.HttpSession)

setParameterNameDiscoverer

public void setParameterNameDiscoverer(org.springframework.core.ParameterNameDiscoverer parameterNameDiscoverer)

Set the ParameterNameDiscoverer to use for resolving method parameter names if needed (e.g. for default attribute names).

Default is a LocalVariableTableParameterNameDiscoverer.

setCustomArgumentResolver

public void setCustomArgumentResolver(org.springframework.web.bind.support.WebArgumentResolver argumentResolver)

Set a custom ArgumentResolvers to use for special method parameter types. Such a custom ArgumentResolver will kick in first, having a chance to resolve an argument value before the standard argument handling kicks in.

setCustomArgumentResolvers

public void setCustomArgumentResolvers(org.springframework.web.bind.support.WebArgumentResolver[] argumentResolvers)

Set one or more custom ArgumentResolvers to use for special method parameter types. Any such custom ArgumentResolver will kick in first, having a chance to resolve an argument value before the standard argument handling kicks in.

setValidator

public void setValidator(org.springframework.validation.Validator validator)

Set the validator to use on @ModelAttribute parameter of methods annotated with @Validation.

Parameters:

validator -

supports

public boolean supports(java.lang.Object handler)

Specified by:

supports in interface org.springframework.web.servlet.HandlerAdapter

handle

public org.springframework.web.servlet.ModelAndView handle(javax.servlet.http.HttpServletRequest request,
                                                           javax.servlet.http.HttpServletResponse response,
                                                           java.lang.Object handler)
                                                    throws java.lang.Exception

Specified by:

handle in interface org.springframework.web.servlet.HandlerAdapter

Throws:

java.lang.Exception

getLastModified

public long getLastModified(javax.servlet.http.HttpServletRequest request,
                            java.lang.Object handler)

Specified by:

getLastModified in interface org.springframework.web.servlet.HandlerAdapter

handleNoSuchRequestHandlingMethod

protected org.springframework.web.servlet.ModelAndView handleNoSuchRequestHandlingMethod(org.springframework.web.servlet.mvc.multiaction.NoSuchRequestHandlingMethodException ex,
                                                                                         javax.servlet.http.HttpServletRequest request,
                                                                                         javax.servlet.http.HttpServletResponse response)
                                                                                  throws java.lang.Exception

Handle the case where no request handler method was found.

The default implementation logs a warning and sends an HTTP 404 error. Alternatively, a fallback view could be chosen, or the NoSuchRequestHandlingMethodException could be rethrown as-is.

Parameters:

ex - the NoSuchRequestHandlingMethodException to be handled

request - current HTTP request

response - current HTTP response

Returns:

a ModelAndView to render, or null if handled directly

Throws:

java.lang.Exception - an Exception that should be thrown as result of the servlet request

createBinder

protected org.springframework.web.bind.ServletRequestDataBinder createBinder(javax.servlet.http.HttpServletRequest request,
                                                                             java.lang.Object target,
                                                                             java.lang.String objectName)
                                                                      throws java.lang.Exception

Template method for creating a new ServletRequestDataBinder instance.

The default implementation creates a standard ServletRequestDataBinder. This can be overridden for custom ServletRequestDataBinder subclasses.

Parameters:

request - current HTTP request

target - the target object to bind onto (or null if the binder is just used to convert a plain parameter value)

objectName - the objectName of the target object

Returns:

the ServletRequestDataBinder instance to use

Throws:

java.lang.Exception - in case of invalid state or arguments

See Also:

ServletRequestDataBinder.bind(javax.servlet.ServletRequest), DataBinder.convertIfNecessary(Object, Class, MethodParameter)