View Javadoc
1   /**
2    * This file Copyright (c) 2010-2015 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.blossom.web;
35  
36  import javax.jcr.Node;
37  
38  import org.springframework.core.MethodParameter;
39  import org.springframework.web.bind.support.WebArgumentResolver;
40  import org.springframework.web.context.request.NativeWebRequest;
41  
42  import info.magnolia.cms.core.AggregationState;
43  import info.magnolia.cms.core.Content;
44  import info.magnolia.cms.security.MgnlUser;
45  import info.magnolia.cms.security.User;
46  import info.magnolia.context.Context;
47  import info.magnolia.context.MgnlContext;
48  import info.magnolia.context.WebContext;
49  import info.magnolia.module.blossom.template.BlossomAreaDefinition;
50  import info.magnolia.module.blossom.template.BlossomTemplateDefinition;
51  import info.magnolia.objectfactory.Components;
52  import info.magnolia.rendering.context.RenderingContext;
53  import info.magnolia.rendering.template.AreaDefinition;
54  import info.magnolia.rendering.template.TemplateDefinition;
55  
56  /**
57   * Enables use of {@link Node}, {@link info.magnolia.cms.core.Content}, {@link info.magnolia.cms.core.AggregationState},
58   * {@link info.magnolia.context.WebContext} and {@link info.magnolia.context.Context} as arguments in methods
59   * annotated with @RequestMapping.
60   * <p/>
61   * To use it configure it on your {@link org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter}.
62   *
63   * @since 1.2
64   */
65  public class BlossomWebArgumentResolver implements WebArgumentResolver {
66  
67      @Override
68      public Object resolveArgument(MethodParameter methodParameter, NativeWebRequest webRequest) throws Exception {
69  
70          if (methodParameter.getParameterType().isAssignableFrom(Node.class)) {
71              RenderingContext renderingContext = Components.getComponent(RenderingContext.class);
72              if (hasSubsequentParametersOfType(methodParameter, Node.class)) {
73                  return renderingContext.getMainContent();
74              }
75              Node currentContent = renderingContext.getCurrentContent();
76              return currentContent != null ? currentContent : renderingContext.getMainContent();
77          }
78          if (methodParameter.getParameterType().isAssignableFrom(Content.class)) {
79              AggregationState aggregationState = MgnlContext.getAggregationState();
80              if (hasSubsequentParametersOfType(methodParameter, Content.class)) {
81                  return aggregationState.getMainContent();
82              }
83              Content currentContent = aggregationState.getCurrentContent();
84              return currentContent != null ? currentContent : aggregationState.getMainContent();
85          }
86          if (methodParameter.getParameterType().isAssignableFrom(TemplateDefinition.class)) {
87              return Components.getComponent(RenderingContext.class).getRenderableDefinition();
88          }
89          if (methodParameter.getParameterType().isAssignableFrom(BlossomTemplateDefinition.class)) {
90              return Components.getComponent(RenderingContext.class).getRenderableDefinition();
91          }
92          if (methodParameter.getParameterType().isAssignableFrom(AreaDefinition.class)) {
93              return Components.getComponent(RenderingContext.class).getRenderableDefinition();
94          }
95          if (methodParameter.getParameterType().isAssignableFrom(BlossomAreaDefinition.class)) {
96              return Components.getComponent(RenderingContext.class).getRenderableDefinition();
97          }
98          if (methodParameter.getParameterType().isAssignableFrom(AggregationState.class)) {
99              return MgnlContext.getAggregationState();
100         }
101         if (methodParameter.getParameterType().isAssignableFrom(WebContext.class)) {
102             return MgnlContext.getWebContext();
103         }
104         if (methodParameter.getParameterType().isAssignableFrom(Context.class)) {
105             return MgnlContext.getInstance();
106         }
107         if (methodParameter.getParameterType().isAssignableFrom(User.class)) {
108             return MgnlContext.getUser();
109         }
110         if (methodParameter.getParameterType().isAssignableFrom(MgnlUser.class)) {
111             return MgnlContext.getUser();
112         }
113 
114         return UNRESOLVED;
115     }
116 
117     private boolean hasSubsequentParametersOfType(MethodParameter methodParameter, Class<?> clazz) {
118         Class<?>[] parameterTypes = methodParameter.getMethod().getParameterTypes();
119         for (int i = methodParameter.getParameterIndex() + 1; i < parameterTypes.length; i++) {
120             Class<?> parameterType = parameterTypes[i];
121             if (parameterType.equals(clazz)) {
122                 return true;
123             }
124         }
125         return false;
126     }
127 }