Clover icon

magnolia-module-blossom 3.1.3

  1. Project Clover database Fri Apr 29 2016 13:24:33 CEST
  2. Package info.magnolia.module.blossom.web

File BlossomHandlerMethodArgumentResolver.java

 

Coverage histogram

../../../../../img/srcFileCovDistChart9.png
31% of files have more coverage

Code metrics

48
68
5
1
200
143
29
0.43
13.6
5
5.8
3.2% of code in this file is excluded from these metrics.

Classes

Class Line # Actions
BlossomHandlerMethodArgumentResolver 75 68 3.2% 29 16
0.867768686.8%
 

Contributing tests

This file is covered by 17 tests. .

Source view

1    /**
2    * This file Copyright (c) 2010-2016 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 info.magnolia.cms.core.AggregationState;
37    import info.magnolia.cms.core.Channel;
38    import info.magnolia.cms.core.Content;
39    import info.magnolia.cms.security.MgnlUser;
40    import info.magnolia.cms.security.User;
41    import info.magnolia.context.Context;
42    import info.magnolia.context.MgnlContext;
43    import info.magnolia.context.WebContext;
44    import info.magnolia.module.blossom.template.BlossomAreaDefinition;
45    import info.magnolia.module.blossom.template.BlossomTemplateDefinition;
46    import info.magnolia.module.site.Site;
47    import info.magnolia.module.site.SiteManager;
48    import info.magnolia.module.site.functions.SiteFunctions;
49    import info.magnolia.module.site.theme.Theme;
50    import info.magnolia.objectfactory.Components;
51    import info.magnolia.rendering.context.RenderingContext;
52    import info.magnolia.rendering.template.AreaDefinition;
53    import info.magnolia.rendering.template.TemplateDefinition;
54   
55    import java.util.HashSet;
56    import java.util.Set;
57   
58    import javax.jcr.Node;
59   
60    import org.springframework.beans.factory.InitializingBean;
61    import org.springframework.core.MethodParameter;
62    import org.springframework.web.bind.support.WebDataBinderFactory;
63    import org.springframework.web.context.request.NativeWebRequest;
64    import org.springframework.web.method.support.HandlerMethodArgumentResolver;
65    import org.springframework.web.method.support.ModelAndViewContainer;
66   
67    /**
68    * Resolves parameters for a number of Magnolia objects including {@link Node}, {@link info.magnolia.cms.core.Content},
69    * {@link info.magnolia.cms.core.AggregationState}, {@link info.magnolia.context.WebContext} and {@link info.magnolia.context.Context}.
70    * <p/>
71    * To use it configure it on your {@link org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter}.
72    *
73    * @since 3.0.2
74    */
 
75    public class BlossomHandlerMethodArgumentResolver implements HandlerMethodArgumentResolver, InitializingBean {
76   
77    private SiteManager siteManager;
78    private SiteFunctions siteFunctions;
79   
 
80    toggle public void setSiteManager(SiteManager siteManager) {
81    this.siteManager = siteManager;
82    }
83   
 
84    toggle public void setSiteFunctions(SiteFunctions siteFunctions) {
85    this.siteFunctions = siteFunctions;
86    }
87   
88    private Set<Class<?>> supportedParameterTypes = new HashSet<Class<?>>();
89   
 
90  17 toggle public BlossomHandlerMethodArgumentResolver() {
91  17 supportedParameterTypes.add(Node.class);
92  17 supportedParameterTypes.add(Content.class);
93  17 supportedParameterTypes.add(TemplateDefinition.class);
94  17 supportedParameterTypes.add(BlossomTemplateDefinition.class);
95  17 supportedParameterTypes.add(AreaDefinition.class);
96  17 supportedParameterTypes.add(BlossomAreaDefinition.class);
97  17 supportedParameterTypes.add(AggregationState.class);
98  17 supportedParameterTypes.add(WebContext.class);
99  17 supportedParameterTypes.add(Context.class);
100  17 supportedParameterTypes.add(User.class);
101  17 supportedParameterTypes.add(MgnlUser.class);
102  17 supportedParameterTypes.add(Channel.class);
103  17 supportedParameterTypes.add(Site.class);
104  17 supportedParameterTypes.add(Theme.class);
105    }
106   
 
107  22 toggle @Override
108    public boolean supportsParameter(MethodParameter parameter) {
109  22 for (Class<?> supportedParameterType : supportedParameterTypes) {
110  154 if (parameter.getParameterType().isAssignableFrom(supportedParameterType)) {
111  22 return true;
112    }
113    }
114  0 return false;
115    }
116   
 
117  22 toggle @Override
118    public Object resolveArgument(MethodParameter methodParameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
119   
120  22 if (methodParameter.getParameterType().isAssignableFrom(Node.class)) {
121  2 RenderingContext renderingContext = Components.getComponent(RenderingContext.class);
122  2 if (hasSubsequentParametersOfType(methodParameter, Node.class)) {
123  1 return renderingContext.getMainContent();
124    }
125  1 Node currentContent = renderingContext.getCurrentContent();
126  1 return currentContent != null ? currentContent : renderingContext.getMainContent();
127    }
128  20 if (methodParameter.getParameterType().isAssignableFrom(Content.class)) {
129  4 AggregationState aggregationState = MgnlContext.getAggregationState();
130  4 if (hasSubsequentParametersOfType(methodParameter, Content.class)) {
131  1 return aggregationState.getMainContent();
132    }
133  3 Content currentContent = aggregationState.getCurrentContent();
134  3 return currentContent != null ? currentContent : aggregationState.getMainContent();
135    }
136  16 if (methodParameter.getParameterType().isAssignableFrom(TemplateDefinition.class)) {
137  1 return Components.getComponent(RenderingContext.class).getRenderableDefinition();
138    }
139  15 if (methodParameter.getParameterType().isAssignableFrom(BlossomTemplateDefinition.class)) {
140  1 return Components.getComponent(RenderingContext.class).getRenderableDefinition();
141    }
142  14 if (methodParameter.getParameterType().isAssignableFrom(AreaDefinition.class)) {
143  1 return Components.getComponent(RenderingContext.class).getRenderableDefinition();
144    }
145  13 if (methodParameter.getParameterType().isAssignableFrom(BlossomAreaDefinition.class)) {
146  1 return Components.getComponent(RenderingContext.class).getRenderableDefinition();
147    }
148  12 if (methodParameter.getParameterType().isAssignableFrom(AggregationState.class)) {
149  1 return MgnlContext.getAggregationState();
150    }
151  11 if (methodParameter.getParameterType().isAssignableFrom(Context.class)) {
152  2 return MgnlContext.getInstance();
153    }
154  9 if (methodParameter.getParameterType().isAssignableFrom(WebContext.class)) {
155  2 return MgnlContext.getWebContext();
156    }
157  7 if (methodParameter.getParameterType().isAssignableFrom(User.class)) {
158  2 return MgnlContext.getUser();
159    }
160  5 if (methodParameter.getParameterType().isAssignableFrom(MgnlUser.class)) {
161  2 return MgnlContext.getUser();
162    }
163  3 if (methodParameter.getParameterType().isAssignableFrom(Channel.class)) {
164  1 return MgnlContext.getAggregationState().getChannel();
165    }
166  2 if (methodParameter.getParameterType().isAssignableFrom(Theme.class)) {
167  1 Site site = siteManager.getCurrentSite();
168  1 if (site == null) {
169  0 return null;
170    }
171  1 return siteFunctions.theme(site);
172    }
173  1 if (methodParameter.getParameterType().isAssignableFrom(Site.class)) {
174  1 return siteManager.getCurrentSite();
175    }
176   
177  0 return null;
178    }
179   
 
180  6 toggle private boolean hasSubsequentParametersOfType(MethodParameter methodParameter, Class<?> clazz) {
181  6 Class<?>[] parameterTypes = methodParameter.getMethod().getParameterTypes();
182  6 for (int i = methodParameter.getParameterIndex() + 1; i < parameterTypes.length; i++) {
183  2 Class<?> parameterType = parameterTypes[i];
184  2 if (parameterType.equals(clazz)) {
185  2 return true;
186    }
187    }
188  4 return false;
189    }
190   
 
191  0 toggle @Override
192    public void afterPropertiesSet() throws Exception {
193  0 if (siteFunctions == null) {
194  0 siteFunctions = Components.getComponent(SiteFunctions.class);
195    }
196  0 if (siteManager == null) {
197  0 siteManager = Components.getComponent(SiteManager.class);
198    }
199    }
200    }
  • Report generated by Atlassian Clover v 4.0.4 on Fri Apr 29 2016 13:26:42 CEST using coverage data from Fri Apr 29 2016 13:24:57 CEST.
  • Clover: Open Source License registered to Magnolia CMS.