View Javadoc
1   /**
2    * This file Copyright (c) 2013-2017 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.rest.registry;
35  
36  import static info.magnolia.rest.registry.EndpointDefinitionRegistryEventType.*;
37  
38  import info.magnolia.config.registry.AbstractRegistry;
39  import info.magnolia.config.registry.DefinitionMetadata;
40  import info.magnolia.config.registry.DefinitionMetadataBuilder;
41  import info.magnolia.config.registry.DefinitionProvider;
42  import info.magnolia.config.registry.DefinitionType;
43  import info.magnolia.config.registry.decoration.DefinitionDecorator;
44  import info.magnolia.event.EventBus;
45  import info.magnolia.event.SystemEventBus;
46  import info.magnolia.module.ModuleRegistry;
47  import info.magnolia.objectfactory.Components;
48  import info.magnolia.registry.RegistrationException;
49  import info.magnolia.rest.EndpointDefinition;
50  
51  import java.util.Collection;
52  import java.util.List;
53  import java.util.Optional;
54  import java.util.Set;
55  
56  import javax.inject.Inject;
57  import javax.inject.Named;
58  import javax.inject.Singleton;
59  
60  /**
61   * Registry for {@linkplain EndpointDefinition REST endpoint definitions}.
62   */
63  @Singleton
64  public class EndpointDefinitionRegistry extends AbstractRegistry<EndpointDefinition> {
65      static final DefinitionType TYPE = new DefinitionType() {
66          @Override
67          public String name() {
68              return "restEndpoint";
69          }
70  
71          @Override
72          public Class baseClass() {
73              return EndpointDefinition.class;
74          }
75      };
76  
77      private EventBus systemEventBus;
78  
79      @Inject
80      public EndpointDefinitionRegistry(ModuleRegistry moduleRegistry, @Named(SystemEventBus.NAME) EventBus systemEventBus) {
81          super(moduleRegistry);
82          this.systemEventBus = systemEventBus;
83      }
84  
85      /**
86       * @deprecated since 2.0 use {@link #EndpointDefinitionRegistry(ModuleRegistry, EventBus)} instead.
87       */
88      @Deprecated
89      public EndpointDefinitionRegistry(@Named(SystemEventBus.NAME) EventBus systemEventBus) {
90          this(Components.getComponent(ModuleRegistry.class), systemEventBus);
91      }
92  
93      @Override
94      public DefinitionType type() {
95          return TYPE;
96      }
97  
98      @Override
99      public DefinitionMetadataBuilder newMetadataBuilder() {
100         return DefinitionMetadataBuilder.usingNameAsId();
101     }
102 
103     @Override
104     public void register(DefinitionProvider<EndpointDefinition> provider) {
105         super.register(provider);
106         systemEventBus.fireEvent(new EndpointDefinitionRegistryEvent(REGISTERED, provider));
107     }
108 
109     @Override
110     public Set<DefinitionMetadata> unregisterAndRegister(Collection<DefinitionMetadata> toRemoveIds, Collection<DefinitionProvider<EndpointDefinition>> definitionProviders) {
111         Set<DefinitionMetadata> registeredIds = super.unregisterAndRegister(toRemoveIds, definitionProviders);
112 
113         toRemoveIds.stream()
114                 .filter(metadata -> !registeredIds.contains(metadata))
115                 .map(DefinitionMetadata::getReferenceId)
116                 .forEach(referenceId -> systemEventBus.fireEvent(new EndpointDefinitionRegistryEvent(UNREGISTERED, referenceId)));
117 
118         definitionProviders.stream()
119                 .filter(provider -> toRemoveIds.contains(provider.getMetadata()))
120                 .filter(provider -> registeredIds.contains(provider.getMetadata()))
121                 .forEach(provider -> systemEventBus.fireEvent(new EndpointDefinitionRegistryEvent(REREGISTERED, provider)));
122 
123         definitionProviders.stream()
124                 .filter(provider -> !toRemoveIds.contains(provider.getMetadata()))
125                 .filter(provider -> registeredIds.contains(provider.getMetadata()))
126                 .forEach(provider -> systemEventBus.fireEvent(new EndpointDefinitionRegistryEvent(REGISTERED, provider)));
127 
128         return registeredIds;
129     }
130 
131     @Override
132     public void addDecorator(DefinitionDecorator<EndpointDefinition> decorator) {
133         Optional<DefinitionProvider<EndpointDefinition>> targetProvider = getAllProviders().stream()
134                 .filter(decorator::appliesTo)
135                 .findFirst();
136         super.addDecorator(decorator);
137         targetProvider.ifPresent(provider -> systemEventBus.fireEvent(new EndpointDefinitionRegistryEvent(REREGISTERED, provider)));
138     }
139 
140     @Override
141     public void removeDecorator(DefinitionDecorator<EndpointDefinition> decorator) {
142         Optional<DefinitionProvider<EndpointDefinition>> targetProvider = getAllProviders().stream()
143                 .filter(decorator::appliesTo)
144                 .findFirst();
145         super.removeDecorator(decorator);
146         targetProvider.ifPresent(provider -> systemEventBus.fireEvent(new EndpointDefinitionRegistryEvent(REREGISTERED, provider)));
147     }
148 
149     /**
150      * @deprecated since 2.0 use {@link #getProvider(String)} instead.
151      */
152     @Deprecated
153     public EndpointDefinition getEndpointDefinition(String name) throws RegistrationException {
154         final EndpointDefinition endpointDefinition;
155         try {
156             endpointDefinition = getProvider(name).get();
157         } catch (NoSuchDefinitionException | InvalidDefinitionException e) {
158             throw new RegistrationException(e.getMessage(), e);
159         }
160         return endpointDefinition;
161     }
162 
163     /**
164      * @deprecated since 2.0 use {@link #unregisterAndRegister(Collection, Collection)} instead.
165      */
166     @Deprecated
167     public Set<String> unregisterAndRegister(Set<String> registeredNames, List<EndpointDefinitionProvider> providers) {
168         return null;
169     }
170 
171     /**
172      * @deprecated since 2.0 use standard registry APIs instead ({@link #getProvider(String)} and {@link DefinitionProvider#isValid()}).
173      */
174     @Deprecated
175     public boolean isEndpointDefinitionRegistered(String name) {
176         try {
177             return getProvider(name).isValid();
178         } catch (NoSuchDefinitionException e) {
179             return false;
180         }
181     }
182 
183     /**
184      * @deprecated since 2.0 use {@link #getAllDefinitions()} instead.
185      */
186     @Deprecated
187     public Collection<EndpointDefinition> getAllEndpointDefinitions() {
188         return getAllDefinitions();
189     }
190 }