View Javadoc
1   /**
2    * This file Copyright (c) 2012-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.api.app.registry;
35  
36  import info.magnolia.config.registry.AbstractRegistry;
37  import info.magnolia.config.registry.DefinitionMetadata;
38  import info.magnolia.config.registry.DefinitionMetadataBuilder;
39  import info.magnolia.config.registry.DefinitionProvider;
40  import info.magnolia.config.registry.DefinitionType;
41  import info.magnolia.event.EventBus;
42  import info.magnolia.event.SystemEventBus;
43  import info.magnolia.module.ModuleRegistry;
44  import info.magnolia.objectfactory.Components;
45  import info.magnolia.ui.api.app.AppDescriptor;
46  
47  import java.util.ArrayList;
48  import java.util.Collection;
49  import java.util.Collections;
50  import java.util.List;
51  import java.util.Set;
52  
53  import javax.inject.Inject;
54  import javax.inject.Named;
55  import javax.inject.Singleton;
56  
57  import org.apache.commons.collections4.CollectionUtils;
58  
59  /**
60   * The central registry for {@link AppDescriptor}s. Fires {@link AppRegistryEvent} when the registry changes.
61   *
62   * @see AppDescriptor
63   * @see AppRegistryEvent
64   */
65  @Singleton
66  public class AppDescriptorRegistry extends AbstractRegistry<AppDescriptor> {
67  
68      private EventBus systemEventBus;
69  
70      @Inject
71      public AppDescriptorRegistry(@Named(SystemEventBus.NAME) EventBus systemEventBus, ModuleRegistry moduleRegistry) {
72          super(moduleRegistry);
73          this.systemEventBus = systemEventBus;
74      }
75  
76      /**
77       * @deprecated since 5.4.6 - use {@link #AppDescriptorRegistry(EventBus, ModuleRegistry)}
78       */
79      @Deprecated
80      public AppDescriptorRegistry(@Named(SystemEventBus.NAME) EventBus systemEventBus) {
81          this(systemEventBus, Components.getComponent(ModuleRegistry.class));
82      }
83  
84      @Override
85      public void register(DefinitionProvider<AppDescriptor> provider) {
86          super.register(provider);
87          sendEvent(AppRegistryEventType.REGISTERED, Collections.singleton(provider.getMetadata()));
88      }
89  
90      //TODO implement unregister method properly once it is present in the parent class.
91      public void unregister(String name) {
92          DefinitionProvider<AppDescriptor> toRemove = getProvider(name);
93          getRegistryMap().remove(toRemove.getMetadata());
94          sendEvent(AppRegistryEventType.UNREGISTERED, Collections.singleton(toRemove.getMetadata()));
95      }
96  
97      /**
98       * @deprecated since 5.4 - use {@link AbstractRegistry#getProvider(String)} method instead.
99       */
100     @Deprecated
101     public AppDescriptor getAppDescriptor(String name) {
102         return getProvider(name).get();
103     }
104 
105     /**
106      * @deprecated since 5.4 - use {@link AbstractRegistry#getProvider(String)} method instead.
107      */
108     @Deprecated
109     public boolean isAppDescriptorRegistered(String name) {
110         try {
111             getProvider(name);
112         } catch (NoSuchDefinitionException | IllegalStateException e) {
113             return false;
114         }
115         return true;
116     }
117 
118     @SuppressWarnings("unchecked")
119     @Override
120     public Set<DefinitionMetadata> unregisterAndRegister(Collection<DefinitionMetadata> metaDataToUnregister, Collection<DefinitionProvider<AppDescriptor>> providersToRegister) {
121 
122         Collection<DefinitionMetadata> metadataBefore = getRegistryMap().keySet();
123         Collection<DefinitionProvider<AppDescriptor>> providersBefore = getRegistryMap().values();
124 
125         Set<DefinitionMetadata> registeredMetaData = super.unregisterAndRegister(metaDataToUnregister, providersToRegister);
126 
127         Collection<DefinitionMetadata> metadataAfter = getRegistryMap().keySet();
128 
129         Collection<DefinitionMetadata> added = CollectionUtils.subtract(metadataAfter, metadataBefore);
130         Collection<DefinitionMetadata> removed = CollectionUtils.subtract(metadataBefore, metadataAfter);
131         Collection<DefinitionMetadata> kept = CollectionUtils.subtract(metadataBefore, removed);
132         Collection<DefinitionMetadata> changed = getAppsThatHaveChanged(kept, providersBefore, providersToRegister);
133 
134         sendEvent(AppRegistryEventType.REGISTERED, added);
135         sendEvent(AppRegistryEventType.UNREGISTERED, removed);
136         sendEvent(AppRegistryEventType.REREGISTERED, changed);
137 
138         return registeredMetaData;
139     }
140 
141     @Override
142     public DefinitionType type() {
143         return DefinitionTypes.APP;
144     }
145 
146     @Override
147     public DefinitionMetadataBuilder newMetadataBuilder() {
148         return DefinitionMetadataBuilder.usingNameAsId();
149     }
150 
151     private Collection<DefinitionMetadata> getAppsThatHaveChanged(Collection<DefinitionMetadata> kept, Collection<DefinitionProvider<AppDescriptor>> providersBefore, Collection<DefinitionProvider<AppDescriptor>> providersToRegister) {
152         final List<DefinitionMetadata> changed = new ArrayList<>();
153         for (DefinitionMetadata metadata : kept) {
154             if (!getAppDescriptor(metadata, providersBefore).equals(getAppDescriptor(metadata, providersToRegister))) {
155                 changed.add(metadata);
156             }
157         }
158         return changed;
159     }
160 
161     private AppDescriptor getAppDescriptor(DefinitionMetadata metadata, Collection<DefinitionProvider<AppDescriptor>> providers) {
162         for (DefinitionProvider<AppDescriptor> provider : providers) {
163             if (provider.getMetadata().equals(metadata)) {
164                 return provider.get();
165             }
166         }
167         return null;
168     }
169 
170     /**
171      * Send an event to the system event bus.
172      */
173     private void sendEvent(AppRegistryEventType eventType, Collection<DefinitionMetadata> appDescriptors) {
174         for (DefinitionMetadata appMetadata : appDescriptors) {
175             systemEventBus.fireEvent(new AppRegistryEvent(appMetadata, eventType));
176         }
177     }
178 }