1 /**
2 * This file Copyright (c) 2013-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.mediaeditor.registry;
35
36 import info.magnolia.config.registry.AbstractRegistry;
37 import info.magnolia.config.registry.DefinitionMetadataBuilder;
38 import info.magnolia.config.registry.DefinitionProvider;
39 import info.magnolia.config.registry.DefinitionProviderWrapper;
40 import info.magnolia.config.registry.DefinitionType;
41 import info.magnolia.module.ModuleRegistry;
42 import info.magnolia.objectfactory.Components;
43 import info.magnolia.registry.RegistrationException;
44 import info.magnolia.ui.mediaeditor.definition.MediaEditorDefinition;
45
46 import javax.inject.Inject;
47 import javax.inject.Singleton;
48
49 /**
50 * {@link info.magnolia.config.registry.Registry} implementation for {@link MediaEditorDefinition} types.
51 */
52 @Singleton
53 public class MediaEditorRegistry extends AbstractRegistry<MediaEditorDefinition> {
54 public static final DefinitionType TYPE = new DefinitionType() {
55 @Override
56 public String name() {
57 return "mediaEditor";
58 }
59
60 @Override
61 public Class baseClass() {
62 return MediaEditorDefinition.class;
63 }
64 };
65
66 /**
67 * @deprecated since 5.4.6 - use {@link #MediaEditorRegistry(ModuleRegistry)} instead.
68 */
69 @Deprecated
70 public MediaEditorRegistry() {
71 this(Components.getComponent(ModuleRegistry.class));
72 }
73
74 @Inject
75 public MediaEditorRegistry(ModuleRegistry moduleRegistry) {
76 super(moduleRegistry);
77 }
78
79 /**
80 * @deprecated since 5.4 - use the {@link #getProvider(String)} method instead and fetch definition from the result.
81 */
82 @Deprecated
83 public MediaEditorDefinition get(String mediaEditorId) throws RegistrationException {
84 return getProvider(mediaEditorId).get();
85 }
86
87 @Override
88 public DefinitionType type() {
89 return TYPE;
90 }
91
92 @Override
93 public DefinitionMetadataBuilder newMetadataBuilder() {
94 return DefinitionMetadataBuilder.usingModuleAndRelativePathAsId();
95 }
96
97 @Override
98 protected DefinitionProvider<MediaEditorDefinition> onRegister(final DefinitionProvider<MediaEditorDefinition> provider) {
99 // This was in ConfiguredTemplateDefinitionProvider: templateDefinition.setId(id);
100
101 // TODO -- we should maybe just remove RenderableDefinition.setId() and implement getMetadata() to delegate to provider instead
102 final DefinitionProvider<MediaEditorDefinition> wrappedProvider = super.onRegister(provider);
103 return new DefinitionProviderWrapper<MediaEditorDefinition>(wrappedProvider) {
104 @Override
105 public MediaEditorDefinition get() {
106 final MediaEditorDefinition td = super.get();
107 final String referenceString = wrappedProvider.getMetadata().getReferenceId();
108 td.setId(referenceString);
109 return td;
110 }
111 };
112 }
113 }