Clover icon

Magnolia Imaging Module 3.2.3

  1. Project Clover database Fri Nov 6 2015 14:54:03 CET
  2. Package info.magnolia.imaging.parameters

File AbstractWorkspaceAndPathParameterProviderFactory.java

 

Coverage histogram

../../../../img/srcFileCovDistChart10.png
0% of files have more coverage

Code metrics

4
12
1
1
85
34
4
0.33
12
1
4
10.5% of code in this file is excluded from these metrics.

Classes

Class Line # Actions
AbstractWorkspaceAndPathParameterProviderFactory 50 12 10.5% 4 1
0.941176594.1%
 

Contributing tests

This file is covered by 14 tests. .

Source view

1    /**
2    * This file Copyright (c) 2009-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.imaging.parameters;
35   
36    import info.magnolia.cms.core.HierarchyManager;
37    import info.magnolia.context.MgnlContext;
38    import info.magnolia.imaging.ParameterProvider;
39    import info.magnolia.imaging.ParameterProviderFactory;
40    import info.magnolia.imaging.util.PathSplitter;
41   
42    import javax.jcr.RepositoryException;
43    import javax.servlet.http.HttpServletRequest;
44   
45    /**
46    * Superclass for ParameterProviderFactories that are based on Workspace and Path.
47    *
48    * @param <PT> type of ParameterProvider's parameter
49    */
 
50    public abstract class AbstractWorkspaceAndPathParameterProviderFactory<PT> implements ParameterProviderFactory<HttpServletRequest, PT> {
51   
52    private boolean trimExtension = true;
53   
 
54  16 toggle @Override
55    public ParameterProvider<PT> newParameterProviderFor(HttpServletRequest req) {
56  16 String pathInfo = req.getPathInfo();
57  16 if (pathInfo == null) {
58  1 throw new IllegalArgumentException("Can't determine node, no pathInfo is available for uri " + req.getRequestURI());
59    }
60   
61    // TODO - here we assume that the first path element is the ImageGenerator name, which is in fact something that is currently the business of the ImagingServlet.
62    // Can we do better ?
63  15 final PathSplitter pathSplitter = new PathSplitter(pathInfo, trimExtension);
64  15 if (pathSplitter.count() < 2) {
65  1 throw new IllegalArgumentException("Can't determine node from pathInfo: " + pathInfo);
66   
67    }
68  14 final String workspaceName = pathSplitter.skipTo(1);
69  14 final String path = "/" + pathSplitter.remaining();
70   
71  14 try {
72  14 final HierarchyManager hm = MgnlContext.getHierarchyManager(workspaceName);
73  13 return newParameterProviderForPath(hm, path);
74    } catch (RepositoryException e) {
75  0 throw new RuntimeException("Can't load source from " + path + " from workspace " + workspaceName, e); // TODO
76    }
77    }
78   
79    protected abstract ParameterProvider<PT> newParameterProviderForPath(final HierarchyManager hm, final String path) throws RepositoryException;
80   
 
81    toggle public void setTrimExtension(boolean trimExtension) {
82    this.trimExtension = trimExtension;
83    }
84   
85    }