1 /**
2 * This file Copyright (c) 2011-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.jcr.decoration;
35
36 import javax.jcr.Node;
37 import javax.jcr.NodeIterator;
38 import javax.jcr.Property;
39 import javax.jcr.PropertyIterator;
40 import javax.jcr.Session;
41 import javax.jcr.Workspace;
42 import javax.jcr.version.Version;
43 import javax.jcr.version.VersionHistory;
44 import javax.jcr.version.VersionIterator;
45 import javax.jcr.version.VersionManager;
46
47 /**
48 * Applies custom behavior in a graph of JCR objects by wrapping objects. Allows for expressing the logic in a single
49 * place.
50 *
51 * @see AbstractContentDecorator
52 */
53 public interface ContentDecorator {
54
55 Session wrapSession(Session session);
56
57 Workspace wrapWorkspace(Workspace workspace);
58
59 Node wrapNode(Node node);
60
61 NodeIterator wrapNodeIterator(NodeIterator nodeIterator);
62
63 /**
64 * Evaluates if a node should be hidden by wrappers.
65 *
66 * @param node the node to evaluate
67 * @return true if the node should be visible or false to hide it
68 */
69 boolean evaluateNode(Node node);
70
71 Property wrapProperty(Property property);
72
73 PropertyIterator wrapPropertyIterator(PropertyIterator propertyIterator);
74
75 /**
76 * Evaluates if a property should be hidden by wrappers.
77 *
78 * @param property the property to evaluate.
79 * @return true if the property should be visible or false to hide it
80 */
81 boolean evaluateProperty(Property property);
82
83 Version wrapVersion(Version version);
84
85 VersionIterator wrapVersionIterator(VersionIterator versionIterator);
86
87 VersionHistory wrapVersionHistory(VersionHistory versionHistory);
88
89 VersionManager wrapVersionManager(VersionManager versionManager);
90
91 /**
92 * Tells if multiple wrapping with this content decorator is enabled.
93 */
94 boolean isMultipleWrapEnabled();
95 }