Skip to content

Commit

Permalink
Added new resolver for DatatablesCriterias compatible with Spring 3.1+
Browse files Browse the repository at this point in the history
Fixed dandelion/issues#150
  • Loading branch information
tduchateau committed Jul 26, 2013
1 parent 6651119 commit 8f53af4
Show file tree
Hide file tree
Showing 2 changed files with 133 additions and 8 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
/*
* [The "BSD licence"]
* Copyright (c) 2012 Dandelion
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of Dandelion nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.github.dandelion.datatables.extras.spring3.ajax;

import javax.servlet.http.HttpServletRequest;

import org.springframework.core.MethodParameter;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;

import com.github.dandelion.datatables.core.ajax.DatatablesCriterias;

/**
* <p>
* Resolves a method argument of type {@code DatatablesCriterias} annotated with
* {@code DatatablesParams}.
*
* <p>
* Datatable attributes are obtained from the {@code HttpServletRequest}, and
* mapped to the annotated {@code DatatablesCriterias} object.
*
* This HandlerMethodArgumentResolver can be enabled in Spring 3.1 and greater
* using either Java or XML configuration as shown below:
*
* <pre>
* &lt;mvc:annotation-driven&gt;
* &lt;mvc:argument-resolvers&gt;
* &lt;bean class="com.github.dandelion.datatables.extras.spring3.ajax.DatatablesCriteriasMethodArgumentResolver" /&gt;
* &lt;/mvc:argument-resolvers&gt;
* &lt;/mvc:annotation-driven&gt;
* </pre>
*
* <pre>
* &#064;Configuration
* &#064;EnableWebMvc
* public class MyWebConfig extends WebMvcConfigurerAdapter {
* &#064;Override
* public void addArgumentResolvers(List&lt;HandlerMethodArgumentResolver&gt; argumentResolvers) {
* argumentResolvers.add(new DatatablesCriteriasMethodArgumentResolver());
* }
* }
* </pre>
*
* @see DatatablesParams
* @see DatatablesCriterias
*
* @author Thibault Duchateau
* @since 0.9.0
*/
public class DatatablesCriteriasMethodArgumentResolver implements HandlerMethodArgumentResolver {

@Override
public boolean supportsParameter(MethodParameter parameter) {
DatatablesParams parameterAnnotation = parameter.getParameterAnnotation(DatatablesParams.class);
if (parameterAnnotation != null) {
if (DatatablesCriterias.class.isAssignableFrom(parameter.getParameterType())) {
return true;
}
}
return false;
}

@Override
public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
return DatatablesCriterias.getFromRequest(request);

}

}
Original file line number Diff line number Diff line change
Expand Up @@ -39,21 +39,46 @@

/**
* <p>
* Spring bean that resolves the @DatatablesParams custom arguments in Spring
* MVC controllers.
* Resolves a method argument of type {@code DatatablesCriterias} annotated with
* {@code DatatablesParams}.
*
* <p>
* The bean directly map the request parameters sent by DataTables when
* server-side processing is enabled into a {@link DatatablesCriterias} bean.
* Datatable attributes are obtained from the {@code HttpServletRequest}, and
* mapped to the annotated {@code DatatablesCriterias} object.
*
* This HandlerMethodArgumentResolver can be enabled in Spring 3.1 and greater

This comment has been minimized.

Copy link
@gorder

gorder Jul 28, 2013

This WebArgumentResolver can be enabled in Spring 3.0 and earlier using XML configuration as shown below. Note for versions of Spring 3.1 and greater the {@link DatatablesCriteriasMethodArgumentResolver} should be used instead.

* using either Java or XML configuration as shown below:
*
* <pre>
* &lt;mvc:annotation-driven&gt;
* &lt;mvc:argument-resolvers&gt;
* &lt;bean class="com.github.dandelion.datatables.extras.spring3.ajax.DatatablesCriteriasResolver" /&gt;
* &lt;/mvc:argument-resolvers&gt;
* &lt;/mvc:annotation-driven&gt;
* </pre>
*
* <pre>

This comment has been minimized.

Copy link
@gorder

gorder Jul 28, 2013

Remove the Java Config. @EnableWebMvc was added in Spring 3.1 and requires the use of the DatatablesCriteriasMethodArgumentResolver the WebArgumentResolver wont work (at least not without the use of their adapter, which people should prefer not to use)

* &#064;Configuration
* &#064;EnableWebMvc
* public class MyWebConfig extends WebMvcConfigurerAdapter {
* &#064;Override
* public void addArgumentResolvers(List&lt;WebArgumentResolver&gt; argumentResolvers) {
* argumentResolvers.add(new DatatablesCriteriasResolver());
* }
* }
* </pre>
*
* @see DatatablesParams
* @see DatatablesCriterias
*
* @author Thibault Duchateau
* @since 0.8.2
* @deprecated Please use the {@link DatatablesCriteriasMethodArgumentResolver} instead, which is compatible

This comment has been minimized.

Copy link
@gorder

gorder Jul 28, 2013

@deprecated in favor of the {@link DatatablesCriteriasMethodArgumentResolver} for versions of Spring 3.1 and greater.

*/
public class DatatablesCriteriasResolver implements WebArgumentResolver {

public Object resolveArgument(MethodParameter methodParam, NativeWebRequest nativeWebRequest)
throws Exception {
DatatablesParams parameterAnnotation = methodParam
.getParameterAnnotation(DatatablesParams.class);
public Object resolveArgument(MethodParameter methodParam, NativeWebRequest nativeWebRequest) throws Exception {
DatatablesParams parameterAnnotation = methodParam.getParameterAnnotation(DatatablesParams.class);

if (parameterAnnotation != null) {
HttpServletRequest request = (HttpServletRequest) nativeWebRequest.getNativeRequest();
Expand Down

0 comments on commit 8f53af4

Please sign in to comment.