1 /**
2 * This file Copyright (c) 2015 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.wrapper;
35
36 import info.magnolia.jcr.decoration.AbstractContentDecorator;
37 import info.magnolia.jcr.decoration.ContentDecorator;
38 import info.magnolia.jcr.decoration.ContentDecoratorNodeWrapper;
39 import info.magnolia.jcr.decoration.ContentDecoratorWorkspaceWrapper;
40
41 import javax.jcr.Node;
42 import javax.jcr.Workspace;
43
44 /**
45 * Wrapper that ensures that <b>logical</b> name of the {@link Workspace} will be returned as its name.<br/>
46 * The mgnlSystem and mgnlVersion workspaces are created for each defined repository in the configuration. We need to distinct which
47 * mgnlSystem or mgnlVersion workspace belongs to which repository. For this, we use the following pattern: <repositoryId>-<workspaceName>.<br/>
48 * Example:
49 * Let's assume we have a repository called magnolia, then obtaining the mgnlSystem session looks like:<br/>
50 * <code>
51 * MgnlContext.getJCRSession("magnolia-mgnlSystem");
52 * </code>
53 */
54 public class MgnlLogicalWorkspaceNameMappingWorkspaceDecorator extends AbstractContentDecorator {
55
56 private final String logicalWorkspaceName;
57 private final String physicalWorkspaceName;
58
59 public MgnlLogicalWorkspaceNameMappingWorkspaceDecorator(String logicalWorkspaceName, String physicalWorkspaceName) {
60 this.logicalWorkspaceName = logicalWorkspaceName;
61 this.physicalWorkspaceName = physicalWorkspaceName;
62 }
63
64 @Override
65 public Node wrapNode(Node node) {
66 return new MgnlLogicalWorkspaceNameNodeWrapper(node, this);
67 }
68
69 @Override
70 public Workspace wrapWorkspace(Workspace workspace) {
71 return new MgnlLogicalWorkspaceNameMappingWorkspaceWrapper(workspace, this, logicalWorkspaceName, physicalWorkspaceName);
72 }
73
74 @Override
75 public boolean isMultipleWrapEnabled() {
76 return false;
77 }
78
79 /**
80 * Node wrapper is needed in order to have multiple wrap feature work correctly. Should we not use this wrapper, multiple wrap could cause some unexpected problems (see
81 * {@link info.magnolia.jcr.util.NodeUtil#isWrappedWith(javax.jcr.Node, Class)}, particularly the instance check in the linked method).
82 */
83 public static class MgnlLogicalWorkspaceNameNodeWrapper extends ContentDecoratorNodeWrapper<MgnlLogicalWorkspaceNameMappingWorkspaceDecorator> {
84
85 public MgnlLogicalWorkspaceNameNodeWrapper(Node node, MgnlLogicalWorkspaceNameMappingWorkspaceDecorator contentDecorator) {
86 super(node, contentDecorator);
87 }
88 }
89
90 /**
91 * Wrapper that can return both logical and physical workspace name.
92 */
93 public class MgnlLogicalWorkspaceNameMappingWorkspaceWrapper extends ContentDecoratorWorkspaceWrapper {
94
95 private final String logicalWorkspaceName;
96 private final String physicalWorkspaceName;
97
98 public MgnlLogicalWorkspaceNameMappingWorkspaceWrapper(Workspace workspace, ContentDecorator contentDecorator, String logicalWorkspaceName, String physicalWorkspaceName) {
99 super(workspace, contentDecorator);
100 this.logicalWorkspaceName = logicalWorkspaceName;
101 this.physicalWorkspaceName = physicalWorkspaceName;
102 }
103
104 /**
105 * Returns <b>logical</b> workspace name.
106 */
107 @Override
108 public String getName() {
109 return logicalWorkspaceName;
110 }
111
112 public String getPhysicalWorkspaceName() {
113 return physicalWorkspaceName;
114 }
115 }
116 }