1 /**
2 * This file Copyright (c) 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.reference;
35
36 import java.util.Collections;
37 import java.util.HashMap;
38 import java.util.Map;
39 import java.util.function.Predicate;
40
41 /**
42 * The ReferenceContext carries the reference settings ({@linkplain info.magnolia.rest.reference.ReferenceResolver resolvers}) for the lifespan of the request;
43 * it is stored as a Magnolia context attribute. This helps us use parameters from endpoints' configurations, to achieve dynamic behavior during the Node serialization (see {@link info.magnolia.rest.delivery.jcr.NodeWriter NodeWriter}).
44 * Standard JAX-RS request-context objects do not last until the writing process (MessageBodyWriter).
45 */
46 public class ReferenceContext {
47 private Map<Predicate, ReferenceResolver> resolvers = new HashMap<>();
48
49 private int referenceDepth;
50
51 private boolean referenceRepeat;
52
53 public Map<Predicate, ReferenceResolver> getResolvers() {
54 return Collections.unmodifiableMap(resolvers);
55 }
56
57 public void setResolvers(Map<Predicate, ReferenceResolver> resolvers) {
58 this.resolvers.clear();
59 if (resolvers != null) {
60 this.resolvers.putAll(resolvers);
61 }
62 }
63
64 public int getReferenceDepth() {
65 return referenceDepth;
66 }
67
68 public void setReferenceDepth(int referenceDepth) {
69 this.referenceDepth = referenceDepth;
70 }
71
72 public boolean isReferenceRepeat() {
73 return referenceRepeat;
74 }
75
76 public void setReferenceRepeat(boolean referenceRepeat) {
77 this.referenceRepeat = referenceRepeat;
78 }
79 }