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