Clover icon

Magnolia REST Content Delivery 2.0-rc1

  1. Project Clover database Mon Oct 30 2017 16:36:57 CET
  2. Package info.magnolia.rest.delivery.jcr.v1

File JcrDeliveryEndpoint.java

 

Coverage histogram

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

Code metrics

22
45
6
1
242
154
18
0.4
7.5
6
3

Classes

Class Line # Actions
JcrDeliveryEndpoint 86 45 0% 18 4
0.9452054594.5%
 

Contributing tests

This file is covered by 26 tests. .

Source view

1    /**
2    * This file Copyright (c) 2017 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.rest.delivery.jcr.v1;
35   
36    import info.magnolia.cms.security.JCRSessionOp;
37    import info.magnolia.cms.util.PathUtil;
38    import info.magnolia.context.Context;
39    import info.magnolia.context.MgnlContext;
40    import info.magnolia.jcr.util.NodeUtil;
41    import info.magnolia.rest.AbstractEndpoint;
42    import info.magnolia.rest.delivery.jcr.NodesResult;
43    import info.magnolia.rest.delivery.jcr.QueryBuilder;
44    import info.magnolia.rest.delivery.jcr.filter.FilteringContentDecoratorBuilder;
45   
46    import java.util.Arrays;
47    import java.util.Collections;
48    import java.util.List;
49    import java.util.Map;
50    import java.util.stream.Collectors;
51   
52    import javax.inject.Inject;
53    import javax.inject.Provider;
54    import javax.jcr.Node;
55    import javax.jcr.NodeIterator;
56    import javax.jcr.RepositoryException;
57    import javax.jcr.Session;
58    import javax.jcr.Workspace;
59    import javax.jcr.query.Query;
60    import javax.jcr.query.QueryResult;
61    import javax.ws.rs.DefaultValue;
62    import javax.ws.rs.GET;
63    import javax.ws.rs.NotFoundException;
64    import javax.ws.rs.Path;
65    import javax.ws.rs.PathParam;
66    import javax.ws.rs.Produces;
67    import javax.ws.rs.QueryParam;
68    import javax.ws.rs.core.MediaType;
69    import javax.ws.rs.core.UriInfo;
70   
71    import org.apache.commons.lang3.StringUtils;
72   
73    /**
74    * The JCR Delivery endpoint serves JCR content in a concise JSON format.<br/>
75    * Content may be pages, components, stories or anything else that is stored in a workspace.
76    *
77    * <p>It offers two methods for consuming content:</p>
78    * <ul>
79    * <li>Reading a single node, by passing a specific node path</li>
80    * <li>Querying for nodes; passing query parameters to leverage pagination, sorting, full-text search, or filters</li>
81    * </ul>
82    * <p>The endpoint behavior can be configured with a {@link JcrDeliveryEndpointDefinition} to match specific workspaces or node types.
83    * Nodes are represented in the JSON output as plain object-graph, resembling the tree-structure of JCR nodes and properties.</p>
84    */
85    @Path("/delivery/{endpointPrefix}/v1")
 
86    public class JcrDeliveryEndpoint extends AbstractEndpoint<JcrDeliveryEndpointDefinition> {
87   
88    private static final String ENDPOINT_PARAM = "endpointPrefix";
89   
90    private static final String PATH_PARAM = "path";
91    private static final String NODE_TYPES_PARAM = "nodeTypes";
92    private static final String KEYWORD_PARAM = "q";
93    private static final String ORDER_BY_PARAM = "orderBy";
94    private static final String OFFSET_PARAM = "offset";
95    private static final String LIMIT_PARAM = "limit";
96   
97    private static final List<String> ENDPOINT_PARAMETERS = Collections.unmodifiableList(Arrays.asList(
98    NODE_TYPES_PARAM,
99    KEYWORD_PARAM,
100    ORDER_BY_PARAM,
101    OFFSET_PARAM,
102    LIMIT_PARAM
103    ));
104   
105    private final Map<String, WorkspaceParameters> params;
106    private final Provider<Context> contextProvider;
107   
108    @javax.ws.rs.core.Context
109    private UriInfo uriInfo;
110   
 
111  27 toggle @Inject
112    public JcrDeliveryEndpoint(JcrDeliveryEndpointDefinition endpointDefinition, Provider<Context> contextProvider) {
113  27 super(endpointDefinition);
114  27 this.contextProvider = contextProvider;
115  27 this.params = getEndpointDefinition().getParams();
116    }
117   
118    /**
119    * Returns a node including its properties and child nodes down to a certain depth.
120    */
 
121  14 toggle @GET
122    @Path("/{path:.*}")
123    @Produces({ MediaType.APPLICATION_JSON })
124    public Node readNode(
125    @PathParam(ENDPOINT_PARAM) String endpointPrefix,
126    @PathParam(PATH_PARAM) @DefaultValue("/") String path) throws RepositoryException {
127   
128  14 WorkspaceParameters param = params.get(endpointPrefix);
129   
130  14 if (param != null) {
131  13 String workspace = param.getWorkspace();
132  13 if (param.getWorkspace() == null) {
133    // if endpoint prefix is the same as the target workspace, don't need both
134  11 workspace = endpointPrefix;
135    }
136   
137  13 return doSessionOperation(workspace, param.isBypassWorkspaceAcls(), new JCRSessionOp<Node>(workspace) {
 
138  13 toggle @Override
139    public Node exec(Session session) throws RepositoryException {
140  13 String nodePath = PathUtil.createPath(param.getRootPath(), path);
141  13 Node node = session.getNode(nodePath);
142   
143  12 if (param.getNodeTypes() != null && !param.getNodeTypes().isEmpty()) {
144  12 boolean matchingNodeType = false;
145  12 for (String nodeType : param.getNodeTypes()) {
146  12 if (NodeUtil.isNodeType(node, nodeType)) {
147  11 matchingNodeType = true;
148  11 break;
149    }
150    }
151  12 if (!matchingNodeType) {
152  1 throw new NotFoundException(String.format("Node '%s' does not match any configured node type", node));
153    }
154    }
155   
156  11 FilteringContentDecoratorBuilder decorators = new FilteringContentDecoratorBuilder()
157    .childNodeTypes(param.getChildNodeTypes())
158    .depth(param.getDepth())
159    .includeSystemProperties(param.isIncludeSystemProperties())
160    .references(param.getReferences());
161   
162  11 node = decorators.wrapNode(node);
163   
164  11 return node;
165    }
166    });
167    }
168   
169  1 throw new NotFoundException(String.format("No workspace-params entry for endpoint prefix '%s'", endpointPrefix));
170    }
171   
172    /**
173    * Returns a list of nodes.
174    */
 
175  13 toggle @GET
176    @Produces({ MediaType.APPLICATION_JSON })
177    public NodesResult queryNodes(@PathParam(ENDPOINT_PARAM) String endpointPrefix,
178    @QueryParam(KEYWORD_PARAM) String keyword,
179    @QueryParam(ORDER_BY_PARAM) String orderByParam,
180    @QueryParam(OFFSET_PARAM) Long offsetParam,
181    @QueryParam(LIMIT_PARAM) Long limitParam) throws RepositoryException {
182   
183  13 WorkspaceParameters param = params.get(endpointPrefix);
184   
185  13 if (param != null) {
186  12 String workspace = param.getWorkspace();
187  12 if (param.getWorkspace() == null) {
188    // if endpoint prefix is the same as the target workspace, don't need both
189  12 workspace = endpointPrefix;
190    }
191   
192  12 long offset = offsetParam == null ? 0 : offsetParam;
193  12 long limit = limitParam == null ? param.getLimit() : limitParam;
194  12 List<String> propertiesToOrderBy = StringUtils.isEmpty(orderByParam) ? Arrays.asList("@name asc") : Arrays.asList(StringUtils.split(orderByParam, ","));
195  12 Map<String, List<String>> filteringConditions = uriInfo.getQueryParameters().entrySet().stream()
196    .filter(entry -> !ENDPOINT_PARAMETERS.contains(entry.getKey()) && !entry.getValue().isEmpty())
197    .collect(Collectors.toMap(Map.Entry::getKey, entry -> entry.getValue()));
198   
199  12 NodeIterator results = doSessionOperation(workspace, param.isBypassWorkspaceAcls(), new JCRSessionOp<NodeIterator>(workspace) {
 
200  12 toggle @Override
201    public NodeIterator exec(Session session) throws RepositoryException {
202  12 Workspace workspaceObj = session.getWorkspace();
203   
204  12 Query query = QueryBuilder.inWorkspace(workspaceObj)
205    .rootPath(param.getRootPath())
206    .nodeTypes(param.getNodeTypes())
207    .keyword(keyword)
208    .conditions(filteringConditions)
209    .orderBy(propertiesToOrderBy)
210    .offset(offset)
211    .limit(limit)
212    .build();
213   
214  12 QueryResult result = query.execute();
215  12 NodeIterator nodeIterator = result.getNodes();
216   
217  12 FilteringContentDecoratorBuilder decorators = new FilteringContentDecoratorBuilder()
218    .childNodeTypes(param.getChildNodeTypes())
219    .depth(param.getDepth())
220    .includeSystemProperties(param.isIncludeSystemProperties())
221    .references(param.getReferences());
222   
223  12 nodeIterator = decorators.wrapNodeIterator(nodeIterator);
224   
225  12 return nodeIterator;
226    }
227    });
228    //TODO total number of entries in result will be set later.
229  12 return new NodesResult(results, 0);
230    }
231   
232  1 throw new NotFoundException(String.format("No workspace-params entry for endpoint prefix '%s'", endpointPrefix));
233    }
234   
 
235  25 toggle protected <R> R doSessionOperation(String workspace, boolean bypassWorkspaceAcls, JCRSessionOp<R> operation) throws RepositoryException {
236  25 if (bypassWorkspaceAcls) {
237  2 return MgnlContext.doInSystemContext(operation);
238    }
239   
240  23 return operation.exec(contextProvider.get().getJCRSession(workspace));
241    }
242    }
  • Report generated by Atlassian Clover v 4.0.4 on Mon Oct 30 2017 16:39:00 CET using coverage data from Mon Oct 30 2017 16:37:17 CET.
  • Clover: Open Source License registered to Magnolia CMS.