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.rest.EndpointDefinition;
37
38 import java.util.Map;
39
40 /**
41 * The {@link JcrDeliveryEndpointDefinition} configures the behavior of the {@link JcrDeliveryEndpoint}
42 * to serve content from specific workspaces or node types.
43 *
44 * <p>This is essentially a map of endpoint prefixes to target workspaces with various settings.
45 * Do check the available configuration options on {@link WorkspaceParameters}.</p>
46 *
47 * <p>/!\ Mind that, despite allowing config of multiple endpoints in different YAML files and/or JCR config,
48 * <b>there may be only one registration per endpoint class</b> (bound to its annotated <code>@Path</code>).<br/>
49 * This holds true for the {@link JcrDeliveryEndpoint}.</p>
50 *
51 * <p>In case multiple endpoints with same class are configured, it is unspecified which one RESTEasy will pick;
52 * unregistering one may also unregister all of them.</p>
53 */
54 public interface JcrDeliveryEndpointDefinition extends EndpointDefinition {
55
56 /**
57 * Defines the target workspaces and settings to expose, based on endpoint prefixes.<br/>
58 * If no param entry is configured, then no workspace is exposed through the delivery endpoint.
59 */
60 Map<String, WorkspaceParameters> getParams();
61 }