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.rest;
35  
36  import info.magnolia.config.source.ConfigurationSourceFactory;
37  import info.magnolia.module.ModuleLifecycle;
38  import info.magnolia.module.ModuleLifecycleContext;
39  import info.magnolia.objectfactory.Components;
40  import info.magnolia.rest.provider.AdditionalProviderDefinition;
41  import info.magnolia.rest.registry.ConfiguredEndpointDefinitionManager;
42  import info.magnolia.rest.registry.EndpointDefinitionRegistry;
43  
44  import java.util.ArrayList;
45  import java.util.List;
46  
47  import javax.inject.Inject;
48  
49  /**
50   * The REST integration module binds JCR and YAML configuration sources to the {@link EndpointDefinitionRegistry},
51   * as well as supports additional resteasy providers.
52   */
53  public class RestIntegrationModule implements ModuleLifecycle {
54  
55      private final ConfigurationSourceFactory cfgSourceFactory;
56      private final EndpointDefinitionRegistry endpointRegistry;
57  
58      private List<AdditionalProviderDefinition> additionalProviders = new ArrayList<>();
59  
60      @Inject
61      public RestIntegrationModule(ConfigurationSourceFactory cfgSourceFactory, EndpointDefinitionRegistry endpointRegistry) {
62          this.endpointRegistry = endpointRegistry;
63          this.cfgSourceFactory = cfgSourceFactory;
64      }
65  
66      /**
67       *  @deprecated since 2.0 use {@link #RestIntegrationModule(ConfigurationSourceFactory, EndpointDefinitionRegistry)} instead.
68       */
69      @Deprecated
70      public RestIntegrationModule(ConfiguredEndpointDefinitionManager configuredEndpointDefinitionManager) {
71          this(Components.getComponent(ConfigurationSourceFactory.class), Components.getComponent(EndpointDefinitionRegistry.class));
72      }
73  
74      @Override
75      public void start(ModuleLifecycleContext ctx) {
76          if (ctx.getPhase() == ModuleLifecycleContext.PHASE_SYSTEM_STARTUP) {
77  
78              // explicitly add former JCR lookup path within modules: bound to be removed eventually
79              cfgSourceFactory.jcr()
80                      .withModulePath("rest-endpoints")
81                      .bindTo(endpointRegistry);
82  
83              // endpoints are now looked up in <module>/restEndpoints (camel-case)
84              cfgSourceFactory.jcr().bindWithDefaults(endpointRegistry);
85              cfgSourceFactory.yaml().bindWithDefaults(endpointRegistry);
86          }
87      }
88  
89      @Override
90      public void stop(ModuleLifecycleContext moduleLifecycleContext) {
91      }
92  
93      public List<AdditionalProviderDefinition> getAdditionalProviders() {
94          return additionalProviders;
95      }
96  
97      public void setAdditionalProviders(List<AdditionalProviderDefinition> additionalProviders) {
98          this.additionalProviders = additionalProviders;
99      }
100 }