1 /**
2 * This file Copyright (c) 2015-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.ui.contentapp;
35
36 import info.magnolia.context.Context;
37 import info.magnolia.objectfactory.annotation.LazySingleton;
38 import info.magnolia.objectfactory.annotation.LocalScoped;
39 import info.magnolia.objectfactory.annotation.SessionScoped;
40
41 import java.util.Map;
42
43 import javax.inject.Singleton;
44
45 import com.rits.cloning.Cloner;
46
47 /**
48 * Up until Magnolia 5.4, we were using {@link Cloner} directly. To avoid duplicating configuration code everywhere,
49 * we're introducing this wrapper which pre-configures it to work nicely with our definition objects.
50 *
51 * Specifically, it prevents cloning {@link Context}.
52 *
53 * Note: Initially we wanted to avoid cloning all proxy {@link net.sf.cglib.proxy.Callback} fields of definitions, which we
54 * use extensively in the i18n mechanism. But that leads to the cloned object to still delegate method calls to the original
55 * due to proxy specifics.
56 *
57 * @deprecated since 5.4.8 - use {@link info.magnolia.config.MutableWrapper} instead (primarily due to the complications described above).
58 */
59 @Deprecated
60 public class DefinitionCloner extends Cloner {
61
62 public DefinitionCloner() {
63 this.dontCloneInstanceOf(Context.class); //not every context is marked with an annotation, e.g. info.magnolia.context.WebContextFactoryImpl.createWebContext(), so we need to exclude all implementations
64 }
65
66 /**
67 * Doesn't clone classes with {@link Singleton}, {@link LazySingleton}, {@link SessionScoped} or {@link LocalScoped} annotation.
68 */
69 @Override
70 protected <T> T cloneInternal(T o, Map<Object, Object> clones) throws IllegalAccessException {
71 if (o == null) return null;
72 if (o.getClass().getAnnotation(Singleton.class) != null || o.getClass().getAnnotation(LazySingleton.class) != null || o.getClass().getAnnotation(SessionScoped.class) != null || o.getClass().getAnnotation(LocalScoped.class) != null) {
73 return o; //do not clone Magnolia components, this expect annotation to be set on the component and does not cover the cases when annotation on the component is not present.
74 }
75 return super.cloneInternal(o, clones);
76 }
77 }