Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
JcrDeliveryEndpointDefinition	45	0	-	0	0	-1.0 -	Show methods

Class JcrDeliveryEndpointDefinition

Class JcrDeliveryEndpointDefinition	Line # 45	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		/**
2		* This file Copyright (c) 2017-2018 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.v2;
35
36		import info.magnolia.rest.EndpointDefinition;
37		import info.magnolia.rest.reference.ReferenceDefinition;
38
39		import java.util.List;
40
41		/**
42		* The {@link JcrDeliveryEndpointDefinition} configures the behavior of the {@link JcrDeliveryEndpoint}
43		* to serve content from specific workspaces or node types.
44		*/
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
45		public interface JcrDeliveryEndpointDefinition extends EndpointDefinition {
46
47		/**
48		* Defines the target workspace to serve content from.
49		*
50		* @return a workspace name;
51		*/
52		String getWorkspace();
53
54		/**
55		* Defines the root path used to resolve the given node path parameter, and to execute queries.
56		*/
57		String getRootPath();
58
59		List<String> getNodeTypes();
60
61		List<String> getChildNodeTypes();
62
63		/**
64		* Defines the depth for child-nodes to be included in the responses.
65		*
66		* @return the depth, relative to result nodes; by default, child-nodes are not included.
67		*/
68		int getDepth();
69
70		/**
71		* Defines the amount of results to return in a paginated result set.
72		*
73		* @return 10 by default
74		*/
75		long getLimit();
76
77		/**
78		* Defines whether jcr:—and mgnl:-prefixed properties will be included in responses.
79		*
80		* @return false by default.
81		*/
82		boolean isIncludeSystemProperties();
83
84		/**
85		* Defines whether or not workspace permissions (ACLs) should be evaluated.
86		*
87		* <p>This may be used to serve all content for the given workspace params to anonymous users;
88		* until relevant JCR permissions for the anonymous user are set up.<br/>
89		* Mind however that URI permissions are still evaluated.
90		* The <em>rest-anonymous</em> role has a GET permission to '/.rest/delivery/*'.
91		*/
92		boolean isBypassWorkspaceAcls();
93
94		List<ReferenceDefinition> getReferences();
95
96		}